springboot @Configuration 注解详解

基于:www.yuque.com/atguigu/springboot
进行总结、补充。

@Configuration 详解

场景

新建两个bean:user 和 pet。

若要将这两个 bean 的实例注入到容器之中,在曾经 spring 阶段我们的做法是使用 xml 进行配置。

在项目的 resource 文件夹下新建 bean.xml 并进行配置,配置内容如下:


<bean id="user01" class="xt.naru.learn.bean.User">  
    <property name="name" value="naru"></property>  
    <property name="age" value="21"></property>  
</bean>  

<bean id="cat" class="xt.naru.learn.bean.Pet">  
    <property name="name" value="tomcat"></property>  
</bean>

当项目需求越来越大时,我们时常会陷入 xml 配置地狱,因此为了解决这一问题, springboot 可以通过注解的方式进行实例注入而无需编写xml。

使用

在 springboot 中我们不再使用xml进行配置。
修改为 新建配置类,并将配置类加上 Configuration 注解,在配置类中进行bean实例的注入。

代码如下:

@Configuration  
public class myconfig {  

    @Bean  
    public User user01(){  
        return new User("naru",21);  
    }  

    @Bean  
    public Pet tomcat(){  
        return new Pet("tomcat");  
    }  
}

相比起 xml 的变化对比:

其实就是将xml中的配置项改为了注解,还是蛮好理解的。

检测注入结果

在main启动器中进行 beanname 的打印即可。

@SpringBootApplication  
public class MainApplication {  

    public static void main(String[] args) {  
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);  

        String[] beannames = run.getBeanDefinitionNames();  
        for (String name : beannames){  
            System.out.println(name);  
        }  
    }  
}

可以看到我们的 user01 以及 cat 成功注入。

一些特性

bean实例名称自定义

直接在 bean 注解中加入想要自定义的 bean 的名称就可以了。

通过阅读上面的代码可发现,默认 bean 的名称和方法名相同。

看!原来叫做 cat 的bean,现在名字变成了 tom-cat!

从容器中获取的实例默认为单实例

来试试吧,在 main 启动器中获取组件并打印其 boolean 结果:


Pet Tom01 = run.getBean("tom-cat",Pet.class);  
Pet Tom02 = run.getBean("tom-cat",Pet.class);  

System.out.println("组件实例是否是同一个:"+ (Tom01 == Tom02));

你将神奇的发现,是同一个实例:

配置类本身也是组件

直接来实践一下吧,通过以下代码进行打印:

System.out.println(run.getBean(myconfig.class));

结果显而易见:

xt.naru.learn.config.myconfig$$EnhancerBySpringCGLIB$$f891ec73@15f193b8

proxyBeanMethods

springboot2的版本中,configration注解中有这样一个方法:
proxyBeanMethods

它的默认值为true。
它是干嘛用的呢? 直译过来是代理 bean 方法的意思。

或许这句话有些难以理解,这样去想吧,我们在 myconfig 中进行了两个 bean 的实例化。

而有参、无参构造,每调用一次我们都可以生成新的实例化对象。那这是否意味着,我从容器中或许到的组件,每次都是不同的呢?

我们来进行测试:

调用两次无参构造,生成新对象。看看二者是否相同。

myconfig bean = run.getBean(myconfig.class);  

System.out.println(run.getBean(myconfig.class));  

User user = bean.user01();  
User user1= bean.user01();  
System.out.println("user和user1是否为同一个实例:"+(user1 == user));

会发现, 是相同的。

那么,proxyBeanMethods到底做了什么呢?

先卖个关子,我们将它改为false,再进行一次打印。看看结果。

会发现,myconfig 的 bean 名变了,实例也不再是同一个实例。

那么我们可以总结一下 proxyBeanMethods 所做的事情:

****当proxyBeanMethods为true时:

将配置类变成增强型的代理类。保证 @bean 的方法被调用多少次,返回的组件均为单实例。

此模式被称为Full模式。即每次启动时,SpringBoot总会检查这个组件是否在容器中存在,保持组件单实例。

保持组件单实例有什么好处呢?

保证组件之间的依赖关系不被破坏。

设想一下吧,如果不是单实例的组件,当我们的 User 小明,想要养一只叫 tom 的猫时,有很多只叫做 tom 的猫,他将分不清到底哪只属于他。
而单实例情况下,将不会出现这种问题,因为我们每次调用构造方法生成的实例对象一直都是同一只叫做 tom 的猫。

配置类组件之间有依赖关系,方法会被调用得到之前单实例组件,用 Full 模式

当proxyBeanMethods为false时:

配置类为普通的类,此时每个@Bean方法被调用多少次返回的组件都是新创建的。

此模式被称为 Lite 模式,即 springboot 将不再会去判断组件是否已经在容器中存在,而是直接新建组件。(省去了检查流程,此模式下 springboot 启动会非常的快。)

总结

好了,现在让我们来总结一下关于 @Configuration 注解的要点。

  • 存在为了解决怎样的问题?
    方便bean实例的注入,我们不再需要使用xml进行配置了!只需要使用java代码就可以完成bean实例的注入了。
  • 特性有哪些呢?
    • 1、配置类里面使用@Bean标注在方法上给容器注册组件,默认也是单实例的
    • 2、配置类本身也是组件
    • 3、proxyBeanMethods:代理bean的方法
      • Full(proxyBeanMethods = true)、【保证每个@Bean方法被调用多少次返回的组件都是单实例的】
      • Lite(proxyBeanMethods = false)【每个@Bean方法被调用多少次返回的组件都是新创建的】
      • 组件依赖必须使用Full模式默认。其他默认是否Lite模式
本作品采用《CC 协议》,转载必须注明作者和本文链接
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!