Spring注解詳解

概述

注釋配置相對于 XML 配置具有很多的優勢：

• 它可以充分利用 Java 的反射機制獲取類結構信息，這些信息可以有效減少配置的工作。如使用 JPA 注釋配置 ORM 映射時，我們就不需要指定 PO 的屬性名、類型等信息，如果關系表字段和 PO 屬性名、類型都一致，您甚至無需編寫任務屬性映射信息——因為這些信息都可以通過 Java 反射機制獲取。
• 注釋和 Java 代碼位于一個文件中，而 XML 配置采用獨立的配置文件，大多數配置信息在程序開發完成后都不會調整，如果配置信息和 Java 代碼放在一起，有助于增強程序的內聚性。而采用獨立的 XML 配置文件，程序員在編寫一個功能時，往往需要在程序文件和配置文件中不停切換，這種思維上的不連貫會降低開發效率。

因此在很多情況下，注釋配置比 XML 配置更受歡迎，注釋配置有進一步流行的趨勢。Spring 2.5 的一大增強就是引入了很多注釋類，現在您已經可以使用注釋配置完成大部分 XML 配置的功能。在這篇文章里，我們將向您講述使用注釋進行 Bean 定義和依賴注入的內容。

原來我們是怎么做的

在使用注釋配置之前，先來回顧一下傳統上是如何配置 Bean 并完成 Bean 之間依賴關系的建立。下面是 3 個類，它們分別是 Office、Car 和 Boss，這 3 個類需要在 Spring 容器中配置為 Bean：

Office 僅有一個屬性：

                
package com.baobaotao;
public class Office {
    private String officeNo =”001”;

    //省略 get/setter

    @Override
    public String toString() {
        return "officeNo:" + officeNo;
    }
}

Car 擁有兩個屬性：

                
package com.baobaotao;

public class Car {
    private String brand;
    private double price;

    // 省略 get/setter

    @Override
    public String toString() {
        return "brand:" + brand + "," + "price:" + price;
    }
}

Boss 擁有 Office 和 Car 類型的兩個屬性：

                
package com.baobaotao;

public class Boss {
    private Car car;
    private Office office;

    // 省略 get/setter

    @Override
    public String toString() {
        return "car:" + car + "\n" + "office:" + office;
    }
}

我們在 Spring 容器中將 Office 和 Car 聲明為 Bean，并注入到 Boss Bean 中：下面是使用傳統 XML 完成這個工作的配置文件 beans.xml：

當我們運行以下代碼時，控制臺將正確打出 boss 的信息：

                
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class AnnoIoCTest {

    public static void main(String[] args) {
        String[] locations = {"beans.xml"};
        ApplicationContext ctx = 
		    new ClassPathXmlApplicationContext(locations);
        Boss boss = (Boss) ctx.getBean("boss");
        System.out.println(boss);
    }
}

這說明 Spring 容器已經正確完成了 Bean 創建和裝配的工作。

使用 @Autowired 注釋

Spring 2.5 引入了 @Autowired 注釋，它可以對類成員變量、方法及構造函數進行標注，完成自動裝配的工作。來看一下使用@Autowired 進行成員變量自動注入的代碼：

                
package com.baobaotao;
import org.springframework.beans.factory.annotation.Autowired;

public class Boss {

    @Autowired
    private Car car;

    @Autowired
    private Office office;

    …
}

Spring 通過一個 BeanPostProcessor 對 @Autowired 進行解析，所以要讓@Autowired 起作用必須事先在 Spring 容器中聲明 AutowiredAnnotationBeanPostProcessor Bean。

這樣，當 Spring 容器啟動時，AutowiredAnnotationBeanPostProcessor 將掃描 Spring 容器中所有 Bean，當發現 Bean 中擁有@Autowired 注釋時就找到和其匹配（默認按類型匹配）的 Bean，并注入到對應的地方中去。

按照上面的配置，Spring 將直接采用 Java 反射機制對 Boss 中的 car 和 office 這兩個私有成員變量進行自動注入。所以對成員變量使用@Autowired 后，您大可將它們的 setter 方法（setCar() 和 setOffice()）從 Boss 中刪除。

當然，您也可以通過 @Autowired 對方法或構造函數進行標注，來看下面的代碼：

                
package com.baobaotao;

public class Boss {
    private Car car;
    private Office office;

     @Autowired
    public void setCar(Car car) {
        this.car = car;
    }
 
    @Autowired
    public void setOffice(Office office) {
        this.office = office;
    }
    …
}

