淺談 Spring 框架註解的用法分析

寫在前面：

眾所周知，在JavaEE開發框架中，Spring框架是用的最多的，註解在框架的定位也就越來越明顯了。說句玩笑話：能用一個註解解決的，絕不用一堆配置和程式碼解決；如果不能解決，那麼來兩個註解；（穩住，別噴…）

1.@Component是Spring定義的一個通用註解，可以註解任何bean。

2.@Scope定義bean的作用域，其預設作用域是”singleton”，除此之外還有prototype，request，session和global session。

案例：@Component和@Scope用法分析：

BeanAnnotation類：

@Scope
@Component
public class BeanAnnotation {

    public void say(String arg) {
        System.out.println("BeanAnnotation : " + arg);
    }

    public void myHashCode() {
        System.out.println("BeanAnnotation : " + this.hashCode());
    }

}

junit4測試類→TestBeanAnnotation類：

@RunWith(BlockJUnit4ClassRunner.class)
public class TestBeanAnnotation extends UnitTestBase {

    public TestBeanAnnotation() {
        super("classpath*:spring-beanannotation.xml");
    }

    @Test
    public void testSay() {
        BeanAnnotation bean = super.getBean("beanAnnotation");
        bean.say("This is test.");
    }

    @Test
    public void testScpoe() {
        BeanAnnotation bean = super.getBean("beanAnnotation");
        bean.myHashCode();
        bean = super.getBean("beanAnnotation");
        bean.myHashCode();
    }

}

Spring配置檔案→spring-beanannotation.xml：

<context:component-scan base-package="com.beanannotation"></context:component-scan>

我們先從Spring配置檔案分析，base-package="com.beanannotation"說明我們只處理這個包名下面的註解。

然後分析BeanAnnotation類，有一個say的方法。假設我們不清楚這是一個什麼型別（注：Service或者DAO）的類，我們可以用一個通用的註解@Component。

最後分析TestBeanAnnotation類，testSay方法裡super.getBean("beanAnnotation")是從IOC的容器中取到這個bean，並呼叫bean的say方法。

提出問題的時間到了，當我們super.getBean的時候是通過bean的id從IOC容器中獲取的，那麼這個id是什麼呢？因為在我們新增@Component到BeanAnnotation類上的時候，預設的id為beanAnnotation。如果指定了@Component的名稱，譬如指定為@Component(”bean”)的時候，在單元測試的時候就必須把super.getBean得到的id與之相對應才能測試成功。

在這裡我把@Scope註解單獨分離出來分析，在TestBeanAnnotation類裡面有一個testScpoe方法。在BeanAnnotation類裡面有一個myHashCode方法，可能大家有些疑惑，為什麼要用this.hashCode()？因為@Scope指定的是bean的作用域，為了保證測試類的結果準確明瞭，所以採用雜湊碼值來判斷是否為同一個物件。

3.@Repository、@Service、@Controller是更具有針對性的註解。

PS：這裡我們需要明白這三個註解是基於@Component定義的註解哦：

①、@Repository通常用於註解DAO類，也就是我們常說的持久層。
②、@Service通常用於註解Service類，也就是服務層。
③、@Controller通常用於Controller類，也就是控制層（MVC）。

4.@Autowired理解為“傳統”的setter方法，可以用在setter方法上，也可以用在構造器或者成員變數，能夠進行Spring Bean的自動裝配。

案例：@Autowired用法分析一：

Spring配置檔案→spring-beanannotation.xml：

<context:component-scan base-package="com.beanannotation"></context:component-scan>

SimpleMovieLister類：

public class SimpleMovieLister {

    private MovieFinder movieFinder;

    @Autowired(required=false)
    public void setMovieFinder(MovieFinder movieFinder) {
        this.movieFinder = movieFinder;
    }

}

在預設的情況下，如果找不到合適的bean將會導致autowiring失敗丟擲異常，我們可以將@Autowired註解在這個set方法上，標記required=false來避免。但是，這不是一個必須的，如果找不到movieFinder的例項，是不會丟擲異常的，只有在使用的時候發現movieFinder為null，在這種情況下，就要求我們在使用的時候，首先判斷movieFinder是不是為null，如果是就會報空指標異常 。

值得注意的是，我們知道每個類可以有很多個構造器，但是在使用@Autowired的時候，有且只能有一個構造器能夠被標記為required=true（注：required的預設值為false）。

案例：@Autowired用法分析二：

BeanImplOne類：

@Order
@Component
public class BeanImplOne implements BeanInterface {

}

BeanImplTwo類：

@Order
@Component
public class BeanImplTwo implements BeanInterface {

}

BeanInterface類：

