上次去头条面试:
面试官:spring中,类上加不加@Configuration注解,有什么区别?
我:当某个类上有@Configuration注解的时候,可以在这个类中使用@Bean注解向spring容器中注册bean;如果不加@Configuration注解,不能通过@Bean注解注册bean。
面试官:你确定不用@Configuration注解,不能通过@Bean注解来注册bean?
我:看着面试官,犹豫了10秒钟,说:不加@Configuration通过@Bean注解也可以注册bean
面试官:你确定可以注册?
我:嗯。。。。嗯。。。。嗯,我确定可以注册
面试官:那加不加到底有什么区别呢?
我:好像没有什么区别啊
面试官:好像没区别。。。。先回去等通知吧!
结果可想而知,没戏了!
回去之后立即看spring的源码,终于搞清了这个问题,原来加不加@Configuration还是有相当大的区别的。
下面我们就来看看@Configuration注解到底是干什么的,加不加到底有什么区别,下次你们去面试的时候就可以给面试官吹吹了。
之前我们都是通过xml的方式定义bean,里面会写很多bean元素,然后spring启动的时候,就会读取bean xml配置文件,然后解析这些配置,然后会将这些bean注册到spring容器中,供使用者使用。
jdk1.5里面有了注解的功能,spring也没闲着,觉得注解挺好用的,就将注解加了进来,让我们通过注解的方式来定义bean,用起来能达到xml中定义bean一样的效果,并且更简洁一些,这里面需要用到的注解就有@Configuration
注解和@Bean
注解。
@Configuration这个注解可以加在类上,让这个类的功能等同于一个bean xml配置文件,如下:
@Configuration
public class ConfigBean {
}
上面代码类似于下面的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-4.3.xsd">
</beans>
通过AnnotationConfigApplicationContext
来加载@Configuration
修饰的类,如下:
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean.class);
此时ConfigBean类中没有任何内容,相当于一个空的xml配置文件,此时我们要在ConfigBean类中注册bean,那么我们就要用到@Bean注解了。
@Configuration
使用步骤:
@Configuration
注解AnnotationConfigApplicationContext
容器来加@Configuration
注解修饰的类这个注解类似于bean xml配置文件中的bean元素,用来在spring容器中注册一个bean。
@Bean注解用在方法上,表示通过方法来定义一个bean,默认将方法名称作为bean名称,将方法返回值作为bean对象,注册到spring容器中。
如:
@Bean
public User user1() {
return new User();
}
@Bean注解还有很多属性,我们来看一下其源码:
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) //@1
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @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:说明这个注解可以用在方法和注解类型上面。 每个参数含义:
package com.javacode2018.lesson001.demo20;
public class User {
}
package com.javacode2018.lesson001.demo20;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public 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个别名:[user3BeanAlias1,user3BeanAlias2]
@Bean({"user3Bean", "user3BeanAlias1", "user3BeanAlias2"})
public User user3() {
return new User();
}
}
上面通过@Bean注解定义了3个bean,比较简单
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对象
bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@3bd82cf5
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@544fa968
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@247bddad
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@d35dea7
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@7770f470
bean名称:configBean,别名:[],bean对象:com.javacode2018.lesson001.demo20.ConfigBean$$EnhancerBySpringCGLIB$$dde45976@5e5d171f
bean名称:user1,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@24313fcc
bean名称:user2Bean,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@7d20d0b
bean名称:user3Bean,别名:[user3BeanAlias2, user3BeanAlias1],bean对象:com.javacode2018.lesson001.demo20.User@77f1baf5
上面的输出,我们主要关注与最后4行,前面的可以先忽略。 从输出中可以看出,有个名称为
configBean
的bean,正是ConfigBean这个类型,可以得出,被@Configuration修饰的类,也被注册到spring容器中了 最后3行输出就是几个User的bean对象了。
上面的用法应该很多人都比较熟悉,下面的属于重点了。
我们来看一下没有@Configuration的时候,什么效果。
内容和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个别名:[user3BeanAlias1,user3BeanAlias2]
@Bean({"user3Bean", "user3BeanAlias1", "user3BeanAlias2"})
public User user3() {
return new User();
}
}
代码类似于test1,给spring容器传递ConfigBean1
@Test
public 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@333291e3
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@479d31f3
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@40ef3420
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@498d318c
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@6e171cd7
bean名称:configBean1,别名:[],bean对象:com.javacode2018.lesson001.demo20.ConfigBean1@402bba4f
bean名称:user1,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@795cd85e
bean名称:user2Bean,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@59fd97a8
bean名称:user3Bean,别名:[user3BeanAlias2, user3BeanAlias1],bean对象:com.javacode2018.lesson001.demo20.User@f5ac9e4
我们将2个输出的最后4行拿来对比一下:
bean名称:configBean,别名:[],bean对象:com.javacode2018.lesson001.demo20.ConfigBean$$EnhancerBySpringCGLIB$$dde45976@5e5d171f
bean名称:user1,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@24313fcc
bean名称:user2Bean,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@7d20d0b
bean名称:user3Bean,别名:[user3BeanAlias2, user3BeanAlias1],bean对象:com.javacode2018.lesson001.demo20.User@77f1baf5
bean名称:configBean1,别名:[],bean对象:com.javacode2018.lesson001.demo20.ConfigBean1@402bba4f
bean名称:user1,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@795cd85e
bean名称:user2Bean,别名:[],bean对象:com.javacode2018.lesson001.demo20.User@59fd97a8
bean名称:user3Bean,别名:[user3BeanAlias2, user3BeanAlias1],bean对象:com.javacode2018.lesson001.demo20.User@f5ac9e4
EnhancerBySpringCGLIB
的字样,而没有@Configuration注解的bean没有Cglib的字样;有EnhancerBySpringCGLIB
字样的说明这个bean被cglib处理过的,变成了一个代理对象。目前为止我们还是看不出二者本质上的区别,继续向下看。
通常情况下,bean之间是有依赖关系的,我们来创建个有依赖关系的bean,通过这个案例你就可以看出根本的区别了。
定义2个类。
package com.javacode2018.lesson001.demo20;
public class ServiceA {
}
package 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类管理上面对象。
package com.javacode2018.lesson001.demo20;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public 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次?
@Test
public 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@77f1baf5
bean名称:serviceA,别名:[],bean对象:com.javacode2018.lesson001.demo20.ServiceA@41a2befb
bean名称:serviceB1,别名:[],bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@41a2befb}
bean名称:serviceB2,别名:[],bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.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@6e171cd7
bean名称:serviceA,别名:[],bean对象:com.javacode2018.lesson001.demo20.ServiceA@402bba4f
bean名称:serviceB1,别名:[],bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@795cd85e}
bean名称:serviceB2,别名:[],bean对象:ServiceB{serviceA=com.javacode2018.lesson001.demo20.ServiceA@59fd97a8}
spring中用下面这个类处理@Configuration这个注解:
org.springframework.context.annotation.ConfigurationClassPostProcessor
这里面重点关注这几个方法:
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory)
最后一个方法会创建cglib代理,大家可以设置断点进去看看,有问题欢迎交流。
链接:https://pan.baidu.com/s/1p6rcfKOeWQIVkuhVybzZmQ
提取码:zr99