上次去京东面试:
春天的面试官:@配置标注和类标注有什么区别?
我:当一个类上有@Configuration注释时,可以在这个类中使用@Bean注释向spring容器注册Bean;如果不添加@Configuration注释,就不能通过@Bean注释注册Bean。
面试官:你确定没有@Configuration注释就不能通过@bean注释注册Bean吗?
我:看着面试官,他犹豫了10秒说,你可以通过@Bean注释注册Bean,而不需要@Configuration。
面试官:你确定你能注册吗?
我:嗯。嗯。嗯,我肯定能注册。
面试官:它和它有什么区别?
我:似乎没有什么不同。
面试官:似乎没有什么不同。先回去等通知!
可想而知,完了!
马上回去看了一下spring的源代码,终于想通了这个问题。事实证明,加不加@Configuration差别还是挺大的。
我们来看看@Configuration注释是做什么的,有什么区别?下次去面试,可以吹给面试官听。
以前,我们都是用xml定义bean,很多bean元素都会用XML编写。然后,当spring启动时,它会读取bean xml配置文件,然后解析这些配置,然后在spring容器中注册这些bean供用户使用。
Jdk1.5有标注的功能,spring也没闲着。它觉得注释挺有用的,就加了。让我们通过注释来定义bean,这样可以达到和用xml定义bean一样的效果,而且更加简洁。这里需要使用的注释是@Configuration注释和@Bean注释。
@Configuration批注用法@Configuration可以将此批注添加到类中,使该类的功能等同于bean xml配置文件,如下所示:
@ ConfigurationPublicClassConfigBean { }上面的代码类似于下面的xml:
?xmlversion='1.0 '编码='UTF-8 '?Beans xmlns=' http://www . spring framework . org/schema/Beans ' xmlns : xsi=' http://www . w3 . org/2001/XML schema-instance ' xsi : schema location=' http://www . spring framework . org/schema/Beans http://www . spring framework . org/schema/Beans/spring-Beans-4.3 . xsd '/Beans通过AnnotationConfigApplicationContext加载由@Configuration修饰的类,如下所示
AnnotationConfigApplicationContextcontext=newAnnotationConfigApplicationContext(config bean . class);此时,ConfigBean类中没有任何内容,相当于一个空的xml配置文件。此时,我们需要在Configbean类中注册Bean,因此需要使用@Bean注释。
总结一下使用@Configuration的步骤:
在类上使用@Configuration批注,通过AnnotationConfigApplicationContext容器在类上添加@Configuration批注。class @Bean注释的用法。该注释类似于bean xml配置文件中的bean元素,用于在spring容器中注册bean。
@Bean注释用于方法,这意味着Bean是由方法定义的。默认情况下,方法名被用作bean名,方法返回值被用作bean对象,bean对象在spring容器中注册。
比如:
@Beanpubl
ic User user1() { return new User();}@Bean注解还有很多属性,我们来看一下其源码:@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) //@1@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Bean { @AliasFor("name") String<> value() default {}; @AliasFor("value") String<> name() default {}; @Deprecated Autowire autowire() default Autowire.NO; boolean autowireCandidate() default true; String initMethod() default ""; String destroyMethod() default AbstractBeanDefinition.INFER_METHOD;}@1:说明这个注解可以用在方法和注解类型上面。
每个参数含义:
value和name是一样的,设置的时候,这2个参数只能选一个,原因是@AliasFor导致的
@AliasFor这个注解不清楚的可以看这个文章:详解注解
value:字符串数组,第一个值作为bean的名称,其他值作为bean的别名
autowire:这个参数上面标注了@Deprecated,表示已经过期了,不建议使用了
autowireCandidate:是否作为其他对象注入时候的候选bean,之前的文章中专门介绍过这个属性,不清楚的可以去看看:autowire-candidate详解
initMethod:bean初始化的方法,这个和生命周期有关,以后详解
destroyMethod:bean销毁的方法,也是和生命周期相关的,以后详解
案例User类package com.javacode2018.lesson001.demo20;public class User {}Bean配置类:ConfigBeanpackage com.javacode2018.lesson001.demo20;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class ConfigBean { //bean名称为方法默认值:user1 @Bean public User user1() { return new User(); } //bean名称通过value指定了:user2Bean @Bean("user2Bean") public User user2() { return new User(); } //bean名称为:user3Bean,2个别名:
来个测试类package com.javacode2018.lesson001.demo20;import org.junit.Test;import org.springframework.context.annotation.AnnotationConfigApplicationContext;import java.util.Arrays;public class ConfigurationTest { @Test public void test1() { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean.class);//@1 for (String beanName : context.getBeanDefinitionNames()) { //别名 String<> aliases = context.getAliases(beanName); System.out.println(String.format("bean名称:%s,别名:%s,bean对象:%s", beanName, Arrays.asList(aliases), context.getBean(beanName))); } }}@1:通过AnnotationConfigApplicationContext来加载配置类ConfigBean,会将配置类中所有的bean注册到spring容器中
for循环中输出了bean名称、别名、bean对象
运行test1方法输出bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:<>,bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@3bd82cf5bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:<>,bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@544fa968bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:<>,bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@247bddadbean名称:org.springframework.context.event.internalEventListenerProcessor,别名:<>,bean对象:org.springframework.context.event.EventListenerMethodProcessor@d35dea7bean名称:org.springframework.context.event.internalEventListenerFactory,别名:<>,bean对象:org.springframework.context.event.DefaultEventListenerFactory@7770f470bean名称:configBean,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ConfigBean$$EnhancerBySpringCGLIB$$dde45976@5e5d171fbean名称:user1,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@24313fccbean名称:user2Bean,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@7d20d0bbean名称:user3Bean,别名:
从输出中可以看出,有个名称为configBean的bean,正是ConfigBean这个类型,可以得出,被@Configuration修饰的类,也被注册到spring容器中了
最后3行输出就是几个User的bean对象了。
上面的用法应该很多人都比较熟悉,下面的属于重点了。
去掉@Configuration会怎样?我们来看一下没有@Configuration的时候,什么效果。
新建一个ConfigBean1类内容和ConfigBean类一样,只是将@Configuration注解去掉了,如下:
public class ConfigBean1 { //bean名称为方法默认值:user1 @Bean public User user1() { return new User(); } //bean名称通过value指定了:user2Bean @Bean("user2Bean") public User user2() { return new User(); } //bean名称为:user3Bean,2个别名:
@Testpublic void test2() { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean1.class); for (String beanName : context.getBeanDefinitionNames()) { //别名 String<> aliases = context.getAliases(beanName); System.out.println(String.format("bean名称:%s,别名:%s,bean对象:%s", beanName, Arrays.asList(aliases), context.getBean(beanName))); }}运行输出bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:<>,bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@333291e3bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:<>,bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@479d31f3bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:<>,bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@40ef3420bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:<>,bean对象:org.springframework.context.event.EventListenerMethodProcessor@498d318cbean名称:org.springframework.context.event.internalEventListenerFactory,别名:<>,bean对象:org.springframework.context.event.DefaultEventListenerFactory@6e171cd7bean名称:configBean1,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ConfigBean1@402bba4fbean名称:user1,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@795cd85ebean名称:user2Bean,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@59fd97a8bean名称:user3Bean,别名:
有@Configuration注解的bean名称:configBean,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ConfigBean$$EnhancerBySpringCGLIB$$dde45976@5e5d171fbean名称:user1,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@24313fccbean名称:user2Bean,别名:<>,bean对象:com.javacode2018.lesson001.demo20.User@7d20d0bbean名称:user3Bean,别名:
@Configuration加不加到底区别在哪?通常情况下,bean之间是有依赖关系的,我们来创建个有依赖关系的bean,通过这个案例你就可以看出根本的区别了。
再来一个加@Configuration的案例定义2个类。
ServiceApackage com.javacode2018.lesson001.demo20;public class ServiceA {}ServiceBpackage com.javacode2018.lesson001.demo20;public class ServiceB { private ServiceA serviceA; public ServiceB(ServiceA serviceA) { this.serviceA = serviceA; } @Override public String toString() { return "ServiceB{" + "serviceA=" + serviceA + '}'; }}上面定义了2个类,ServiceB依赖于ServiceA,ServiceB通过构造器注入ServiceA。
来个@Configuration类管理上面对象。
ConfigBean2package com.javacode2018.lesson001.demo20;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class ConfigBean2 { @Bean public ServiceA serviceA() { System.out.println("调用serviceA()方法"); //@0 return new ServiceA(); } @Bean ServiceB serviceB1() { System.out.println("调用serviceB1()方法"); ServiceA serviceA = this.serviceA(); //@1 return new ServiceB(serviceA); } @Bean ServiceB serviceB2() { System.out.println("调用serviceB2()方法"); ServiceA serviceA = this.serviceA(); //@2 return new ServiceB(serviceA); }}上面通过@Bean注解,向容器中注册了3个bean
注意@1和@2,通过this.serviceA()获取需要注入的ServiceA对象。
上面每个方法第一行都输出了一行日志。
重点关注一下@0这行日志会输出几次,大家先思考一下1次还是3次?
测试用例@Testpublic void test3() { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean2.class); for (String beanName : context.getBeanDefinitionNames()) { //别名 String<> aliases = context.getAliases(beanName); System.out.println(String.format("bean名称:%s,别名:%s,bean对象:%s", beanName, Arrays.asList(aliases), context.getBean(beanName))); }}运行输出截取了几行输出如下:
调用serviceA()方法调用serviceB1()方法调用serviceB2()方法bean名称:configBean2,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ConfigBean2$$EnhancerBySpringCGLIB$$ffa0178@77f1baf5bean名称:serviceA,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ServiceA@41a2befbbean名称:serviceB1,别名:<>,bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@41a2befb}bean名称:serviceB2,别名:<>,bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@41a2befb}分析结果从输出中可以看出
前三行可以看出,被@Bean修饰的方法都只被调用了一次,这个很关键最后三行中可以看出都是同一个ServiceA对象,都是`ServiceA@41a2befb`这个实例这是为什么?被@Configuration修饰的类,spring容器中会通过cglib给这个类创建一个代理,代理会拦截所有被@Bean修饰的方法,默认情况(bean为单例)下确保这些方法只被调用一次,从而确保这些bean是同一个bean,即单例的。
至于底层是如何实现的,可以去看一下公众号里面这篇文章:详解java中的动态代理和cglib代理。
现在各位应该感受到了,我写的文章前后一般都是有依赖的,所以也建议大家按顺序看,这样知识就是贯通的。
不加的案例我们再来看看将ConfigBean2上的的@Configuration去掉,效果如何,代码就不写了,直接上输出结果:
调用serviceA()方法调用serviceB1()方法调用serviceA()方法调用serviceB2()方法调用serviceA()方法bean名称:configBean2,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ConfigBean2@6e171cd7bean名称:serviceA,别名:<>,bean对象:com.javacode2018.lesson001.demo20.ServiceA@402bba4fbean名称:serviceB1,别名:<>,bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@795cd85e}bean名称:serviceB2,别名:<>,bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@59fd97a8}结果分析serviceA()方法被调用了3次configBean2这个bean没有代理效果了最后3行可以看出,几个ServiceA对象都是不一样的spring这块的源码spring中用下面这个类处理@Configuration这个注解:
org.springframework.context.annotation.ConfigurationClassPostProcessor这里面重点关注这几个方法:
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory) 最后一个方法会创建cglib代理,大家可以设置断点进去看看,有问题欢迎交流。
总结到目前为止加不加@Configuration注解,有什么区别,大家估计比我都清楚了@Configuration注解修饰的类,会被spring通过cglib做增强处理,通过cglib会生成一个代理对象,代理会拦截所有被@Bean注解修饰的方法,可以确保一些bean是单例的不管@Bean所在的类上是否有@Configuration注解,都可以将@Bean修饰的方法作为一个bean注册到spring容器中点击跳转京东T8架构师解析Spring Cloud与Docker高并发微服务架构核心理念