在Spring3.0之前,我们的bean一直通过XML文件来配置的,后来在Spring3.0之后为我们提供了java的config版本。而且在Spring4.0之后推荐我们使用,这篇文章基于Spring5.2来分析。希望在平时使用和面试的时候对你有一丝帮助。
一、实例演示
我们先给出一个例子,看看如何使用,然后再来分析。创建一个普通的maven项目。
第一步:添加pom依赖
org.springframework
spring-core
5.2.2.RELEASE
org.springframework
spring-beans
5.2.2.RELEASE
org.springframework
spring-context
5.2.2.RELEASE
org.junit.jupiter
junit-jupiter-api
5.3.2
test
这里面添加了最核心的依赖。
第二步:在bean包添加User类
public class User {
private Integer id;
private String name;
private String password;
public User() {
}
public User(Integer id, String name, String password) {
this.id = id;
this.name = name;
this.password = password;
}
//setter和getter方法
//toString方法
}
第三步:在service包添加UserService类
public class UserService {
public List queryAll(){
//创建一个新的list集合,用来承接数据,充当返回值
List users=new ArrayList();
//添加数据name,pass
for (int i=0;i<10;i++){
User user = new User();
user.setId(i);
user.setName("name==>"+i);
user.setPassword("pass==>"+i);
users.add(user);
}
return users;
}
}
注意这里没有@Service注解。目的就是我们自己注入。
第四步:在config包添加UserConfig类
@Configuration
public class UserConfig {
@Bean
public UserService userService(){
return new UserService();
}
}
这个类是核心,我们使用了俩注解,一个Configuration还有一个Bean。我们一会就看他俩的作用。
第五步:测试
之前我们已经添加了测试依赖。直接测试一波:
public class MyConfigTest {
@Test
public void test(){
//获取java配置类
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(UserConfig.class);
//获取ioc容器中的对象
UserService userService = (UserService) context.getBean("userService");
//调用方法
List query = userService.queryAll();
for (User user:query) {
System.out.println(user);
}
}
}
User{id=0, name='name==>0', password='pass==>0'}
...
User{id=8, name='name==>8', password='pass==>8'}
User{id=9, name='name==>9', password='pass==>9'}
这就是一个最基本的案例,实现起来非常的简单。下面我们着重分析一下这俩注解的作用,为什么能实现类似于Spring中XML文件一样的作用。
二、分析
1、注解角度分析
想要了解为什么@Configuration会有这样的作用,我们可以跟进去这个注解看看。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
@AliasFor(
annotation = Component.class
)
String value() default "";
boolean proxyBeanMethods() default true;
}
进去之后我们会发现,这个注解标签是一个元注解,由很多其他的注解实现,有一个我们应该很熟悉,那就是@Component,有着了这个注解就可以被@ComponentScan扫描并处理。Spring5.0已经自动扫描了,不需要我们自己再去添加了。现在我们进去到里面的代码看看:
首先是@AliasFor标签:
在Spring的众多注解中,经常会发现很多注解的不同属性起着相同的作用,比如@RequestMapping的value属性和path属性,这就需要做一些基本的限制,比如value和path的值不能冲突,比如任意设置value或者设置path属性的值,都能够通过另一个属性来获取值等等。为了统一处理这些情况,Spring创建了@AliasFor标签。
然后是value() :
意思是默认的值就是空,此时我们就可以指定@Configuration(value="属性值")的这种方式,因为只有一个value所以value可以省去不写。
最后是proxyBeanMethods:
有了 proxyBeanMethods 属性后,配置类不会被代理了。主要是为了提高性能,如果你的 @Bean 方法之间没有调用关系的话可以把 proxyBeanMethods 设置为 false。否则,方法内部引用的类生产的类和 Spring 容器中类是两个类。
3、运行角度分析
现在我们把目光转移,从测试运行的角度来分析。
//获取java配置类
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(UserConfig.class);
//获取ioc容器中的对象
UserService userService = (UserService) context.getBean("userService");
看到这里,可能就要深入到Spring的源码中看了。Spring容器启动时,ApplicationContext接口的实现类AnnotationConfigApplicationContext会执行refresh方法,往BeanFactory注册bean就在此方法完成。我们看到这个refresh是核心。我们进入到这个源码中看看:
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
//准备刷新的上下文 环境
prepareRefresh();
//初始化BeanFactory,并进行XML文件读取
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
//对beanFactory进行各种功能填充
prepareBeanFactory(beanFactory);
try {
//子类覆盖方法做额外处理
postProcessBeanFactory(beanFactory);
//激活各种beanFactory处理器
invokeBeanFactoryPostProcessors(beanFactory);
//注册拦截Bean创建的Bean处理器,这里只是注册,真正的调用实在getBean时候
registerBeanPostProcessors(beanFactory);
//为上下文初始化Message源,即不同语言的消息体,国际化处理
initMessageSource();
//初始化应用消息广播器,并放入“applicationEventMulticaster”bean中
initApplicationEventMulticaster();
...
}
...
}
}
我截取了其中一部分的源码,在里面有一个方法很关键,那就是invokeBeanFactoryPostProcessors,意思是我们Spring容器首先会初始化BeanFactory,然后激活各种beanFactory处理器,也就是执行invokeBeanFactoryPostProcessors,我们看看这个方法:
public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory,
List beanFactoryPostProcessors) {
Set processedBeans = new HashSet<>();
if (beanFactory instanceof BeanDefinitionRegistry) {
// 定义BeanDefinitionRegistryPostProcessor集合
List registryProcessors = new ArrayList<>();
// 循环手动注册的beanFactoryPostProcessors
for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) {
// 如果是BeanDefinitionRegistryPostProcessor的实例话,则调用其postProcessBeanDefinitionRegistry方法,对bean进行注册操作
if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) {
// 如果是BeanDefinitionRegistryPostProcessor类型,则直接调用其postProcessBeanDefinitionRegistry
BeanDefinitionRegistryPostProcessor registryProcessor = (BeanDefinitionRegistryPostProcessor) postProcessor;
registryProcessor.postProcessBeanDefinitionRegistry(registry);
registryProcessors.add(registryProcessor);
}
// 否则则将其当做普通的BeanFactoryPostProcessor处理,直接加入regularPostProcessors集合,以备后续处理
else {
regularPostProcessors.add(postProcessor);
}
}
}
else {
invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);
}
}
在这个方法的内部的核心是ConfigurationClassPostProcessor,这个方法看到@Configuration,就会开启类的加载,这里也就是bean的加载。剩下的越挖越深,源码也越来越深。大体步骤我们可以总结一下:
ConfigurationClassPostProcessor处理器解析@configuration配置类主要过程:
(1)Spring容器初始化时注册ConfigurationClassPostProcessor
(2)Spring容器初始化执行refresh()方法中调用ConfigurationClassPostProcessor
(3)ConfigurationClassPostProcessor处理器借助ConfigurationClassParser完成配置类解析
(4)ConfigurationClassParser配置内解析过程中完成嵌套的MemberClass、@PropertySource注解、@ComponentScan注解(扫描package下的所有Class并进行迭代解析,主要是@Component组件解析及注册)、@ImportResource、@Bean等处理
(5)接下来完成@Bean注册, @ImportResource指定bean的注册以及@Import的bean注册
(6)有@Bean注解的方法在解析的时候作为ConfigurationClass的一个属性,最后还是会转换成BeanDefinition进行处理, 而实例化的时候会作为一个工厂方法进行Bean的创建
现在大致应该明白了,其实一句话说完,还是想办法识别注解,完成和XML一样的功能。