实践理解 @Configuration 的使用 和作用

最新推荐文章于 2024-05-23 21:48:00 发布
最新推荐文章于 2024-05-23 21:48:00 发布
阅读量939 收藏 1
点赞数
分类专栏： spring+mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ToBe_Coder/article/details/107695845
版权

从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，@Bean下管理bean的生命周期

1.3、@Configuration启动容器+@Component注册Bean

1.4、使用 AnnotationConfigApplicationContext 注册 AppContext 类的两种方法

1.5、配置Web应用程序(web.xml中配置AnnotationConfigApplicationContext) 

1.6、@Configuation总结

二、组合多个配置类 

2.1、在@configuration中引入spring的xml配置文件

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

2.3、@configuration嵌套（嵌套的Configuration必须是静态类）

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

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

package com.example.test.configuration;

import org.springframework.context.annotation.Configuration;

@Configuration
public class TestConfiguration {

    public TestConfiguration(){
        System.out.println("TestConfiguration 容器启动初始化了。。。");
    }
}

测试：

package com.example.test.configuration;

import org.springframework.context.annotation.Configuration;

@Configuration
public class TestConfiguration {

    public TestConfiguration(){
        System.out.println("TestConfiguration 容器启动初始化了。。。");
    }
}

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

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

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

bean类：

package com.example.test.configuration;

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 初始化。。。");
    }

    public void cleanUp(){
        System.out.println("TestBean 销毁。。。");
    }
}

配置类：

package com.example.test.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")
    @Scope("prototype")
    public TestBean testBean(){
        return new TestBean();
    }
}

 测试：

package com.example.test.configuration;

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

public class TestRun {

    public static void main(String[] args) throws InterruptedException {
        //如果加载 spring-context.xml文件：
        //ApplicationContext context=new ClassPathXmlApplicationContext("spring-context.xml");

        //@Configuration 注解的spring容器加载方式，用AnnotationConfigApplicationContext替换ClassPathApplicationContext
        ApplicationContext context=new AnnotationConfigApplicationContext(TestConfiguration.class);

        //获取Bean
        TestBean tb= (TestBean) context.getBean("testBean");
        tb.sayHello();
        System.out.println(tb);

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

 结果：

 注：
(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 注释。

1.3、@Configuration启动容器+@Component注册Bean

Bean类：

package com.example.test.configuration;

import org.springframework.stereotype.Component;
//增加注册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 初始化。。。");
    }

    public void cleanUp(){
        System.out.println("TestBean 销毁。。。");
    }
}

配置类：

package com.example.test.configuration;

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

@Configuration
@ComponentScan(basePackages = "com.example.test.configuration")
public class TestConfiguration {

    public TestConfiguration(){
        System.out.println("TestConfiguration 容器启动初始化了。。。");
    }
}

 测试：

package com.example.test.configuration;

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

@Configuration
@ComponentScan(basePackages = "com.example.test.configuration")
public class TestConfiguration {

    public TestConfiguration(){
        System.out.println("TestConfiguration 容器启动初始化了。。。");
    }
}

sayHello()方法都被正常调用：

1.4、使用 AnnotationConfigApplicationContext 注册 AppContext 类的两种方法

1.4.1、 配置类的注册方式是将其传递给 AnnotationConfigApplicationContext 构造函数

package com.example.test.configuration;

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

public class TestRun {

    public static void main(String[] args) throws InterruptedException {

        //@Configuration 注解的spring容器加载方式，用AnnotationConfigApplicationContext替换ClassPathApplicationContext
        ApplicationContext context=new AnnotationConfigApplicationContext(TestConfiguration.class);

        TestBean tb = (TestBean) context.getBean("testBean");
        tb.sayHello();
    }
}

1.4.2、 AnnotationConfigApplicationContext 的register 方法传入配置类来注册配置类

package com.example.test.configuration;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class TestRun {

    public static void main(String[] args){

        AnnotationConfigApplicationContext ctx=new AnnotationConfigApplicationContext();
        ctx.register(TestConfiguration.class);
        ctx.refresh();

        TestBean tb = (TestBean) ctx.getBean("testBean");
        tb.sayHello();
    }
}

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>

1.6、@Configuation总结

@Configuation等价于<Beans></Beans>

@Bean等价于<Bean></Bean>

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

 

二、组合多个配置类 

2.1、在@configuration中引入spring的xml配置文件

配置类：

package com.example.test.configuration;

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

/**
 * 引入spring的xml配置文件
 */
@Configuration
@ImportResource("classpath:applicationContext-configuration.xml")
public class WebConfig {
}

Bean:

package com.example.test.configuration;

public class TestBean2 {

