Spring註解Annotation

1. 使用Spring註解來注入屬性 
1.1. 使用註解之前咱們是怎樣注入屬性的 
類的實現:java

Java代碼  複製代碼
  1. public class UserManagerImpl implements UserManager {   
  2.     private UserDao userDao;   
  3.     public void setUserDao(UserDao userDao) {   
  4.         this.userDao = userDao;   
  5.     }   
  6.     ...   
  7. }  
public class UserManagerImpl implements UserManager {
	private UserDao userDao;
	public void setUserDao(UserDao userDao) {
		this.userDao = userDao;
	}
	...
}


配置文件:web

Java代碼  複製代碼
  1. <bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl">   
  2.     <property name="userDao" ref="userDao" />   
  3. </bean>   
  4. <bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl">   
  5.     <property name="sessionFactory" ref="mySessionFactory" />   
  6. </bean>  
<bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl">
	<property name="userDao" ref="userDao" />
</bean>
<bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl">
	<property name="sessionFactory" ref="mySessionFactory" />
</bean>



1.2. 引入@Autowired註解(不推薦使用,建議使用@Resource) 
類的實現(對成員變量進行標註)正則表達式

Java代碼  複製代碼
  1. public class UserManagerImpl implements UserManager {   
  2.     @Autowired  
  3.     private UserDao userDao;   
  4.     ...   
  5. }  
public class UserManagerImpl implements UserManager {
	@Autowired
	private UserDao userDao;
	...
}


或者(對方法進行標註)spring

Java代碼  複製代碼
  1. public class UserManagerImpl implements UserManager {   
  2.     private UserDao userDao;   
  3.     @Autowired  
  4.     public void setUserDao(UserDao userDao) {   
  5.         this.userDao = userDao;   
  6.     }   
  7.     ...   
  8. }  
public class UserManagerImpl implements UserManager {
	private UserDao userDao;
	@Autowired
	public void setUserDao(UserDao userDao) {
		this.userDao = userDao;
	}
	...
}


配置文件express

Java代碼  複製代碼
  1. <bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl" />   
  2. <bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl">   
  3.     <property name="sessionFactory" ref="mySessionFactory" />   
  4. </bean>  
<bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl" />
<bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl">
	<property name="sessionFactory" ref="mySessionFactory" />
</bean>


@Autowired能夠對成員變量、方法和構造函數進行標註,來完成自動裝配的工做。以上兩種不一樣實現方式中,@Autowired的標註位置不一樣,它們都會在Spring在初始化userManagerImpl這個bean時,自動裝配userDao這個屬性,區別是:第一種實現中,Spring會直接將UserDao類型的惟一一個bean賦值給userDao這個成員變量;第二種實現中,Spring會調用setUserDao方法來將UserDao類型的惟一一個bean裝配到userDao這個屬性。 

1.3. 讓@Autowired工做起來 
要使@Autowired可以工做,還須要在配置文件中加入如下代碼session

Java代碼  複製代碼
  1. <bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />  
<bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />



1.4. @Qualifier 
@Autowired是根據類型進行自動裝配的。在上面的例子中,若是當Spring上下文中存在不止一個UserDao類型的bean時,就會拋出BeanCreationException異常;若是Spring上下文中不存在UserDao類型的bean,也會拋出BeanCreationException異常。咱們可使用@Qualifier配合@Autowired來解決這些問題。 
1. 可能存在多個UserDao實例函數

Java代碼  複製代碼
  1. @Autowired  
  2. public void setUserDao(@Qualifier("userDao") UserDao userDao) {   
  3.     this.userDao = userDao;   
  4. }  
	@Autowired
	public void setUserDao(@Qualifier("userDao") UserDao userDao) {
		this.userDao = userDao;
	}


這樣,Spring會找到id爲userDao的bean進行裝配。 
2. 可能不存在UserDao實例ui

Java代碼  複製代碼
  1. @Autowired(required = false)   
  2. public void setUserDao(UserDao userDao) {   
  3.     this.userDao = userDao;   
  4. }  
	@Autowired(required = false)
	public void setUserDao(UserDao userDao) {
		this.userDao = userDao;
	}



