Spring Bean配置方式之三：註解配置

阿新 • • 發佈：2019-01-12

Spring提供通過掃描類路徑中的特殊註解類來自動註冊Bean定義。同註解驅動事務一樣需要開啟自動掃描並註冊Bean定義支援，使用方式如下（resources/chapter12/ componentDefinitionWithAnnotation.xml）：

java程式碼：

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
http://www.springframework.org/schema/context
http:

//www.springframework.org/schema/context/spring-context-3.0.xsd">
<aop:aspectj-autoproxy />
<context:component-scan base-package="cn.javass.spring.chapter12"/>
</beans>

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
       http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-3.0.xsd">

    <aop:aspectj-autoproxy />

    <context:component-scan base-package="cn.javass.spring.chapter12"/>

</beans>

使用<context:component-scan>標籤來表示需要要自動註冊Bean定義，而通過base-package屬性指定掃描的類路徑位置。

<context:component-scan>標籤將自動開啟“註解實現Bean依賴注入”支援。

此處我們還通過<aop:aspectj-autoproxy/>用於開啟Spring對@AspectJ風格切面的支援。

Spring基於註解實現Bean定義支援如下三種註解：

Spring自帶的@Component註解及擴充套件@Repository、@Service、@Controller，如圖12-1所示；
JSR-250 1.1版本中中定義的@ManagedBean註解，是Java EE 6標準規範之一，不包括在JDK中，需要在應用伺服器環境使用（如Jboss），如圖12-2所示；
JSR-330的@Named註解，如圖12-3所示。

圖12-1 Spring自帶的@Component註解及擴充套件

圖12-2 JSR-250中定義的@ManagedBean註解及自定義擴充套件

圖12-3 JSR-330的@Named註解及自定義擴充套件

圖12-2和圖12-3中的自定義擴充套件部分是為了配合Spring自帶的模式註解擴充套件自定義的，並不包含在Java EE 6規範中，在Java EE 6中相應的服務層、DAO層功能由EJB來完成。

在Java EE中有些註解執行放置在多個地方，如@Named允許放置在型別、欄位、方法引數上等，因此一般情況下放置在型別上表示定義，放置在引數、方法等上邊一般代表使用（如依賴注入等等）。

12.3.2 Spring自帶的@Component註解及擴充套件

一、@Component：定義Spring管理Bean，使用方式如下：

java程式碼：

@Component("識別符號")
POJO類

在類上使用@Component註解，表示該類定義為Spring管理Bean，使用預設value（可選）屬性表示Bean識別符號。

1、定義測試Bean類:

java程式碼：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
@Component("component")
publicclass TestCompoment {
@Autowired
private ApplicationContext ctx;
public ApplicationContext getCtx() {
return ctx;
}
}

package cn.javass.spring.chapter12;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
@Component("component")
public class TestCompoment {
    @Autowired
    private ApplicationContext ctx;
    public ApplicationContext getCtx() {
        return ctx;
    }
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試類和測試方法：

java程式碼：

//省略import
publicclass ComponentDefinitionWithAnnotationTest {
privatestatic String configLocation = "classpath:chapter12/componentDefinitionWithAnnotation.xml";
privatestatic ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocation);
@Test
publicvoid testComponent() {
TestCompoment component = ctx.getBean("component", TestCompoment.class);
Assert.assertNotNull(component.getCtx());
}
}

package cn.javass.spring.chapter12;
//省略import
public class ComponentDefinitionWithAnnotationTest {
    private static String configLocation = "classpath:chapter12/componentDefinitionWithAnnotation.xml";
    private static ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocation);
    @Test
    public void testComponent() {
        TestCompoment component = ctx.getBean("component", TestCompoment.class);
        Assert.assertNotNull(component.getCtx());
    }
}

測試成功說明被@Component註解的POJO類將自動被Spring識別並註冊到Spring容器中，且自動支援自動裝配。

@AspectJ風格的切面可以通過@Compenent註解標識其為Spring管理Bean，而@Aspect註解不能被Spring自動識別並註冊為Bean，必須通過@Component註解來完成，示例如下：