    private String userName;
    private String url;
    private String password;

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

    public void start(){
        System.out.println("TestBean2 初始化。。。");
    }

    public void cleanUp(){
        System.out.println("TestBean2 销毁。。。");
    }
}

classpath:applicationContext-configuration.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" xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-3.2.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop-3.2.xsd
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-tx-3.2.xsd ">

    <bean id="testBean2" class="com.example.test.configuration.TestBean2">

    </bean>
</beans>

测试：

package com.example.test.configuration;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class TestRun {

    public static void main(String[] args){

        AnnotationConfigApplicationContext ctx=new AnnotationConfigApplicationContext();
        ctx.register(WebConfig.class);
        ctx.refresh();

        TestBean2 tb = (TestBean2) ctx.getBean("testBean2");
        tb.sayHello();
    }
}

 结果：

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

配置类：

package com.example.test.configuration;

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

/**
 * 引入spring的xml配置文件
 */
@Configuration
@ImportResource("classpath:applicationContext-configuration.xml")//配置文件
@Import(TestConfiguration.class)//配置类
public class WebConfig {
}

测试：

package com.example.test.configuration;

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

public class TestRun {

    public static void main(String[] args){
        ApplicationContext ctx=new AnnotationConfigApplicationContext(WebConfig.class);

        TestBean tb = (TestBean) ctx.getBean("testBean");
        tb.sayHello();

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

结果：

2.3、@configuration嵌套（嵌套的Configuration必须是静态类）

通过配置类嵌套的配置类，达到组合多个配置类的目的。但注意内部类必须是静态类。

配置类：

package com.example.test.configuration;

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

@Configuration
@ComponentScan(basePackages = "com.example.test.configuration")  //TestBean 增加了@Component注解
public class TestConfiguration {

    public TestConfiguration(){
        System.out.println("TestConfiguration 容器启动初始化了。。。");
    }

    static class TestConfiguration2{
        @Bean
        TestBean2 testBean2(){
            return new TestBean2();
        }
    }
}

测试类：

package com.example.test.configuration;

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

public class TestRun {

    public static void main(String[] args){
        ApplicationContext ctx=new AnnotationConfigApplicationContext(TestConfiguration.class);

        TestBean tb = (TestBean) ctx.getBean("testBean");
        tb.sayHello();

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

结果：

参考文章：https://www.breakyizhan.com/java/14623.html#11 

程序员楂楂
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
@Configuration初始化一个类
HziLiu的博客
01-27 645
package org.jeecg.config; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; import org.springframework.mail.javamail.JavaMailSender; import org.springf
SpringBoot项目中Controller层、Service层、Dao层、entity层、Configuration层、Utils层作用
weixin_61370021的博客
05-21 5638
一文读懂SpringBoot各层作用，SpringBoot项目中Controller层、Service层、Dao层、entity层、Configuration层、Utils层作用详解。
@Configuration的作用
zhonghuaidong的博客
02-13 1401
@Configuration的作用是可以代替xml配置文件，通过代码定义一个配置类，被注解的类里面包含多个@Bean注解方法，这些方法会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，用于定义Bean，初始化spring容器 @configuation 加载spring @configur...
@Configuration注解使用详解【记录】
最新发布
单枪匹码
05-23 1063
@Configuration类在Spring中既充当配置信息的角色，又作为容器中的一个Bean存在，其作用是提供一个灵活且强大的方式来定义和组装Spring Bean，使得Spring的配置更加灵活和方便。
Configuration 加载顺序 @order注解不生效
05-11 1万+
这个和包扫描顺序有关  
SpringBoot学习之注解@Configuration的作用、使用以及说明
qq_41623154的博客
03-08 4488
参考文档：https://blog.csdn.net/BinshaoNo_1/article/details/85005935?depth_1-utm_source=distribute.pc_relevant.none-task&utm_source=distribute.pc_relevant.none-task https://blog.csdn.net/lujiangui/art...
自定义@Configuration配置类启用开关.zip
08-26
在Spring Boot框架中，`@Configuration`注解是核心组件之一，它用于标记一个类作为配置类，使得我们可以使用...通过理解和实践这些知识点，我们可以更加灵活地控制Spring Boot应用的配置，以适应不同的部署环境和需求。
CognosFramework使用和实践.pptx
10-07
修改这些属性可以使模型更加明确，方便其他用户理解和使用。 **发布模型** 完成模型设计后，需要将其发布到 Cognos Connection，以便其他用户可以访问。这通过执行 package 菜单命令，输入发布包的名称来实现。发布...
Cognos_Framework使用和实践.pptx
10-11
在这个使用和实践的PPT中，我们将深入探讨如何使用Framework Manager进行一系列操作。 首先，课程介绍了创建新工程的过程。创建新工程是使用Framework Manager的第一步，包括确定工程名称和存放路径、输入用户名等...
Cognos Framework使用和实践.pptx
09-22
通过理解并熟练掌握创建工程、构建查询主题、建立关系、发布模型以及在Query Studio中使用这些模型的流程，用户能够有效地构建和维护自己的商业智能解决方案。在实践中，不断优化模型设计和关系构建，将有助于提升...
springboot注解@PropertySource使用Demo
08-24
阅读这篇文章可以帮助你更深入地理解这个注解的工作原理和实际应用场景。 至于提供的`PeopetyDemo`文件，可能是作者创建的一个示例项目，用来演示`@PropertySource`的使用。这个项目可能包含了`@PropertySource`...
Springboot @Configuration @bean注解作用解析
08-25
主要介绍了springboot @Configuration @bean注解作用解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring Boot中注解@ConfigurationProperties的三种使用场景
热门推荐
程序新视界
02-29 5万+
在Spring Boot中注解@ConfigurationProperties有三种使用场景，而通常情况下我们使用的最多的只是其中的一种场景。本篇文章带大家了解一下三种场景的使用情况。 场景一 使用@ConfigurationProperties和@Component注解到bean定义类上，这里@Component代指同一类实例化Bean的注解。 基本使用实例如下： // 将类定义为一个bean的...
@Configuration详解
bsegebr的博客
08-01 1410
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。也就是说，虽然写的Myconfig是在容器中注册组件用的，但是在注册组件之前会在容器中查找有没有该组件。如果有，则取该组件用于保证单实例，如果没有再注册一个新的组件。返回类型为组件类型，返回的值，就是组件在容器中的实例。使用代理模式，保证组件的单实例，启动不如false快，但是重复利用率高，适用于会重复使用组件的场景。虽然是调用了两次，可它们两个是相等的，也就是说使用了代理，取的都是同一个值。...
@Configuration注解的作用
m0_48134027的博客
04-28 1350
1.@Configuration使用 　　官方文档描述： 　　用@Configuration注释类表明其主要目的是作为bean定义的源 　　@Configuration类允许通过调用同一类中的其他@Bean方法来定义bean之间的依赖关系 代码示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 .
@Configuration作用
AlbenXie的博客
04-23 552
@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。 @Configuration标注在类上，相当于把该类作为s...
Spring中Configuration的理解
koflance的博客
03-02 3万+
基本用途从Spring3.0，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。例如：@Configuration
spring中@Configuration的重要性
expect521的博客
08-13 409
代码： test.propertiesbook.name=java book.author=jolieELConfig.javapackage com.yubai.EL;import org.apache.commons.io.IOUtils; import org.springframework.beans.factory.annotation.Autowired; import org.spr
博科SAN网络最佳实践指南-原厂版
01-19
博科SAN网络最佳实践指南-原厂版是博科公司为数据中心管理员精心编撰的一份高级指导手册，主要关注于如何有效地配置、监控和管理Brocade光纤通道存储区域网络（SAN）基础设施。这份21页的文档旨在解决数据中心管理员...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值