這時，@Autowired 將查找被標注的方法的入參類型的 Bean，并調用方法自動注入這些 Bean。而下面的使用方法則對構造函數進行標注：

                
package com.baobaotao;

public class Boss {
    private Car car;
    private Office office;
 
    @Autowired
    public Boss(Car car ,Office office){
        this.car = car;
        this.office = office ;
    }
 
    …
}

由于 Boss() 構造函數有兩個入參，分別是 car 和 office，@Autowired 將分別尋找和它們類型匹配的 Bean，將它們作為Boss(Car car ,Office office) 的入參來創建 Boss Bean。

當候選 Bean 數目不為 1 時的應對方法

在默認情況下使用 @Autowired 注釋進行自動注入時，Spring 容器中匹配的候選 Bean 數目必須有且僅有一個。當找不到一個匹配的 Bean 時，Spring 容器將拋出BeanCreationException 異常，并指出必須至少擁有一個匹配的 Bean。我們可以來做一個實驗：

                


 
     

    

    
    <!-- 
    
    -->

    
        
        
    

由于 office Bean 被注釋掉了，所以 Spring 容器中將沒有類型為 Office 的 Bean 了，而 Boss 的office屬性標注了 @Autowired，當啟動 Spring 容器時，異常就產生了。

當不能確定 Spring 容器中一定擁有某個類的 Bean 時，可以在需要自動注入該類 Bean 的地方可以使用 @Autowired(required = false)，這等于告訴 Spring：在找不到匹配 Bean 時也不報錯。來看一下具體的例子：

                
package com.baobaotao;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Required;

public class Boss {

    private Car car;
    private Office office;

    @Autowired
    public void setCar(Car car) {
        this.car = car;
    }
    @Autowired(required = false)
    public void setOffice(Office office) {
        this.office = office;
    }
    …
}

當然，一般情況下，使用 @Autowired 的地方都是需要注入 Bean 的，使用了自動注入而又允許不注入的情況一般僅會在開發期或測試期碰到（如為了快速啟動 Spring 容器，僅引入一些模塊的 Spring 配置文件），所以@Autowired(required = false) 會很少用到。

和找不到一個類型匹配 Bean 相反的一個錯誤是：如果 Spring 容器中擁有多個候選 Bean，Spring 容器在啟動時也會拋出 BeanCreationException 異常。來看下面的例子：

                
… 

    


    

…

我們在 Spring 容器中配置了兩個類型為 Office 類型的 Bean，當對 Boss 的 office 成員變量進行自動注入時，Spring 容器將無法確定到底要用哪一個 Bean，因此異常發生了。

Spring 允許我們通過 @Qualifier 注釋指定注入 Bean 的名稱，這樣歧義就消除了，可以通過下面的方法解決異常：

                
@Autowired
public void setOffice(@Qualifier("office")Office office) {
    this.office = office;
}

@Qualifier("office") 中的 office 是 Bean 的名稱，所以 @Autowired 和@Qualifier 結合使用時，自動注入的策略就從 byType 轉變成 byName 了。@Autowired 可以對成員變量、方法以及構造函數進行注釋，而@Qualifier 的標注對象是成員變量、方法入參、構造函數入參。正是由于注釋對象的不同，所以 Spring 不將 @Autowired 和@Qualifier 統一成一個注釋類。下面是對成員變量和構造函數入參進行注釋的代碼：

對成員變量進行注釋：

                
public class Boss {
    @Autowired
    private Car car;
 
    @Autowired
    @Qualifier("office")
    private Office office;
    …
}

對構造函數入參進行注釋：

                
public class Boss {
    private Car car;
    private Office office;

    @Autowired
    public Boss(Car car , @Qualifier("office")Office office){
        this.car = car;
        this.office = office ;
	}
}

@Qualifier 只能和 @Autowired 結合使用，是對 @Autowired 有益的補充。一般來講，@Qualifier 對方法簽名中入參進行注釋會降低代碼的可讀性，而對成員變量注釋則相對好一些。

使用 JSR-250 的注釋

Spring 不但支持自己定義的 @Autowired 的注釋，還支持幾個由 JSR-250 規范定義的注釋，它們分別是 @Resource、@PostConstruct 以及 @PreDestroy。

@Resource

@Resource 的作用相當于 @Autowired，只不過 @Autowired 按 byType 自動注入，面@Resource 默認按 byName 自動注入罷了。@Resource 有兩個屬性是比較重要的，分別是 name 和 type，Spring 將@Resource注釋的 name 屬性解析為 Bean 的名字，而 type 屬性則解析為 Bean 的類型。所以如果使用 name 屬性，則使用 byName 的自動注入策略，而使用 type 屬性時則使用 byType 自動注入策略。如果既不指定 name 也不指定 type 屬性，這時將通過反射機制使用 byName 自動注入策略。