java程式碼：

//省略import
@Component
@Aspect
publicclass TestAspect {
@Pointcut(value="execution(* *(..))")
privatevoid pointcut() {}
@Before(value="pointcut()")
publicvoid before() {
System.out.println("=======before");
}
}

package cn.javass.spring.chapter12.aop;
//省略import
@Component
@Aspect
public class TestAspect {
    @Pointcut(value="execution(* *(..))")
    private void pointcut() {}
    @Before(value="pointcut()")
    public void before() {
        System.out.println("=======before");
    }
}

通過@Component將切面定義為Spring管理Bean。

二、@Repository：@Component擴充套件，被@Repository註解的POJO類表示DAO層實現，從而見到該註解就想到DAO層實現，使用方式和@Component相同；

1、定義測試Bean類:

java程式碼：

import org.springframework.stereotype.Repository;
@Repository("testHibernateDao")
publicclass TestHibernateDaoImpl {
}

package cn.javass.spring.chapter12.dao.hibernate;
import org.springframework.stereotype.Repository;
@Repository("testHibernateDao")
public class TestHibernateDaoImpl {
 
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testDao() {
TestHibernateDaoImpl dao =
ctx.getBean("testHibernateDao", TestHibernateDaoImpl.class);
Assert.assertNotNull(dao);
}

@Test
public void testDao() {
TestHibernateDaoImpl dao =
ctx.getBean("testHibernateDao", TestHibernateDaoImpl.class);
Assert.assertNotNull(dao);
}

測試成功說明被@Repository註解的POJO類將自動被Spring識別並註冊到Spring容器中，且自動支援自動裝配，並且被@Repository註解的類表示DAO層實現。

三、@Service：@Component擴充套件，被@Service註解的POJO類表示Service層實現，從而見到該註解就想到Service層實現，使用方式和@Component相同；

1、定義測試Bean類:

java程式碼：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;
import cn.javass.spring.chapter12.dao.hibernate.TestHibernateDaoImpl;
@Service("testService")
publicclass TestServiceImpl {
@Autowired
@Qualifier("testHibernateDao")
private TestHibernateDaoImpl dao;
public TestHibernateDaoImpl getDao() {
return dao;
}
}

package cn.javass.spring.chapter12.service.impl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;
import cn.javass.spring.chapter12.dao.hibernate.TestHibernateDaoImpl;
@Service("testService")
public class TestServiceImpl {
    @Autowired
    @Qualifier("testHibernateDao")
    private TestHibernateDaoImpl dao;
    public TestHibernateDaoImpl getDao() {
        return dao;
    }
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testService() {
TestServiceImpl service = ctx.getBean("testService", TestServiceImpl.class);
Assert.assertNotNull(service.getDao());
}

@Test
public void testService() {
    TestServiceImpl service = ctx.getBean("testService", TestServiceImpl.class);
    Assert.assertNotNull(service.getDao());
}

測試成功說明被@Service註解的POJO類將自動被Spring識別並註冊到Spring容器中，且自動支援自動裝配，並且被@Service註解的類表示Service層實現。

四、@Controller：@Component擴充套件，被@Controller註解的類表示Web層實現，從而見到該註解就想到Web層實現，使用方式和@Component相同；

1、定義測試Bean類:

java程式碼：

//省略import
@Controller
publicclass TestAction {
@Autowired
private TestServiceImpl testService;
publicvoid list() {
//呼叫業務邏輯層方法
}
}

package cn.javass.spring.chapter12.action;
//省略import
@Controller
public class TestAction {
    @Autowired
    private TestServiceImpl testService;
   