1.5. @Resource(JSR-250標準註解,推薦使用它來代替Spring專有的@Autowired註解) 
Spring 不但支持本身定義的@Autowired註解,還支持幾個由JSR-250規範定義的註解,它們分別是@Resource、@PostConstruct以及@PreDestroy。 
@Resource的做用至關於@Autowired,只不過@Autowired按byType自動注入,而@Resource默認按byName自動注入罷了。@Resource有兩個屬性是比較重要的,分別是name和type,Spring將@Resource註解的name屬性解析爲bean的名字,而type屬性則解析爲bean的類型。因此若是使用name屬性,則使用byName的自動注入策略,而使用type屬性時則使用byType自動注入策略。若是既不指定name也不指定type屬性,這時將經過反射機制使用byName自動注入策略。 
@Resource裝配順序this

  1. 若是同時指定了name和type,則從Spring上下文中找到惟一匹配的bean進行裝配,找不到則拋出異常
  2. 若是指定了name,則從上下文中查找名稱(id)匹配的bean進行裝配,找不到則拋出異常
  3. 若是指定了type,則從上下文中找到類型匹配的惟一bean進行裝配,找不到或者找到多個,都會拋出異常
  4. 若是既沒有指定name,又沒有指定type,則自動按照byName方式進行裝配(見2);若是沒有匹配,則回退爲一個原始類型(UserDao)進行匹配,若是匹配則自動裝配;



1.6. @PostConstruct(JSR-250) 
在方法上加上註解@PostConstruct,這個方法就會在Bean初始化以後被Spring容器執行(注:Bean初始化包括,實例化Bean,並裝配Bean的屬性(依賴注入))。 
它的一個典型的應用場景是,當你須要往Bean裏注入一個其父類中定義的屬性,而你又沒法複寫父類的屬性或屬性的setter方法時,如:spa

Java代碼  複製代碼
  1. public class UserDaoImpl extends HibernateDaoSupport implements UserDao {   
  2.     private SessionFactory mySessionFacotry;   
  3.     @Resource  
  4.     public void setMySessionFacotry(SessionFactory sessionFacotry) {   
  5.         this.mySessionFacotry = sessionFacotry;   
  6.     }   
  7.     @PostConstruct  
  8.     public void injectSessionFactory() {   
  9.         super.setSessionFactory(mySessionFacotry);   
  10.     }   
  11.     ...   
  12. }  
public class UserDaoImpl extends HibernateDaoSupport implements UserDao {
	private SessionFactory mySessionFacotry;
	@Resource
	public void setMySessionFacotry(SessionFactory sessionFacotry) {
		this.mySessionFacotry = sessionFacotry;
	}
	@PostConstruct
	public void injectSessionFactory() {
		super.setSessionFactory(mySessionFacotry);
	}
	...
}


這裏經過@PostConstruct,爲UserDaoImpl的父類裏定義的一個sessionFactory私有屬性,注入了咱們本身定義的sessionFactory(父類的setSessionFactory方法爲final,不可複寫),以後咱們就能夠經過調用super.getSessionFactory()來訪問該屬性了。 

1.7. @PreDestroy(JSR-250) 
在方法上加上註解@PreDestroy,這個方法就會在Bean初始化以後被Spring容器執行。因爲咱們當前尚未須要用到它的場景,這裏不不去演示。其用法同@PostConstruct。 

1.8. 使用<context:annotation-config />簡化配置 
Spring2.1添加了一個新的context的Schema命名空間,該命名空間對註釋驅動、屬性文件引入、加載期織入等功能提供了便捷的配置。咱們知道註釋自己是不會作任何事情的,它僅提供元數據信息。要使元數據信息真正起做用,必須讓負責處理這些元數據的處理器工做起來。 
AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是處理這些註釋元數據的處理器。可是直接在Spring配置文件中定義這些Bean顯得比較笨拙。Spring爲咱們提供了一種方便的註冊這些BeanPostProcessor的方式,這就是<context:annotation-config />:

Java代碼  複製代碼
  1. <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  
  2.     xsi:schemaLocation="http://www.springframework.org/schema/beans   
  3.     http://www.springframework.org/schema/beans/spring-beans-2.5.xsd   
  4.     http://www.springframework.org/schema/context   
  5.     http://www.springframework.org/schema/context/spring-context-2.5.xsd">   
  6.     <context:annotation-config />   
  7. </beans>  
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context-2.5.xsd">
	<context:annotation-config />
</beans>


<context:annotationconfig />將隱式地向Spring容器註冊AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor、 PersistenceAnnotationBeanPostProcessor以及RequiredAnnotationBeanPostProcessor這4個BeanPostProcessor。 

