Spring管理的@Configuration註解使用

paikey發表於2019-05-12
Spring

從Spring3.0，@Configuration用於定義配置類，可替換xml配置檔案，被註解的類內部包含有一個或多個被@Bean註解的方法，這些方法將會被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext類進行掃描，並用於構建bean定義，初始化Spring容器。

注意：@Configuration註解的配置類有如下要求：

  • @Configuration不可以是final型別；
  • @Configuration不可以是匿名類；
  • 巢狀的@Configuration必須是靜態類。

一、@Configuation載入Spring方法

1.1、@Configuration配置spring並啟動spring容器

@Configuration標註在類上，相當於把該類作為spring的xml配置檔案中的，作用為：配置spring容器(應用上下文)

package com.cqupt.meeting.config;

import org.springframework.context.annotation.Configuration;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 14:44
 */
@Configuration
public class TestConfig {

    public TestConfig(){
        System.out.println("testconfig collection  init success");
    }
}

複製程式碼

相當於

<?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" xmlns:jdbc="http://www.springframework.org/schema/jdbc"  
    xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:util="http://www.springframework.org/schema/util" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.0.xsd
        http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd
        http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd" default-lazy-init="false">


</beans>
複製程式碼

主方法進行測試：

package com.cqupt.meeting.config;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 14:46
 */
public class Main {

    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new
        // ClassPathXmlApplicationContext("spring-context.xml");
    }
}

複製程式碼

從執行主方法結果可以看出，spring容器已經啟動了：

WARNING: All illegal access operations will be denied in a future release
testconfig collection  init success

Process finished with exit code 0

複製程式碼

1.2、@Configuration啟動容器+@Bean註冊Bean，@Bean下管理bean的生命週期

@Bean標註在方法上(返回某個例項的方法)，等價於spring的xml配置檔案中的，作用為：註冊bean物件

bean類：

package com.cqupt.meeting.config;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 14:54
 */
public class TestBean {

    private String username;
    private String url;
    private String password;

    public void sayHello() {
        System.out.println("TestBean sayHello...");
    }

    public void start() {
        System.out.println("TestBean init...");
    }

    public void cleanup() {
        System.out.println("TestBean destroy...");
    }
}

複製程式碼

配置類：為TestConfig類新增方法

    // @Bean註解註冊bean,同時可以指定初始化和銷燬方法
    // @Bean(name="testBean",initMethod="start",destroyMethod="cleanup")
    //name屬性相當於<bean>標籤的id
    @Bean
    @Scope("prototype")
    public TestBean testBean() {
        return new TestBean();
    }
}
複製程式碼

測試:

public class Main {

    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new
        // ClassPathXmlApplicationContext("spring-context.xml");

        //獲取bean
        TestBean testBean = (TestBean) context.getBean("testBean");
        testBean.sayHello();
    }
}

結果：
testconfig collection  init success
TestBean sayHello...

Process finished with exit code 0

複製程式碼

注：
(1)、@Bean註解在返回例項的方法上，如果未通過@Bean指定bean的名稱，則預設與標註的方法名相同（第一個單詞轉小寫）；

(2)、@Bean註解預設作用域為單例singleton作用域，可通過@Scope(“prototype”)設定為原型作用域；

(3)、既然@Bean的作用是註冊bean物件，那麼完全可以使用@Component、@Controller、@Service、@Ripository等註解註冊bean，當然需要配置@ComponentScan註解進行自動掃描。

scope屬性
1). singleton屬性值（掌握）：預設值，單例
2). prototype屬性值（掌握）：多例（原型作用域）
3). request屬性值(瞭解）：建立物件，把物件放到request域裡
4). session屬性值(瞭解）：建立物件，把物件放到session域裡
5). globalSession屬性值(瞭解）：建立物件，把物件放到globalSession域裡

@Bean下管理bean的生命週期
可以使用基於 Java 的配置來管理 bean 的生命週期。@Bean 支援兩種屬性，即 initMethod 和destroyMethod，這些屬性可用於定義生命週期方法。在例項化 bean 或即將銷燬它時，容器便可呼叫生命週期方法。生命週期方法也稱為回撥方法，因為它將由容器呼叫。使用 @Bean 註釋註冊的 bean 也支援 JSR-250 規定的標準 @PostConstruct 和 @PreDestroy 註解。如果您正在使用 XML 方法來定義 bean，那麼就應該使用 bean 元素來定義生命週期回撥方法。以下程式碼顯示了在 XML 配置中通常使用 bean 元素定義回撥的方法。

    //@Bean註解註冊bean,同時可以指定初始化和銷燬方法
    @Bean(name="testBean",initMethod="start",destroyMethod="cleanUp")
    @Scope("prototype")
    public TestBean testBean() {
        return new TestBean();
    }
複製程式碼

啟動測試類：

public class TestMain {
    public static void main(String[] args) {

        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);

        TestBean tb = (TestBean) context.getBean("testBean");
        System.out.println(tb);
        
        TestBean tb2 = (TestBean) context.getBean("testBean");
        System.out.println(tb2);
    }
}

