詳解Java的Spring框架中的註解的用法

時間  2019-11-06
標籤 詳解 java spring 框架 註解 用法 欄目 Java 简体版
原文   原文鏈接

1. 使用Spring註解來注入屬性 java

1.1. 使用註解之前咱們是怎樣注入屬性的
類的實現：web

class UserManagerImpl implements UserManager { 
  private UserDao userDao; 
  public void setUserDao(UserDao userDao) { 
    this.userDao = userDao; 
  } 
  ... 
}

配置文件：正則表達式

<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）
類的實現（對成員變量進行標註）spring

public class UserManagerImpl implements UserManager { 
  @Autowired
  private UserDao userDao; 
  ... 
}

或者（對方法進行標註）express

UserManagerImpl implements UserManager { 
  private UserDao userDao; 
  @Autowired
  public void setUserDao(UserDao userDao) { 
    this.userDao = userDao; 
  } 
  ... 
}

配置文件session

<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這個屬性。mvc

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

class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />

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

@Autowired
public void setUserDao(@Qualifier("userDao") UserDao userDao) { 
  this.userDao = userDao; 
}

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

@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裝配順序

若是同時指定了name和type，則從Spring上下文中找到惟一匹配的bean進行裝配，找不到則拋出異常
若是指定了name，則從上下文中查找名稱（id）匹配的bean進行裝配，找不到則拋出異常
若是指定了type，則從上下文中找到類型匹配的惟一bean進行裝配，找不到或者找到多個，都會拋出異常
若是既沒有指定name，又沒有指定type，則自動按照byName方式進行裝配（見2）；若是沒有匹配，則回退爲一個原始類型（UserDao）進行匹配，若是匹配則自動裝配；
1.6. @PostConstruct（JSR-250）
在方法上加上註解@PostConstruct，這個方法就會在Bean初始化以後被Spring容器執行（注：Bean初始化包括，實例化Bean，並裝配Bean的屬性（依賴注入））。
它的一個典型的應用場景是，當你須要往Bean裏注入一個其父類中定義的屬性，而你又沒法複寫父類的屬性或屬性的setter方法時，如： 

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 />：

<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了：

@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定義註解工做起來

<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表達式過濾一些類

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

<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註解來完成這項工做：

@Scope("session") 
@Component() 
public class UserSessionBean implements Serializable { 
  ... 
}

3.在使用annotation以前定義三個bean之間的關係是這樣的

package com.baobaotao;
public class Office {
  private String officeNo =」001」;
  
  //省略 get/setter
  
  @Override
  public String toString() {
    return "officeNo:" + officeNo;
  }
}
 
ackage com.baobaotao;
  
public class Car {
  private String brand;
  private double price;
  
  // 省略 get/setter
  
  @Override
  public String toString() {
    return "brand:" + brand + "," + "price:" + price;
  }
}
 
package com.baobaotao;
  
public class Boss {
  private Car car;
  private Office office;
  
  // 省略 get/setter
  
  @Override
  public String toString() {
    return "car:" + car + "\n" + "office:" + office;
  }
}

配置文件以下：

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans 
 http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
  <bean id="boss" class="com.baobaotao.Boss">
    <property name="car" ref="car"/>
    <property name="office" ref="office" />
  </bean>
  <bean id="office" class="com.baobaotao.Office">
    <property name="officeNo" value="002"/>
  </bean>
  <bean id="car" class="com.baobaotao.Car" scope="singleton">
    <property name="brand" value=" 紅旗 CA72"/>
    <property name="price" value="2000"/>
  </bean>
</beans>

測試文件以下：

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);
  }
}

 
4.接下來咱們可使用autowired來註解，他能夠對成員變量，方法及構造函數進行標準，完成自動裝配的工做。

autoware來註解成員變量的用法

package com.baobaotao;
import org.springframework.beans.factory.annotation.Autowired;
  
public class Boss {
  
  @Autowired
  private Car car;
  
  @Autowired
  private Office office;
  
  …
}

相應的配置文件以下：

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans 
 http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
  
  <!-- 該 BeanPostProcessor 將自動起做用，對標註 @Autowired 的 Bean 進行自動注入 -->
  <bean class="org.springframework.beans.factory.annotation.
    AutowiredAnnotationBeanPostProcessor"/>
  
  <!-- 移除 boss Bean 的屬性注入配置的信息 -->
  <bean id="boss" class="com.baobaotao.Boss"/>
  
  <bean id="office" class="com.baobaotao.Office">
    <property name="officeNo" value="001"/>
  </bean>
  <bean id="car" class="com.baobaotao.Car" scope="singleton">
    <property name="brand" value=" 紅旗 CA72"/>
    <property name="price" value="2000"/>
  </bean>
</beans>

autoware也能夠用在setter方法及構造函數上

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;
  }
  …
}
 
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 ;
  }
  
  …
}

當候選bean的數目爲0時，咱們可使用@Autowired(required = false)來防止spring找不到bean時報錯。

當有多個候選bean的時候，咱們能夠經過@Qualifier 註釋指定注入 Bean 的名稱。

@Autowired 和 @Qualifier 結合使用時，自動注入的策略就從 byType 轉變成 byName 了。@Autowired 能夠對成員變量、方法以及構造函數進行註釋，而 @Qualifier 的標註對象是成員變量、方法入參、構造函數入參。正是因爲註釋對象的不一樣，因此 Spring 不將 @Autowired 和 @Qualifier 統一成一個註釋類。

5.@resorce是按照名字來進行反射，他有兩個參數，name和type，使用name即按照byname來映射，使用type即按照bytype來進行映射。

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;
}
@postconstructor和preDestory是用來註解類初始化後和銷燬前的方法。 
 
 
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"); 
  }
  …
}

6.@compent能夠直接定義bean，這樣xml配置文件中就不須要配置bean了

package com.baobaotao;
  
import org.springframework.stereotype.Component;
  
@Component
public class Car {
  …
}
 
package com.baobaotao;
  
import org.springframework.stereotype.Component;
  
@Component
public class Office {
  private String officeNo = "001";
  …
}
 
package com.baobaotao;
  
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
  
@Component("boss")
public class Boss {
  @Autowired
  private Car car;
  
  @Autowired
  private Office office;
  …
}

@Component 有一個可選的入參，用於指定 Bean 的名稱，在 Boss 中，咱們就將 Bean 名稱定義爲「boss」。通常狀況下，Bean 都是 singleton 的，須要注入 Bean 的地方僅須要經過 byType 策略就能夠自動注入了，因此大可沒必要指定 Bean 的名稱。

<?xml version="1.0" encoding="UTF-8" ?>
<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.baobaotao"/>
</beans>

7.@scope能夠用來指定其目標

package com.baobaotao;
import org.springframework.context.annotation.Scope;
…
@Scope("prototype")
@Component("boss")
public class Boss {


Spring 2.5 中除了提供 @Component 註釋外，還定義了幾個擁有特殊語義的註釋，它們分別是：@Repository、@Service 和 @Controller。在目前的 Spring 版本中，這 3 個註釋和 @Component 是等效的，可是從註釋類的命名上，很容易看出這 3 個註釋分別和持久層、業務層和控制層（Web 層）相對應。雖然目前這 3 個註釋和 @Component 相比沒有什麼新意，但 Spring 將在之後的版本中爲它們添加特殊的功能。因此，若是 Web 應用程序採用了經典的三層分層結構的話，最好在持久層、業務層和控制層分別採用 @Repository、@Service 和 @Controller 對分層中的類進行註釋，而用 @Component 對那些比較中立的類進行註釋。

您可能感興趣的文章:

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程