SpringBoot之@Import注解(Registrar使用)

目标

仿照OpenFegin向SpringIOC容器中添加一些服务类或工具，这里我们需要实现

1. 定义一个全局注解用来控制Registrar，@EnableUserImport(类似@EnableFeignClients)
2. 定义一个客户端注解控制需要提供需要注入的信息，@User(类似@FeignClient)
3. 创建一个Registrar用来实现真正的注册bean逻辑，MyUserRegister类似(FeignClientsRegistrar)

实现

1. 创建全局注解@EnableUserImport

   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.TYPE)
   @Import(MyUserRegister.class) // 导入Registrar最终会执行其中的registerBeanDefinitions()方法
   @Configuration // 有了这个注解外部使用UserImport这个注解的类不用再添加了
   public @interface EnableUserImport {
       String scanPackage(); // 扫描哪个包下的带有@User注解的类
   }
   

2. 创建@User注解，包含两个属性，名称，年龄，后续我们会使用这些属性来注册对应的bean

   @Target(ElementType.TYPE)
   @Retention(RetentionPolicy.RUNTIME)
   public @interface User {
       String name();
       int age();
   }
   

   2.1. 新建三个类并添加@User注解(不同的包下添加三个类，用于测试@EnableUserImport注解的scanPackage属性是否起作用)

   2.1.1 Zhangsan，Lisi两个类加入到包com.elitetyc.jpa.scanner.users下：

   @User(name = "李四",age=18)
   @AllArgsConstructor
   @Data
   public class Lisi {
       private String name;
       private int age;
   }
   
   @User(name = "张三",age = 30)
   @AllArgsConstructor
   @Data
   public class Zhangsan{
       private String name;
       private int age;
   }
   

   2.1.2 Wangwu类添加到包com.elitetyc.jpa.scanner.users1下：

   @User(name = "王五",age=100)
   @AllArgsConstructor
   @Data
   public class Wangwu {
       private String name;
       private int age;
   }
   

3. 创建Registrar用来实现具体注册bean的操作

   public class MyUserRegister implements ImportBeanDefinitionRegistrar, EnvironmentAware {
   
       Environment environment;
   
       /**
        * 实现类ImportBeanDefinitionRegistrar后需要实现的方法，如果你想在springIoc容器中注入一些工具，就可以在方法中进行实现
        * @param metadata
        * @param registry
        */
       @Override
       public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
           // 1.创建一个扫描器
           final ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false, environment){
               @Override
               protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
                   boolean isCandidate = false;
                   // 1.1. 类是否独立
                   if (beanDefinition.getMetadata().isIndependent()){
                       // 1.2. 是不是一个注解
                       if (!beanDefinition.getMetadata().isAnnotation()){
                           isCandidate = true;
                       }
                   }
                   return isCandidate;
               }
           };
           // 2.包含过滤器
           scanner.addIncludeFilter(new AnnotationTypeFilter(User.class));
           //scanner.addExcludeFilter(new AnnotationTypeFilter(User.class));
   
           // 3.获取导入这个类的注解信息
           final Map valueMap = metadata.getAnnotationAttributes(EnableUserImport.class.getName());
           // 4.使用扫描器扫描指定包下面的类
           final Set scanPackage = scanner.findCandidateComponents((String) Objects.requireNonNull(valueMap.get("scanPackage")));
           for (BeanDefinition beanDefinition : scanPackage) {
               // 这一步其实是不用判断的，因为我们扫描的就是User这个注解注解的类
               if (beanDefinition instanceof AnnotatedBeanDefinition){
                   final Map userAnnoMap = ((AnnotatedBeanDefinition) beanDefinition).getMetadata().getAnnotationAttributes(User.class.getName());
                   final String name = (String) userAnnoMap.get("name");
                   final int age = (Integer) userAnnoMap.get("age");
                   System.out.printf("注入用户:%s---年龄%d%n",name,age);
                   // 5. 通过注解信息构造一个bean定义放到spring IOC容器中
                   BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(beanDefinition.getBeanClassName());
                   // 5.1 添加构造函数的参数
                   builder.addConstructorArgValue(name);
                   builder.addConstructorArgValue(age);
                   registry.registerBeanDefinition(beanDefinition.getBeanClassName()+"."+ IdUtil.fastSimpleUUID(),builder.getBeanDefinition());
               }
           }
       }
   
       @Override
       public void setEnvironment(Environment environment) {
           this.environment = environment;
       }
   
   
   }
   

   描述：

   • 1.创建扫描器，参数1表示是否使用默认的过滤器，默认的过滤器即是使用@Component注解的扫描过滤器，这里传入false，我们需要使用自己的过滤器，参数2为环境变量，我们使用类实现接口EnvironmentAware获取到环境变量

     1.1. 判断类是否独立，具体解释查看java中的5中class

     1.2. 判断不是一个注解，如果将User注解再另一个注解上，我们当然也不需要处理

   • 2.添加包含过滤器，这里添加了一个注解式过滤器，意思是只要类上面有User这个注解就说明使我们需要的类，类似的还有不包含过滤器，也就是包含这个注解我们就不要它

   • 3.通过方法传入的metadata获取@EnableUserImport这个注解的信息，metadata就是添加了@EnableUserImport这个注解的类信息(后面我们会新增一个ScannerConfig类来添加@EnableUserImport注解)

   • 4.通过扫描器扫描指定包下面的类，这里也就是@EnableUserImport下的scanPackage属性

   • 5.扫描出的类都是指定包下带有@User注解的类，在通过BeanDefinitionBuilder.genericBeanDefinition(传递带有@User注解类的全类名);构建了一个构造器

     5.1 因为我这里添加的@User注解的类都有一个包含两个参数的构造器，一个name，一个age，所有使用构造器添加构造函数的参数，最后使用registry.registerBeanDefinition 注册一个Bean的定义信息，后续springBoot会通过反射调用指定类的构造器创建对象，添加到ioc容器中

