@Configuration的使用

╰+哭是因爲堅強的太久メ 2022-05-28 10:38 129阅读 0赞

从Spring3.0，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

**注意**：@Configuration注解的配置类有如下要求：

1.  @Configuration不可以是final类型；
2.  @Configuration不可以是匿名类；
3.  嵌套的configuration必须是静态类。

一、用@Configuration加载spring  
1.1、@Configuration配置spring并启动spring容器  
1.2、@Configuration启动容器+@Bean注册Bean  
1.3、@Configuration启动容器+@Component注册Bean  
1.4、**使用 AnnotationConfigApplicationContext 注册 AppContext 类的两种方法  
1.5、配置Web应用程序(web.xml中配置AnnotationConfigApplicationContext)**

二、组合多个配置类  
2.1、在@configuration中引入spring的xml配置文件  
2.2、在@configuration中引入其它注解配置  
2.3、@configuration嵌套（嵌套的Configuration必须是静态类）  
三、@EnableXXX注解  
四、@Profile逻辑组配置  
五、使用外部变量

## 一、@Configuation加载Spring方法 ##

### 1.1、@Configuration配置spring并启动spring容器 ###

@Configuration标注在类上，相当于把该类作为spring的xml配置文件中的`<beans>`，作用为：配置spring容器(应用上下文)

![复制代码][copycode.gif]

package com.dxz.demo.configuration;
    
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class TestConfiguration {
        public TestConfiguration() {
            System.out.println("TestConfiguration容器启动初始化。。。");
        }
    }

![复制代码][copycode.gif]

相当于：

![复制代码][copycode.gif]

<?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>

![复制代码][copycode.gif]

主方法进行测试：

![复制代码][copycode.gif]

package com.dxz.demo.configuration;
    
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.annotation.AnnotationConfigApplicationContext;
    
    public class TestMain {
        public static void main(String[] args) {
    
            // @Configuration注解的spring容器加载方式，用AnnotationConfigApplicationContext替换ClassPathXmlApplicationContext
            ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
    
            // 如果加载spring-context.xml文件：
            // ApplicationContext context = new
            // ClassPathXmlApplicationContext("spring-context.xml");
        }
    }

![复制代码][copycode.gif]

从运行主方法结果可以看出，spring容器已经启动了：

![285763-20170908101629304-1829286984.png][]

### 1.2、@Configuration启动容器+@Bean注册Bean，@Bean下管理bean的生命周期 ###

@Bean标注在方法上(返回某个实例的方法)，等价于spring的xml配置文件中的`<bean>`，作用为：注册bean对象

bean类：

![复制代码][copycode.gif]

package com.dxz.demo.configuration;
    
    public class TestBean {
    
        private String username;
        private String url;
        private String password;
    
        public void sayHello() {
            System.out.println("TestBean sayHello...");
        }
    
        public String toString() {
            return "username:" + this.username + ",url:" + this.url + ",password:" + this.password;
        }
    
        public void start() {
            System.out.println("TestBean 初始化。。。");
        }
    
        public void cleanUp() {
            System.out.println("TestBean 销毁。。。");
        }
    }

![复制代码][copycode.gif]

配置类：

![复制代码][copycode.gif]

package com.dxz.demo.configuration;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Scope;
    
    @Configuration
    public class TestConfiguration {
        public TestConfiguration() {
            System.out.println("TestConfiguration容器启动初始化。。。");
        }
    
        // @Bean注解注册bean,同时可以指定初始化和销毁方法
        // @Bean(name="testBean",initMethod="start",destroyMethod="cleanUp")
        @Bean
        @Scope("prototype")
        public TestBean testBean() {
            return new TestBean();
        }
    }

![复制代码][copycode.gif]

主方法测试类：

![复制代码][copycode.gif]

结果：

![285763-20170908102054726-580591415.png][]

注：   
(1)、@Bean注解在返回实例的方法上，如果未通过@Bean指定bean的名称，则默认与标注的方法名相同；   
(2)、@Bean注解默认作用域为单例singleton作用域，可通过@Scope(“prototype”)设置为原型作用域；   
(3)、既然@Bean的作用是注册bean对象，那么完全可以使用@Component、@Controller、@Service、@Ripository等注解注册bean，当然需要配置@ComponentScan注解进行自动扫描。

## ##

### **@Bean下管理bean的生命周期** ###

可以使用基于 Java 的配置来管理 bean 的生命周期。`@Bean` 支持两种属性，即 `initMethod` 和`destroyMethod`，这些属性可用于定义生命周期方法。在实例化 bean 或即将销毁它时，容器便可调用生命周期方法。生命周期方法也称为回调方法，因为它将由容器调用。使用 `@Bean` 注释注册的 bean 也支持 JSR-250 规定的标准 `@PostConstruct` 和 `@PreDestroy` 注释。如果您正在使用 XML 方法来定义 bean，那么就应该使用 bean 元素来定义生命周期回调方法。以下代码显示了在 XML 配置中通常使用 bean 元素定义回调的方法。

![复制代码][copycode.gif]

@Configuration
    @ComponentScan(basePackages = "com.dxz.demo.configuration")
    public class TestConfiguration {
        public TestConfiguration() {
            System.out.println("TestConfiguration容器启动初始化。。。");
        }
    
        //@Bean注解注册bean,同时可以指定初始化和销毁方法
        @Bean(name="testBean",initMethod="start",destroyMethod="cleanUp")
        @Scope("prototype")
        public TestBean testBean() {
            return new TestBean();
        }
    }

![复制代码][copycode.gif]

启动类：

![复制代码][copycode.gif]

public class TestMain {
        public static void main(String[] args) {
    
            ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
    
            TestBean tb = (TestBean) context.getBean("testBean");
            tb.sayHello();
            System.out.println(tb);
            
            TestBean tb2 = (TestBean) context.getBean("testBean");
            tb2.sayHello();
            System.out.println(tb2);
        }
    }

![复制代码][copycode.gif]

结果：

![285763-20171227095108979-1527113599.png][]

分析：

结果中的1：表明initMethod生效

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

[copycode.gif]: /images/20220528/2c42f1b9dbf74239a3e6bd10f423baba.png
[285763-20170908101629304-1829286984.png]: /images/20220528/4afeb98a8b454d4cae9bc27e0df07138.png
[285763-20170908102054726-580591415.png]: /images/20220528/5bb086493d644b80aa1842bc47f24864.png
[285763-20171227095108979-1527113599.png]: /images/20220528/d64e616ea1f1402a8ea8541280f6ef5a.png