2. 使用Spring註解完成Bean的定義 
以上咱們介紹了經過@Autowired或@Resource來實如今Bean中自動注入的功能,下面咱們將介紹如何註解Bean,從而從XML配置文件中徹底移除Bean定義的配置。 

2.1. @Component(不推薦使用)、@Repository、@Service、@Controller 
只須要在對應的類上加上一個@Component註解,就將該類定義爲一個Bean了:

Java代碼  複製代碼
  1. @Component  
  2. public class UserDaoImpl extends HibernateDaoSupport implements UserDao {   
  3.     ...   
  4. }  
@Component
public class UserDaoImpl extends HibernateDaoSupport implements UserDao {
	...
}


使用@Component註解定義的Bean,默認的名稱(id)是小寫開頭的非限定類名。如這裏定義的Bean名稱就是userDaoImpl。你也能夠指定Bean的名稱: 
@Component("userDao") 
@Component是全部受Spring管理組件的通用形式,Spring還提供了更加細化的註解形式:@Repository、@Service、@Controller,它們分別對應存儲層Bean,業務層Bean,和展現層Bean。目前版本(2.5)中,這些註解與@Component的語義是同樣的,徹底通用,在Spring之後的版本中可能會給它們追加更多的語義。因此,咱們推薦使用@Repository、@Service、@Controller來替代@Component。 

2.2. 使用<context:component-scan />讓Bean定義註解工做起來

Java代碼  複製代碼
  1. <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  
  2.     xsi:schemaLocation="http://www.springframework.org/schema/beans   
  3.     http://www.springframework.org/schema/beans/spring-beans-2.5.xsd   
  4.     http://www.springframework.org/schema/context   
  5.     http://www.springframework.org/schema/context/spring-context-2.5.xsd">   
  6.     <context:component-scan base-package="com.kedacom.ksoa" />   
  7. </beans>  
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context-2.5.xsd">
	<context:component-scan base-package="com.kedacom.ksoa" />
</beans>


這裏,全部經過<bean>元素定義Bean的配置內容已經被移除,僅須要添加一行<context:component-scan />配置就解決全部問題了——Spring XML配置文件獲得了極致的簡化(固然配置元數據仍是須要的,只不過以註釋形式存在罷了)。<context:component-scan />的base-package屬性指定了須要掃描的類包,類包及其遞歸子包中全部的類都會被處理。 
<context:component-scan />還容許定義過濾器將基包下的某些類歸入或排除。Spring支持如下4種類型的過濾方式:

  • 過濾器類型 表達式範例 說明
  • 註解 org.example.SomeAnnotation 將全部使用SomeAnnotation註解的類過濾出來
  • 類名指定 org.example.SomeClass 過濾指定的類
  • 正則表達式 com\.kedacom\.spring\.annotation\.web\..* 經過正則表達式過濾一些類
  • AspectJ表達式 org.example..*Service+ 經過AspectJ表達式過濾一些類


以正則表達式爲例,我列舉一個應用實例:

Java代碼  複製代碼
  1. <context:component-scan base-package="com.casheen.spring.annotation">   
  2.     <context:exclude-filter type="regex" expression="com\.casheen\.spring\.annotation\.web\..*" />   
  3. </context:component-scan>  
	<context:component-scan base-package="com.casheen.spring.annotation">
		<context:exclude-filter type="regex" expression="com\.casheen\.spring\.annotation\.web\..*" />
	</context:component-scan>


值得注意的是<context:component-scan />配置項不但啓用了對類包進行掃描以實施註釋驅動Bean定義的功能,同時還啓用了註釋驅動自動注入的功能(即還隱式地在內部註冊了AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor),所以當使用<context:component-scan />後,就能夠將<context:annotation-config />移除了。 

2.3. 使用@Scope來定義Bean的做用範圍 
在使用XML定義Bean時,咱們可能還須要經過bean的scope屬性來定義一個Bean的做用範圍,咱們一樣能夠經過@Scope註解來完成這項工做:

Java代碼  複製代碼
  1. @Scope("session")   
  2. @Component()   
  3. public class UserSessionBean implements Serializable {   
  4.     ...   
  5. }  
@Scope("session")
@Component()
public class UserSessionBean implements Serializable {
	...
}
相關文章
相關標籤/搜索