验证

经过上面的实现，现在需要进行验证

1. 创建ScannerConfig添加全局控制注解

   @EnableUserImport(scanPackage = "com.elitetyc.jpa.scanner.users") // 指定扫描的包
   public class ScannerConfig {
   
   }
   

2. 创建UserService类，注入三个用户

   @Service("userService1")
   @Slf4j
   public class UserService implements InitializingBean { // 实现InitializingBean 当这个bean的属性都被设置后，会调用afterPropertiesSet（）方法，我们再里面进行一个输出
   
       @Autowired(required = false)
       Zhangsan zhangsan;
   
       @Autowired(required = false)
       Lisi lisi;
   
       @Autowired(required = false)
       Wangwu wangwu;
   
       @Override
       public void afterPropertiesSet() {
           log.error(zhangsan==null?"zhangsan is null":zhangsan.toString());
           log.error(lisi==null?"lisi is null":lisi.toString());
           log.error(wangwu==null?"wangwu is null":wangwu.toString());
       }
   }
   

运行

启动项目，打印输出如下：

注入用户:李四---年龄18
注入用户:张三---年龄30
2021-09-01 10:40:20.056 ERROR 23984 --- [           main] c.e.jpa.scanner.service.UserService      : Zhangsan(name=张三, age=30)
2021-09-01 10:40:20.056 ERROR 23984 --- [           main] c.e.jpa.scanner.service.UserService      : Lisi(name=李四, age=18)
2021-09-01 10:40:20.056 ERROR 23984 --- [           main] c.e.jpa.scanner.service.UserService      : wangwu is null

修改ScannerConfig中的扫描地址为@EnableUserImport(scanPackage = "com.elitetyc.jpa.scanner.users1")

注入用户:王五---年龄100
2021-09-01 09:55:48.708 ERROR 27916 --- [           main] c.e.jpa.scanner.service.UserService      : zhangsan is null
2021-09-01 09:55:48.708 ERROR 27916 --- [           main] c.e.jpa.scanner.service.UserService      : lisi is null
2021-09-01 09:55:48.708 ERROR 27916 --- [           main] c.e.jpa.scanner.service.UserService      : Wangwu(name=王五, age=100)