public interface BeanInterface {

}

BeanInvoker類：

@Component
public class BeanInvoker {

    @Autowired
    private List<BeanInterface> list;

    @Autowired
    private Map<String, BeanInterface> map;

    public void say() {
        if (null != list && 0 != list.size()) {
            for (BeanInterface bean : list) {
                System.out.println(bean.getClass().getName());
            }
        } else {
            System.out.println(" list is null !");
        }

        if (null != map && 0 != map.size()) {
            for (Map.Entry<String, BeanInterface> entry : map.entrySet()) {
                System.out.println(entry.getKey() + "      " + entry.getValue().getClass().getName());
            }
        } else {
            System.out.println("map is null !");
        }
    }
}

測試類TestInjection：

@RunWith(BlockJUnit4ClassRunner.class)
public class TestInjection extends UnitTestBase {

    public TestInjection() {
        super("classpath:spring-beanannotation.xml");
    }

    @Test
    public void testMultiBean() {
        BeanInvoker invoker = super.getBean("beanInvoker");
        invoker.say();
    }

}

首先，我們清楚BeanImplOne類和BeanImplTwo類是實現了BeanInterface介面的，在BeanInvoker類裡面我們定義了list和map，我們通過@Autowired註解把BeanImplOne類和BeanImplTwo類註解進入其中。那麼怎麼證實是@Autowired註解把這兩個類注入到list或者map中的呢？那麼請看if迴圈語句和foreach迴圈列印，通過這個邏輯判斷，如果能夠列印出BeanImplOne類和BeanImplTwo類的路徑名，就說明這樣是可以的。如果有些小夥伴可能不信，那麼可以試著不使用@Autowired註解，看結果怎麼樣。

測試類沒有什麼好說的，各位小夥伴有沒有注意到@Order註解呢？這裡需要解釋的就是，如果在@Order註解裡面輸入執行的數字，比如1或者2，那麼列印出來的路徑名就會按順序，也就是說通過指定@Order註解的內容可以實現優先順序的功能。

5.@ImportResource註解引入一個資源，對應一個xml檔案

6.@Value註解從資原始檔中，取出它的key並賦值給當前類的成員變數

案例：@ImportResource和@Value用法分析：

MyDriverManager類：

public class MyDriverManager {

    public MyDriverManager(String url, String userName, String password) {
        System.out.println("url : " + url);
        System.out.println("userName: " + userName);
        System.out.println("password: " + password);
    }

}

config.xml:

<context:property-placeholder location="classpath:/config.properties"/>

StoreConfig類:

@Configuration
@ImportResource("classpath:config.xml")
public class StoreConfig {

    @Value("${jdbc.url}")
    private String url;

    @Value("${jdbc.username}")
    private String username;

    @Value("${jdbc.password}")
    private String password;

    @Bean
    public MyDriverManager myDriverManager() {
        return new MyDriverManager(url, username, password);
    }

這個案例我們使用註解配置jdbc資料庫的連線，首先建立一個內含構造器的MyDriverManager類，然後配置config.xml裡面的資原始檔路徑，以便@ImportResource註解獲取，最後配置StoreConfig類。（注意url、username、password也必須要和資料庫的保持一致哦）

詳解StoreConfig類：首先我們定義三個成員變數，然後給每一個成員變數打上一個@value註解，注意@value裡面的內容一定是資原始檔裡面的key值。這裡的@ImportResource註解就是指明一個資原始檔，在這個資原始檔裡面獲取到對應的資料。那麼@Configuration註解是用來幹嘛的呢？為什麼不用@Component註解呢？其實是這樣的，@Component註解用於將所標註的類載入到 Spring 環境中，這時候是需要配置component-scan才能使用的，而@Configuration註解是Spring 3.X後提供的註解，它用於取代XML來配置 Spring。

7.@Bean註解用來標識配置和初始化一個由SpringIOC容器管理的新物件的方法，類似XML中配置檔案的<bean/>

ps:預設的@Bean註解是單例的，那麼有什麼方式可以指定它的範圍呢？所以這裡才出現了@Scope註解

8.@Scope註解，在@Scope註解裡面value的範圍和Bean的作用域是通用的，proxyMode的屬性是採用哪一種的單例方式（一種是基於介面的註解，一種是基於類的代理）

案例：@Bean和@Scope用法分析：

    @Bean
    @Scope(value ="session",proxyMode = "scopedProxyMode.TARGET_CLASS")
    public UserPreferences userPreferences(){
        return new userPreferences();
    }

    @Bean
    public service userService(){
        UserService service =new SimpleUserService();
        service.setUserPreferences(userPreferences);
        return service;
    }