結果：
testconfig collection  init success
TestBean init...
com.cqupt.meeting.config.TestBean@5852c06f
TestBean init...
com.cqupt.meeting.config.TestBean@4149c063

Process finished with exit code 0
複製程式碼

分析：

結果中的1：表明initMethod生效

結果中的2：表明@Scope("prototype")生效

1.3、@Configuration啟動容器+@Component註冊Bean

bean類

package com.cqupt.meeting.config;

import org.springframework.stereotype.Component;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 14:54
 */
//新增註冊bean的註解
@Component
public class TestBean {

    private String username;
    private String url;
    private String password;

    public void sayHello() {
        System.out.println("TestBean sayHello...");
    }
    
    public void start() {
        System.out.println("TestBean init...");
    }

    public void cleanup() {
        System.out.println("TestBean destroy...");
    }
}

複製程式碼

配置類：

package com.cqupt.meeting.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Scope;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 14:44
 */
@Configuration
//新增自動掃描註解，basePackages為TestBean包路徑
@ComponentScan(basePackages = "com.cqupt.meeting.config")
public class TestConfig {

    public TestConfig(){
        System.out.println("testconfig collection  init success");
    }

     // @Bean註解註冊bean,同時可以指定初始化和銷燬方法
//    @Bean(name="testBean",initMethod="start",destroyMethod="cleanup")
////    @Bean
//    @Scope("prototype")
//    public TestBean testBean() {
//        return new TestBean();
//    }
}

複製程式碼

主方法測試獲取bean物件：

public class Main {

    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");

        //獲取bean
        TestBean testBean1 = (TestBean) context.getBean("testBean");
        testBean1.sayHello();
    }
}
結果：
testconfig collection  init success
TestBean sayHello...

Process finished with exit code 0
複製程式碼

sayHello()方法被正常呼叫

1.4、使用 AnnotationConfigApplicationContext 註冊 AppContext 類的兩種方法

1.4.1、 配置類的註冊方式是將其傳遞給 AnnotationConfigApplicationContext 建構函式
public static void main(String[] args) {

        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);

        //獲取bean
        TestBean tb = (TestBean) context.getBean("testBean");
        tb.sayHello();
    }
複製程式碼
1.4.2、 AnnotationConfigApplicationContext 的register 方法傳入配置類來註冊配置類
public static void main(String[] args) {
  ApplicationContext ctx = new AnnotationConfigApplicationContext();
  ctx.register(AppContext.class)
}
複製程式碼

1.5、配置Web應用程式(web.xml中配置AnnotationConfigApplicationContext)

過去，您通常要利用 XmlWebApplicationContext 上下文來配置 Spring Web 應用程式，即在 Web 部署描述符檔案 web.xml 中指定外部 XML 上下文檔案的路徑。XMLWebApplicationContext 是 Web 應用程式使用的預設上下文類。以下程式碼描述了 web.xml 中指向將由 ContextLoaderListener 監聽器類載入的外部 XML 上下文檔案的元素。

<web-app>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>
    <servlet>
    <servlet-name>sampleServlet</servlet-name>
    <servlet-class>
        org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    </servlet>

...
</web-app>
複製程式碼

現在，您要將 web.xml 中的上述程式碼更改為使用 AnnotationConfigApplicationContext 類。切記，XmlWebApplicationContext 是 Spring 為 Web 應用程式使用的預設上下文實現，因此您永遠不必在您的web.xml 檔案中顯式指定這個上下文類。現在，您將使用基於 Java 的配置，因此在配置 Web 應用程式時，需要在web.xml 檔案中指定 AnnotationConfigApplicationContext 類。上述程式碼將修改如下：

<web-app>
    <context-param>
        <param-name>contextClass</param-name>
        <param-value>
            org.springframework.web.context.
            support.AnnotationConfigWebApplicationContext
        </param-value>
    </context-param>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            demo.AppContext
        </param-value>
    </context-param>
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>
    <servlet>
    <servlet-name>sampleServlet</servlet-name>
    <servlet-class>
        org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    <init-param>
        <param-name>contextClass</param-name>
        <param-value>
            org.springframework.web.context.
            support.AnnotationConfigWebApplicationContext
        </param-value>
    </init-param>
    </servlet>

...
</web-app>
複製程式碼

以上修改後的 web.xml 現在定義了 AnnotationConfigWebApplicationContext 上下文類，並將其作為上下文引數和 servlet 元素的一部分。上下文配置位置現在指向 AppContext 配置類。這非常簡單。下一節將演示 bean 的生命週期回撥和範圍的實現。

1.6、@Configuation總結

@Configuation等價於

@Bean等價於

@ComponentScan等價於<context:component-scan base-package="com.dxz.demo"/>

二、組合多個配置類

2.1、在@configuration中引入spring的xml配置檔案

package com.cqupt.meeting.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 20:31
 */
@Configuration
@ImportResource("classpath:configtest.xml")
public class WebConfig {

 public WebConfig(){
        System.out.println("WebConfig coolection init success");
    } 
}

複製程式碼

TestBean2:

package com.cqupt.meeting.config;

/**
 * @Author: ranjun
 * @Date: 2019/5/12 20:32
 */
public class TestBean2 {

    private String username;
    private String url;
    private String password;

    public void setUsername(String username) {
        this.username = username;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public void sayHello() {
        System.out.println("TestBean2 sayHello..."+username);
    }


    public void start() {
        System.out.println("TestBean2 init...");
    }

    public void cleanUp() {
        System.out.println("TestBean2 destroy...");
    }
}

複製程式碼

configtest.xml

<?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.xsd">

    <bean id="testBean2" class="com.cqupt.meeting.config.TestBean2">
        <property name="username" value="ranjun"></property>
    </bean>
</beans>
複製程式碼

測試類:

public class TestMain2 {


    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(WebConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");

        // 獲取bean
        TestBean2 tb = (TestBean2) context.getBean("testBean2");
        tb.sayHello();
    }
}


結果：
WebConfig coolection init success
TestBean2 sayHello...ranjun

Process finished with exit code 0


複製程式碼

2.2、在@configuration中引入其它註解配置

@Configuration
@ImportResource("classpath:configtest.xml")
@Import(TestConfig.class)
public class WebConfig {

public WebConfig(){
        System.out.println("WebConfig coolection init success");
    }
}

複製程式碼

TestConfig:

@Configuration
//新增自動掃描註解，basePackages為TestBean包路徑
//@ComponentScan(basePackages = "com.cqupt.meeting.config")
public class TestConfig {


    public TestConfig(){
        System.out.println("testconfig collection  init success");
    }

    // @Bean註解註冊bean,同時可以指定初始化和銷燬方法
//    @Bean(name="testBean",initMethod="start",destroyMethod="cleanup")
    @Bean
    @Scope("prototype")
    public TestBean testBean() {
        return new TestBean();
    }
}

複製程式碼

測試類：

public class TestMain2 {


    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(WebConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");

        // 獲取bean
        TestBean tb = (TestBean) context.getBean("testBean");
        tb.sayHello();

        TestBean2 tb2 = (TestBean2) context.getBean("testBean2");
        tb2.sayHello();
    }
}

結果：
WebConfig coolection init success
testconfig collection  init success
TestBean sayHello...
TestBean2 sayHello...ranjun

Process finished with exit code 0
複製程式碼

可以看到三個容器都成功啟動了

2.3、@configuration巢狀（巢狀的Configuration必須是靜態類）

通過配置類巢狀的配置類，達到組合多個配置類的目的。==但注意內部類必須是靜態類==。

上程式碼：

@Configuration
//新增自動掃描註解，basePackages為TestBean包路徑
//@ComponentScan(basePackages = "com.cqupt.meeting.config")
public class TestConfig {


    public TestConfig(){
        System.out.println("testconfig collection  init success");
    }

    // @Bean註解註冊bean,同時可以指定初始化和銷燬方法
//    @Bean(name="testBean",initMethod="start",destroyMethod="cleanup")
    @Bean
    @Scope("prototype")
    public TestBean testBean() {
        return new TestBean();
    }

    @Configuration
    static class InnerConfig {
        @Bean
        TestBean2 testBean2() {
            TestBean2 testBean2 =  new TestBean2();
            testBean2.setUsername("ranjun");
            return testBean2;
        }
    }
}
複製程式碼

測試類：

public class TestMain {

    public static void main(String[] args) {
        // @Configuration註解的spring容器載入方式，用AnnotationConfigApplicationContext替換ClassPathXmlApplicationContext
        ApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);

        // 如果載入spring-context.xml檔案：
        // ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");

        //獲取bean
        TestBean testBean1 = (TestBean) context.getBean("testBean");
        testBean1.sayHello();

        TestBean2 testBean2 = (TestBean2)context.getBean("testBean2");
        testBean2.sayHello();
    }
}

結果：
testconfig collection  init success
TestBean sayHello...
TestBean2 sayHello...ranjun

Process finished with exit code 0

複製程式碼

3、@EnableXXX註解

配合@Configuration使用，包括 @EnableAsync, @EnableScheduling, @EnableTransactionManagement, @EnableAspectJAutoProxy, @EnableWebMvc。

@EnableAspectJAutoProxy--- spring AOP 之二：@AspectJ註解的3種配置

@EnableScheduling--《Spring 3.1新特性之二：@Enable*註解的原始碼,spring原始碼分析之定時任務Scheduled註解

4、@Profile邏輯組配置

見《Spring的@PropertySource + Environment，@PropertySource（PropertySourcesPlaceholderConfigurer）+@Value配合使用》

5、使用外部變數

1、@PropertySource + Environment，通過@PropertySource註解將properties配置檔案中的值儲存到Spring的 Environment中，Environment介面提供方法去讀取配置檔案中的值，引數是properties檔案中定義的key值。

2、@PropertySource（PropertySourcesPlaceholderConfigurer）+@Value

見《Spring的@PropertySource + Environment，@PropertySource（PropertySourcesPlaceholderConfigurer）+@Value配合使用》

相關文章