spring4.1.8 扩展实战之八:Import 注解
欢迎访问我的 GitHub
这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos
在 spring 框架下做开发时,@Import 是常见的注解,可以用来动态创建 bean,今天我们先从源码分析原理,再用实战来验证 Import 的作用;
文章概览
本章由以下几部分组成:
从 Enable 前缀的注解谈起,揭示常见的 Enable 注解与 Import 注解的关系;
常见的四种 Import 注解用法列举;
分析 spring 源码,揭示 Import 注解的工作原理;
官方 API 文档中的疑问解答;
实战通过 Import 注解动态创建 bean 实例;
从 Enable 前缀的注解谈起
有很多注解都以 Enable 为前缀,例如配置异步调用的注解 EnableAsync,其源码如下 :
从以上代码可见,使异步调用生效的关键是**@Import(AsyncConfigurationSelector.class)**,通过此注解 spring 容器会创建 AsyncConfigurationSelector 实例并调用其 selectImports 方法,完成异步调用相关的配置;
再多看几个 Enable 前缀的注解的源码,例如 EnableBatchProcessing、EnableCaching、EnableDiscoveryClient 等,也都是通过 Import 来生效的,这种方式值得我们学习,在业务开发中也能用类似方式来对 bean 实例做控制;
常见的四种 Import 注解用法列举
在 @Import 注解的参数中可以填写类名,例如**@Import(Abc.class)**,根据类 Abc 的不同类型,spring 容器有以下四种处理方式:
如果 Abc 类实现了 ImportSelector 接口,spring 容器就会实例化 Abc 类,并且调用其 selectImports 方法;
DeferredImportSelector 是 ImportSelector 的子类,如果 Abc 类实现了 DeferredImportSelector 接口,spring 容器就会实例化 Abc 类,并且调用其 selectImports 方法,和 ImportSelector 的实例不同的是,DeferredImportSelector 的实例的 selectImports 方法调用时机晚于 ImportSelector 的实例,要等到 @Configuration 注解中相关的业务全部都处理完了才会调用(具体逻辑在 ConfigurationClassParser.processDeferredImportSelectors 方法中),想了解更多 DeferredImportSelector 和 ImportSelector 的区别,请参考《ImportSelector 与 DeferredImportSelector 的区别(spring4) 》
如果 Abc 类实现了 ImportBeanDefinitionRegistrar 接口,spring 容器就会实例化 Abc 类,并且调用其 registerBeanDefinitions 方法;
如果 Abc 没有实现 ImportSelector、DeferredImportSelector、ImportBeanDefinitionRegistrar 等其中的任何一个,spring 容器就会实例化 Abc 类,官方说明在这里;
分析 spring 源码,揭示 Import 注解的工作原理
接下来通过 spring 源码来了解 spring 容器是如何处理 Import 注解的;
先看 spring 容器的初始化代码,定位 AbstractApplicationContext 类的 refresh 方法,里面会调用 invokeBeanFactoryPostProcessors 方法,如下图红框所示:
展开 invokeBeanFactoryPostProcessors 方法,继续追踪到了 PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors 方法,具体操作如下图红框所示:
对于上图分析的调用 invokeBeanDefinitionRegistryPostProcessors 方法时作为入参传入的 bean,ConfigurationClassPostProcessor 类的实例是符合过滤要求的:既实现了 BeanDefinitionRegistryPostProcessor 接口,又实现了 PriorityOrdered 接口,因此,在 invokeBeanDefinitionRegistryPostProcessors 方法中,ConfigurationClassPostProcessor 类的 postProcessBeanDefinitionRegistry 方法被调用:
ConfigurationClassPostProcessor 类的 postProcessBeanDefinitionRegistry 方法中,如下图红框所示,processConfigBeanDefinitions 方法负责处理 @Configuration 注解相关的业务:
processConfigBeanDefinitions 方法代码如下,请注意中文注释:
看 ConfigurationClassParser 类的 parse 方法:
从上述代码中可以看出,DeferredImportSelector 实现类的 selectImports 方法会在最后被调用,其余的关键逻辑应该在**parse(AnnotationMetadata metadata, String beanName)**这个关键方法中,顺着这个方法一直追踪下去,直到 doProcessConfigurationClass 方法,如下图红框所示,所有 Import 注解的处理,都在 processImports 方法中:
processImports 方法中包含了对 ImportSelector 实现类和 ImportBeanDefinitionRegistrar 实现类的处理,以及未实现这些接口的类的处理,我们逐个来分析吧,首先看 ImportBeanDefinitionRegistrar 实现类的处理,如下图红框位置,调用 configClass.addImportBeanDefinitionRegistrar 方法将 ImportBeanDefinitionRegistrar 实现类存入 configClass 的成员变量 importBeanDefinitionRegistrars 中,后面的 ConfigurationClassPostProcessor 类的 processConfigBeanDefinitions 方法中,**this.reader.loadBeanDefinitions(configClasses);**会调用这些 ImportBeanDefinitionRegistrar 实现类的 registerBeanDefinitions 方法:
再来看 processImports 方法中对 ImportSelector 实现类的处理,这里略有些复杂,因为涉及到对 processImports 方法的迭代调用,请看下图红框旁边的红字说明:
如上图所示,第二步就是在 processImports 方法中调用了 processImports 方法,再次进入 processImports 之后,会着 ImportSelector 实现类返回的 bean 名称直接走到第三步的位置,第三步处理的就是没有实现 ImportSelector 和 ImportBeanDefinitionRegistrar 这些接口的普通 bean 了;
processImports 方法对没有实现 ImportSelector 和 ImportBeanDefinitionRegistrar 这些接口的普通 bean 的处理是执行 processConfigurationClass 方法,将这些 bean 放入了成员变量 configurationClasses 中,如下图红框所示:
processImports 方法分析完毕,Import 注解导入的 bean 都被保存在 ConfigurationClassParser 实例中,我们回到 ConfigurationClassPostProcessor 类的 processConfigBeanDefinitions 方法,如下图,**this.reader.loadBeanDefinitions(configClasses);**负责处理 processImports 方法找出的那些打算通过 @Import 注解来注册到 spring 容器的 bean:
展开 this.reader.loadBeanDefinitions(configClasses)方法,在 ConfigurationClassBeanDefinitionReader 类中,是对每个配置类逐个执行 loadBeanDefinitionsForConfigurationClass 方法:
展开方法,真相大白,实现了 ImportBeanDefinitionRegistrar 接口的实例,会执行其 registerBeanDefinitions 方法,其余普通的类,通过 loadBeanDefinitionsFromImportedResources 方法将其 bean 定义注册在 spring 环境:
前面将普通类、ImportBeanDefinitionRegistrar 实现类、ImportSelector 实现类的分析已经完成,对于 DeferredImportSelector 实现类的处理在 processDeferredImportSelectors 方法中,其实和 ImportSelector 实现类的处理并无区别,只是处理时机比起 ImportSelector 实现类略晚,这里就不多说了;
至此,通过 Import 注解注册 bean 的四种方式已经全部分析完毕,小结如下:
普通类(即没有实现 ImportBeanDefinitionRegistrar、ImportSelector、DeferredImportSelector 等接口的类)会通过 ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsFromImportedResources 方法将 bean 定义注册到 spring 容器;
ImportSelector 实现类,其 selectImports 方法返回的 bean 的名称,通过 ConfigurationClassParser 类的 asSourceClass 方法转成 SourceClass 对象,然后被当作普通类处理;
DeferredImportSelector 实现类的处理和 ImportSelector 实现类的处理并无区别,只是处理时机比起 ImportSelector 实现类略晚;
ImportBeanDefinitionRegistrar 实现类的 registerBeanDefinitions 方法会被调用,里面可以注册业务所需的 bean 定义;
官方 API 文档中的疑问解答
在官方API文档中,对 ImportSelector 接口的描述如下图所示,红框中的一段意思是:** ImportSelector 接口的实现类,如果同时也实现了 EnvironmentAware、BeanFactoryAware、BeanClassLoaderAware、ResourceLoaderAware 这些接口中的一个或几个,那么这些接口对应的方法优先执行,然后才会执行 ImportSelector 接口的 selectImports**:
上图红框中的描述会让我们不禁疑惑:spring 是如何做到的呢?一起来看源码吧:
再次打开 ConfigurationClassParser 类的 processImports 方法,如下图两个红框所示,对于 @Import 注解值中的类,只要实现了 ImportBeanDefinitionRegistrar、ImportSelector、DeferredImportSelector 等接口中的任何一个,都会调用 invokeAwareMethods 方法(如果实现的是 ImportSelector 或 DeferredImportSelector 接口,此时还没有执行 selectImports 方法):
展开 invokeAwareMethods 方法,真相大白,这里面检查是否实现了 EnvironmentAware、BeanFactoryAware、BeanClassLoaderAware、ResourceLoaderAware 等接口,如果实现了就调用对应的方法;
至此,源码分析工作已经结束,接下来实战 @Import 注解的使用;
实战通过 Import 注解动态创建 bean 实例
到了实战验证环节了,本次实战的内容是创建一个 springboot 工程,通过 @Import 注解将 bean 注册到 spring 容器,如果您不想敲代码,也可以去 github 下载源码,地址和链接信息如下表所示:
这个 git 项目中有多个文件夹,本章源码在文件夹 customizeimport 下,如下图红框所示:
下面动手开发:
设计:customizeimport 工程中,有四个接口(CustomizeService1,CustomizeService2,CustomizeService3,CustomizeService4,每个接口有个对应的实现类(CustomizeServiceImpl1、CustomizeServiceImpl2、CustomizeServiceImpl3、CustomizeServiceImpl4),在配置类通过 @Import 注解,用不同方式将这些实现类的实例注册到 spring 容器中,在一个 Controller 中验证这四个实例,实例的注册到 spring 容器方式规划如下表格所示:
创建 maven 工程 customizeimport,pom.xml 内容如下:
创建四个接口,除了类名不同,其他的都一样,如下:
创建接口实现类,除了类名不同,其他的都一样,如下:
创建 ImportSelector 接口的实现类 CustomizeImportSelector,其 selectImports 方法返回了 CustomizeServiceImpl2 的完整类名:
创建 DeferredImportSelector 接口的实现类 CustomizeDeferredImportSelector,其 selectImports 方法返回了 CustomizeServiceImpl3 的完整类名:
创建 ImportBeanDefinitionRegistrar 接口的实现类 CustomizeImportBeanDefinitionRegistrar,其 registerBeanDefinitions 方法中在 spring 容器注册了 CustomizeServiceImpl4 类的定义:
创建配置类 SysConfig,使用了 @Import 注解:
创建 Controller 类 HelloController ,用于验证 CustomizeService1 等接口的实例是否可用:
最后是启动类 CustomizeimportApplication:
启动应用,观察日志,可见 Import 的值都生效了,ImportSelector 的 selectImports 被调用,ImportBeanDefinitionRegistrar 的 registerBeanDefinitions 被调用,然后是 CustomizeServiceImpl1 等类的实例被创建,篇幅所限就不在此将所有日志贴出,请您自行运行和检查:
在浏览器输入:http://localhost:8080/hello,检查控制台日志,发现 CustomizeServiceImpl1 等的 execute 方法都被顺利执行,可见所有实例都在 spring 容器内:
至此,@Import 注解的源码分析和实战都完成了,该注解经常会用到,希望本文能帮您更加深入的了解这一功能,助您在开发和设计中对 bean 的注册和管理操作更加得心应手;
欢迎关注 InfoQ:程序员欣宸
版权声明: 本文为 InfoQ 作者【程序员欣宸】的原创文章。
原文链接:【http://xie.infoq.cn/article/b30c4496874e3c39ceaf3a3a8】。文章转载请联系作者。
评论