    public void list() {
        //呼叫業務邏輯層方法
    }
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testWeb() {
TestAction action = ctx.getBean("testAction", TestAction.class);
Assert.assertNotNull(action);
}

@Test
public void testWeb() {
    TestAction action = ctx.getBean("testAction", TestAction.class);
    Assert.assertNotNull(action);
}

測試成功說明被@Controller註解的類將自動被Spring識別並註冊到Spring容器中，且自動支援自動裝配，並且被@Controller註解的類表示Web層實現。

大家是否注意到@Controller中並沒有定義Bean的識別符號，那麼預設Bean的名字將是以小寫開頭的類名（不包括包名），即如“TestAction”類的Bean識別符號為“testAction”。

六、自定義擴充套件：Spring內建了三種通用的擴充套件註解@Repository、@Service、@Controller ，大多數情況下沒必要定義自己的擴充套件，在此我們演示下如何擴充套件@Component註解來滿足某些特殊規約的需要；

在此我們可能需要一個快取層用於定義快取Bean，因此我們需要自定義一個@Cache的註解來表示快取類。

1、擴充套件@Component：

java程式碼：

//省略import
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public@interface Cache{
String value() default"";
}

package cn.javass.spring.chapter12.stereotype;
//省略import
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Cache{
       String value() default "";
}

擴充套件十分簡單，只需要在擴充套件的註解上註解@Component即可，@Repository、@Service、@Controller也是通過該方式實現的，沒什麼特別之處

2、定義測試Bean類:

java程式碼：

package cn.javass.spring.chapter12.cache;
@Cache("cache")
public class TestCache {
 
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testCache() {
TestCache cache = ctx.getBean("cache", TestCache.class);
Assert.assertNotNull(cache);
}

@Test
public void testCache() {
    TestCache cache = ctx.getBean("cache", TestCache.class);
    Assert.assertNotNull(cache);
}

測試成功說明自定義的@Cache註解也能很好的工作，而且實現了我們的目的，使用@Cache來表示被註解的類是Cache層Bean。

12.3.3 JSR-250中定義的@ManagedBean註解

@javax.annotation.ManagedBean需要在實現Java EE 6規範的應用伺服器上使用，雖然Spring3實現了，但@javax.annotation.ManagedBean只有在Java EE 6環境中才有定義，因此測試前需要我們定義ManagedBean類。

1、定義javax.annotation.ManagedBean註解類：

java程式碼：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public@interface ManagedBean {
String value() default"";
}

package javax.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ManagedBean {
     String value() default "";
}

其和@Component完全相同，唯一不同的就是名字和建立者（一個是Spring，一個是Java EE規範）。

2、定義測試Bean類:

java程式碼：

import javax.annotation.Resource;
import org.springframework.context.ApplicationContext;
@javax.annotation.ManagedBean("managedBean")
publicclass TestManagedBean {
@Resource
private ApplicationContext ctx;
public ApplicationContext getCtx() {
return ctx;
}
}

package cn.javass.spring.chapter12;
import javax.annotation.Resource;
import org.springframework.context.ApplicationContext;
@javax.annotation.ManagedBean("managedBean")
public class TestManagedBean {
    @Resource
    private ApplicationContext ctx;
    public ApplicationContext getCtx() {
        return ctx;
    }
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testManagedBean() {
TestManagedBean testManagedBean = ctx.getBean("managedBean", TestManagedBean.class);
Assert.assertNotNull(testManagedBean.getCtx());
}

@Test
public void testManagedBean() {
    TestManagedBean testManagedBean = ctx.getBean("managedBean", TestManagedBean.class);
    Assert.assertNotNull(testManagedBean.getCtx());
}

測試成功說明被@ManagedBean註解類也能正常工作。

自定義擴充套件就不介紹了，大家可以參考@Component來完成如圖12-2所示的自定義擴充套件部分。

12.3.4 JSR-330的@Named註解

@Named不僅可以用於依賴注入來指定注入的Bean的識別符號，還可以用於定義Bean。即註解在型別上表示定義Bean，註解在非型別上（如欄位）表示指定依賴注入的Bean識別符號。

1、定義測試Bean類:

java程式碼：

//省略import
@Named("namedBean")
publicclass TestNamedBean {
@Inject
private ApplicationContext ctx;
public ApplicationContext getCtx() {
return ctx;
}
}

package cn.javass.spring.chapter12;
//省略import
@Named("namedBean")
public class TestNamedBean {
    @Inject
    private ApplicationContext ctx;
    public ApplicationContext getCtx() {
        return ctx;
    }
}

2、Spring配置檔案使用chapter12/ componentDefinitionWithAnnotation.xml即可且無需修改；

3、定義測試方法：

java程式碼： Java程式碼 @Test

publicvoid testNamedBean() {
TestNamedBean testNamedBean =
ctx.getBean("namedBean", TestNamedBean.class);
Assert.assertNotNull(testNamedBean.getCtx());
}

@Test
public void testNamedBean() {
TestNamedBean testNamedBean =
    ctx.getBean("namedBean", TestNamedBean.class);
    Assert.assertNotNull(testNamedBean.getCtx());
}

測試成功說明被@Named註解類也能正常工作。

自定義擴充套件就不介紹了，大家可以參考@Component來完成如圖12-3所示的自定義擴充套件部分。

12.3.5 細粒度控制Bean定義掃描

在XML配置中完全消除了Bean定義，而是隻有一個<context:component-scan>標籤來支援註解Bean定義掃描。

前邊的示例完全採用預設掃描設定，如果我們有幾個元件不想被掃描並自動註冊、我們想更改預設的Bean識別符號生成策略該如何做呢？接下來讓我們看一下如何細粒度的控制Bean定義掃描，具體定義如下：

java程式碼：

base-package=""
resource-pattern="**/*.class"
name-generator="org.springframework.context.annotation.AnnotationBeanNameGenerator"
use-default-filters="true"
annotation-config="true">
<context:include-filter type="aspectj" expression=""/>
<context:exclude-filter type="regex" expression=""/>
</context:component-scan>

<context:component-scan
        base-package=""
        resource-pattern="**/*.class"
        name-generator="org.springframework.context.annotation.AnnotationBeanNameGenerator"
        use-default-filters="true"
        annotation-config="true">
                <context:include-filter type="aspectj" expression=""/>
                <context:exclude-filter type="regex" expression=""/>
</context:component-scan>

base-package：表示掃描註解類的開始位置，即將在指定的包中掃描，其他包中的註解類將不被掃描，預設將掃描所有類路徑；
resource-pattern：表示掃描註解類的字尾匹配模式，即“base-package+resource-pattern”將組成匹配模式用於匹配類路徑中的元件，預設字尾為“**/*.class”，即指定包下的所有以.class結尾的類檔案；
name-generator：預設情況下的Bean識別符號生成策略，預設是AnnotationBeanNameGenerator，其將生成以小寫開頭的類名（不包括包名）；可以自定義自己的識別符號生成策略；
use-default-filters：預設為true表示過濾@Component、@ManagedBean、@Named註解的類，如果改為false預設將不過濾這些預設的註解來定義Bean，即這些註解類不能被過濾到，即不能通過這些註解進行Bean定義；
annotation-config：表示是否自動支援註解實現Bean依賴注入，預設支援，如果設定為false，將關閉支援註解的依賴注入，需要通過<context:annotation-config/>開啟。

預設情況下將自動過濾@Component、@ManagedBean、@Named註解的類並將其註冊為Spring管理Bean，可以通過在<context:component-scan>標籤中指定自定義過濾器將過濾到匹配條件的類註冊為Spring管理Bean，具體定義方式如下：

java程式碼：

<context:include-filter type="aspectj" expression=""/>
<context:exclude-filter type="regex" expression=""/>

<context:include-filter>：表示過濾到的類將被註冊為Spring管理Bean；
<context:exclude-filter>：表示過濾到的類將不被註冊為Spring管理Bean，它比<context:include-filter>具有更高優先順序；
type：表示過濾器型別，目前支援註解型別、類型別、正則表示式、aspectj表示式過濾器，當然也可以自定義自己的過濾器，實現org.springframework.core.type.filter.TypeFilter即可；
expression：表示過濾器表示式。

一般情況下沒必要進行自定義過濾，如果需要請參考如下示例：

1、cn.javass.spring.chapter12.TestBean14自動註冊為Spring管理Bean：

2、把所有註解為org.aspectj.lang.annotation.Aspect自動註冊為Spring管理Bean：

java程式碼：

<context:include-filter type="annotation"
expression="org.aspectj.lang.annotation.Aspect"/>

3、將把匹配到正則表示式“cn\.javass\.spring\.chapter12\.TestBean2*”排除，不註冊為Spring管理Bean：

4、將把匹配到aspectj表示式“cn.javass.spring.chapter12.TestBean3*”排除，不註冊為Spring管理Bean：

具體使用就要看專案需要了，如果以上都不滿足需要請考慮使用自定義過濾器。

12.3.6 提供更多的配置元資料

1、@Lazy：定義Bean將延遲初始化，使用方式如下：

java程式碼：

@Lazy(true)
publicclass TestCompoment {
……
}

@Component("component")
@Lazy(true)
public class TestCompoment {
……
}

使用@Lazy註解指定Bean需要延遲初始化。

2、@DependsOn：定義Bean初始化及銷燬時的順序，使用方式如下：

java程式碼：

@DependsOn({"managedBean"})
publicclass TestCompoment {
……
}

@Component("component")
@DependsOn({"managedBean"})
public class TestCompoment {
……
}

3、@Scope：定義Bean作用域，預設單例，使用方式如下：

java程式碼：

@Scope("singleton")
publicclass TestCompoment {
……
}

@Component("component")
@Scope("singleton")
public class TestCompoment {
……
}

4、@Qualifier：指定限定描述符，對應於基於XML配置中的<qualifier>標籤，使用方式如下：

java程式碼： Java程式碼

@Component("component")
@Qualifier("component")
publicclass TestCompoment {
……
}

@Component("component")
@Qualifier("component")
public class TestCompoment {
……
}

可以使用複雜的擴充套件，如@Mysql等等。

5、@Primary：自動裝配時當出現多個Bean候選者時，被註解為@Primary的Bean將作為首選者，否則將丟擲異常，使用方式如下：

Spring Bean配置方式之三：註解配置

12.3.2 Spring自帶的@Component註解及擴充套件

12.3.3 JSR-250中定義的@ManagedBean註解

12.3.4 JSR-330的@Named註解

12.3.5 細粒度控制Bean定義掃描

12.3.6 提供更多的配置元資料

Spring Bean配置方式之三：註解配置

Hadoop學習------Hadoop安裝方式之(三)：分布式部署

自定義spring boot starter三部曲之三：原始碼分析spring.factories載入過程

Spring原理學習系列之三：Spring AOP原理(從原始碼層面分析)-------上部

spring事務管理之三：宣告式事務管理：使用xml配置檔案的方式

Spring中Bean的配置方式之FactoryBean

Spring Cloud之Zuul(三)：路由配置詳解

spring-bean生命週期之初始化和銷燬的三種方式

Spring4學習（三）：註解配置bean

VCSA 6.5 HA配置之三：準備工作

Spring之AOP的註解配置

Https系列之三：讓服務器同時支持http、https，基於spring boot

spring boot 系列之三：spring boot 整合JdbcTemplate

spring-bean實例化三種方式

如何安裝和配置打印服務器之三：設置打印機打印優先級別

（12）Spring學習記錄---Spring_bean（Spring_通過註解配置 Bean）

Spring Boot 系統之三：Spring Boot 整合JdbcTemplate

SpringSecurity學習筆記之三：配置使用者儲存

效能調優之MySQL篇三：MySQL配置定位以及優化

Spring中<bean>標籤之使用p標籤配置bean的屬性

Spring Bean配置方式之三：註解配置

12.3.2 Spring自帶的@Component註解及擴充套件

12.3.3 JSR-250中定義的@ManagedBean註解

12.3.4 JSR-330的@Named註解

12.3.5 細粒度控制Bean定義掃描

12.3.6 提供更多的配置元資料

相關推薦