[Java知识库]Springboot自定义@Import自动装配

学习Springboot，一定会了解一些自动装配的注解，但很少有机会自己去搞一些自动装配的东西。有一些公司会封装自己的boot开发组件，例如公司封装了对数据的管控、对开源框架的二开等，新员工在使用时，会花大量的时间学习这些组件，浪费大量的资源，但是这些组件通常情况下，配置参数都是默认即可。如何去屏蔽这些内容，让开发者仅关注业务即可？
我给三个方案，1.封装这些组件的时候，仅可能的简化配置；2.将这些组件做成模板化，通过脚手架生成项目的方式，屏蔽这些配置；3.封装自动配置，开发者仅用一个注解即可完成自动装配。
实现自动装配，可以通过ImportSelector或者ImportBeanDefinitionRegistrar来完成。本博客就讲一下如何开发自动配置的组件。

源码

获取源码
这个源码只是简单的两个示例，接下来会有实战（要屏蔽掉一些内容才可以和大家见面）

方式一：实现ImportSelector

步骤1:实现ImportSelector

实现ImportSelector#selectImports方法，这个方法可以返回String数组，Spring会自动将数组种相关的类注册到IOC容器中。

/**
 * 实现 ImportSelector#selectImports，返回需要装配的类的名称
 */
public class BeanImportSelector implements ImportSelector {

    /**
     * 自动装配注册bean到IOC容器
     *
     * @param importingClassMetadata
     * @return
     */
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{
                BeanConf.class.getName()
        };
    }
}

步骤2:自定义Enable*

自定义Enable*，并添加@Import注解，value可以指定带有@Configuration注解的配置配、实现了ImportSelector接口的类、实现了ImportBeanDefinitionRegistrar的类等，这样Spring启动时，会初始化value指定的内容。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(value = BeanImportSelector.class)
public @interface EnableBeanSelector {
}

方式二：实现ImportBeanDefinitionRegistrar

方式一给我的感觉是太简单，不能做更多的扩展。方式二可以手动注册一些对象到Spring IOC。

步骤1:实现ImportBeanDefinitionRegistrar

我见过的一些中间件，基本上都是这样注册相关的bean的，因为这种方式功能强大，例如Apollo配置中心。

/**
 * ImportBeanDefinitionRegistrar比ImportSelector功能强大
 */
public class BeanRegistrar implements ImportBeanDefinitionRegistrar {

    /**
     * 手动注册bean到IOC容器
     *
     * @param importingClassMetadata
     * @param registry
     */
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        AnnotationAttributes annotationAttributes = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(EnableBeanRegistrar.class.getName()));
        String name = "";
        if (annotationAttributes != null) {
            name = annotationAttributes.getString("value");
        }
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(Teacher.class.getName());
        builder.addPropertyValue("name", name);
        registry.registerBeanDefinition("teacher", builder.getBeanDefinition());
    }
}

步骤2:自定义Enable*

同方式一的步骤2。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(value = BeanRegistrar.class)
public @interface EnableBeanRegistrar {
    String value();
}

测试

详见源码。