一、背景
我们自己开发了一个第三方的jar包,想和Spring整合起来,并注入到Spring容器中。自己的jar包中,需要加入到Spring容器的类上都加入了一个自定义注解@CustomImport(beanName="")
,beanName
属性的值表示需要注入到Spring容器中的名字。
二、实现方案
1、基于@ComponentScan注解实现
使用此种方案比较简单,直接使用@ComponentScan(includeFilters = {@ComponentScan.Filter(value = CustomImport.class)})
即可将我们自定义的注解加入到Spring容器中。 此种方案略。
2、基于ImportBeanDefinitionRegistrar和FactoryBean实现
1、实现此接口(ImportBeanDefinitionRegistrar
),可以将我们自己的BeanDefinition
对象加到BeanDefinitionRegistry
中,等待后续Spring初始化对象。
注:
1. 我们可以从自定义的注解中获取到一些属性,然后来个性化我们要初始化的Bean是什么样的。
2. 实现`ImportBeanDefinitionRegistrar`的类配合上`@Configuration`和`@Import`注解,可以在程序启动的时候加载这个类。
2、实现此接口(FactoryBean
),可以让我们自定义实例化出我们要构建的Bean。
3、注意
可能有些人会说,我用@ComponentScan就可以搞定的事情,为何还要选择基于第二种方法实现,这个不是多此一举吗?这个其实我主要是记录这样的一个思路。比如:Mybatis和Spring整合后,只需要申明一个@Mapper
就可以自定加入到Spring管理中(MapperScannerRegistrar
),那么这是怎么实现的呢?应该是和上方的方案2类似。
三、实现步骤
1、自定义一个注解 CustomImport
,被此注解标注的类,表示需要加入到Spring容器中。
- CustomImport 注解可以增加一些额外的属性,比如beanName表示注入到Spring容器时,bean的名字。
2、写一个类实现CustomImportFactoryBean
,表示如何实例化出CustomImport
注解标注的类。
- 构造化对象。
- 构造出的对象需要自己完成初始化操作,如果需要用到Spring的里的对象,可以获取到ApplicationContext然后获取注入。
3、写一个类实现ImportBeanDefinitionRegistrar
,扫描出所有的CustomImport
的类,然后构造出BeanDefinition
,加入到Spring容器中。
- 构造BeanDefinition时的BeanClass属性需要指定上一个的CustomImportFactoryBean的class。
- ClassPathBeanDefinitionScanner可以扫描包。
4、自定义一个注解EnableCustomImport
,启动类上加入此注解后,实现ImportBeanDefinitionRegistrar
的调用。
- 此注解上需要使用
@Import
标注
1、自定义注解CustomImport
/**
* 此注解标注的类也会自动加入到 Spring 管理中。
*
* @author huan.fu 2021/4/14 - 上午9:23
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CustomImport {
/**
* 这个bean注入到Spring容器中的名字
*/
String beanName();
}
2、实现CustomImportFactoryBean
构建对象
package com.huan.study.framewrok;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
/**
* 工厂Bean,用于构建 CustomImport 注解标注的类,如何进行实例化
*
* @author huan.fu 2021/4/14 - 上午9:44
*/
public class CustomImportFactoryBean implements FactoryBean