Resource 注釋類位于 Spring 發布包的 lib/j2ee/common-annotations.jar 類包中，因此在使用之前必須將其加入到項目的類庫中。來看一個使用@Resource 的例子：

                
package com.baobaotao;

import javax.annotation.Resource;

public class Boss {
    // 自動注入類型為 Car 的 Bean
    @Resource
    private Car car;

    // 自動注入 bean 名稱為 office 的 Bean
    @Resource(name = "office")
    private Office office;
}

一般情況下，我們無需使用類似于 @Resource(type=Car.class) 的注釋方式，因為 Bean 的類型信息可以通過 Java 反射從代碼中獲取。

要讓 JSR-250 的注釋生效，除了在 Bean 類中標注這些注釋外，還需要在 Spring 容器中注冊一個負責處理這些注釋的 BeanPostProcessor：

CommonAnnotationBeanPostProcessor 實現了 BeanPostProcessor 接口，它負責掃描使用了 JSR-250 注釋的 Bean，并對它們進行相應的操作。

@PostConstruct 和 @PreDestroy

Spring 容器中的 Bean 是有生命周期的，Spring 允許在 Bean 在初始化完成后以及 Bean 銷毀前執行特定的操作，您既可以通過實現 InitializingBean/DisposableBean 接口來定制初始化之后 / 銷毀之前的操作方法，也可以通過 元素的 init-method/destroy-method 屬性指定初始化之后 / 銷毀之前調用的操作方法。關于 Spring 的生命周期，筆者在《精通 Spring 2.x—企業應用開發精解》第 3 章進行了詳細的描述，有興趣的讀者可以查閱。

JSR-250 為初始化之后/銷毀之前方法的指定定義了兩個注釋類，分別是 @PostConstruct 和 @PreDestroy，這兩個注釋只能應用于方法上。標注了 @PostConstruct 注釋的方法將在類實例化后調用，而標注了 @PreDestroy 的方法將在類銷毀之前調用。

                
package com.baobaotao;

import javax.annotation.Resource;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class Boss {
    @Resource
    private Car car;

    @Resource(name = "office")
    private Office office;

    @PostConstruct
    public void postConstruct1(){
        System.out.println("postConstruct1");
    }

    @PreDestroy
    public void preDestroy1(){
        System.out.println("preDestroy1"); 
    }
    …
}

您只需要在方法前標注 @PostConstruct 或 @PreDestroy，這些方法就會在 Bean 初始化后或銷毀之前被 Spring 容器執行了。

我們知道，不管是通過實現 InitializingBean/DisposableBean 接口，還是通過 元素的init-method/destroy-method 屬性進行配置，都只能為 Bean 指定一個初始化 / 銷毀的方法。但是使用@PostConstruct 和 @PreDestroy 注釋卻可以指定多個初始化 / 銷毀方法，那些被標注 @PostConstruct 或 @PreDestroy 注釋的方法都會在初始化 / 銷毀時被執行。

通過以下的測試代碼，您將可以看到 Bean 的初始化 / 銷毀方法是如何被執行的：

                
package com.baobaotao;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class AnnoIoCTest {

    public static void main(String[] args) {
        String[] locations = {"beans.xml"};
        ClassPathXmlApplicationContext ctx = 
            new ClassPathXmlApplicationContext(locations);
        Boss boss = (Boss) ctx.getBean("boss");
        System.out.println(boss);
        ctx.destroy();// 關閉 Spring 容器，以觸發 Bean 銷毀方法的執行
    }
}

這時，您將看到標注了 @PostConstruct 的 postConstruct1() 方法將在 Spring 容器啟動時，創建BossBean 的時候被觸發執行，而標注了 @PreDestroy 注釋的 preDestroy1() 方法將在 Spring 容器關閉前銷毀Boss Bean 的時候被觸發執行。

使用 簡化配置

Spring 2.1 添加了一個新的 context 的 Schema 命名空間，該命名空間對注釋驅動、屬性文件引入、加載期織入等功能提供了便捷的配置。我們知道注釋本身是不會做任何事情的，它僅提供元數據信息。要使元數據信息真正起作用，必須讓負責處理這些元數據的處理器工作起來。

而我們前面所介紹的 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor 就是處理這些注釋元數據的處理器。但是直接在 Spring 配置文件中定義這些 Bean 顯得比較笨拙。Spring 為我們提供了一種方便的注冊這些BeanPostProcessor 的方式，這就是 。請看下面的配置：