ImportBeanDefinitionRegistrar接口的使用和动态注册bean及自己写一个注解实现@Component的功能

亦凉 2023-08-17 15:53 9阅读 0赞

### 前言 ###

ImportBeanDefinitionRegistrar类只能通过其他类@Import的方式来加载，通常是启动类或配置类。

我们新建一个产品接口：

/**
     * @author: xie fei
     */
    public interface ProductService {
        void execute();
    }

在写一个产品实现类，注意这里我们没有添加@Service

/**
     * @author: xie fei
     */
    public class ProductServiceImpl implements ProductService {
        @Override
        public void execute() {
            System.out.println("ProductServiceImpl------------------");
        }
    }

新增一个DynamicImportBeanDefinitionRegistrar类实现ImportBeanDefinitionRegistrar。这里还可以实现一些aware，例如EnvironmentAware获取环境变量。

/**
     * @author: xie fei
     */
    public class DynamicImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, EnvironmentAware {
        @Override
        public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
            //扫描注解
            Map<String, Object> annotationAttributes = annotationMetadata.getAnnotationAttributes(ComponentScan.class.getName());
            String[] basePackages = (String[]) annotationAttributes.get("basePackages");
    
    //        ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);
    //        TypeFilter productServiceFilter = new AssignableTypeFilter(ProductService.class);
    //        scanner.addIncludeFilter(productServiceFilter);
    //        for (String p : basePackages) {
    //            scanner.findCandidateComponents(p).forEach(beanDefinition -> {
    //                registry.registerBeanDefinition(beanDefinition.getBeanClassName(), beanDefinition);
    //            });
    //        }
    
            //扫描类
            ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(registry, false);
            TypeFilter productServiceFilter = new AssignableTypeFilter(ProductService.class);
    
            scanner.addIncludeFilter(productServiceFilter);
            scanner.scan(basePackages);
    
        }
    
        @Override
        public void setEnvironment(Environment environment) {
            System.out.println(environment.getProperty("JAVA_HOME"));
        }

最后定义一个配置类发现一下上面的ImportBeanDefinitionRegistrar实现类

/**
     * @author: xie fei
     */
    @Configuration
    @ComponentScan("com.zoo.javalearn.ImportBeanDefinitionRegistrar")
    @Import(DynamicImportBeanDefinitionRegistrar.class)
    public class Configurations {
    }

测试：

/**
     * @author: xie fei
     */
    @RestController
    public class DynamicImportBeanDefinitionRegistrarController {
    
        @Resource
        private ProductService productService;
    
        @RequestMapping("/importBeanDefinitionRegistrar")
        public void test() {
            productService.execute();
        }
    }

可以看到已经有这个bean了，控制台也打印了信息。

### 自己写一个注解实现@Component的功能 ###

目标：自己写一个注解@AddBean，配合其他类，实现被注解类可以被注册成bean的功能。

/**
     * @author: xie fei
     */
    @Documented
    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
    public @interface AddBean {
    }

新增MyClasssPathBeanDefinitionScanner类，注册条件过滤器，将@AddBean注解加入允许扫描的过滤器中。

/**
     * @author: xie fei
     */
    public class MyClasssPathBeanDefinitionScanner extends ClassPathBeanDefinitionScanner {
        public MyClasssPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) {
            super(registry, useDefaultFilters);
        }
    
        /**
         * 注册条件过滤器，将@AddBean注解加入允许扫描的过滤器中，如果加入排除扫描的过滤器集合excludeFilter中，则不会扫描
         **/
        protected void registerFilters() {
            addIncludeFilter(new AnnotationTypeFilter(AddBean.class));
        }
    
        @Override
        protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
            return super.doScan(basePackages);
        }
    }

AutoConfiguredMyBatisRegistrar并实现ImportBeanDefinitionRegistrar接口，重写registerBeanDefinitions方法，手动注册bean；同时实现一些Aware接口，以便获取Spring的一些数据。

/**
     * @author: xie fei
     */
    public class AutoConfiguredMyBatisRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, BeanFactoryAware {
        private ResourceLoader resourceLoader;
        private BeanFactory beanFactory;
        @Override
        public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
            this.beanFactory=beanFactory;
        }
    
        @Override
        public void setResourceLoader(ResourceLoader resourceLoader) {
            this.resourceLoader=resourceLoader;
        }
    
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            MyClasssPathBeanDefinitionScanner scanner= new MyClasssPathBeanDefinitionScanner(registry,false);
            scanner.setResourceLoader(resourceLoader);
            scanner.registerFilters();
            scanner.doScan("com.zoo.javalearn.ImportBeanDefinitionRegistrar");
        }
    }

测试：

/**
     * @author: xie fei
     */
    @AddBean
    public class ProductServiceImpl implements ProductService {
        @Override
        public void execute() {
            System.out.println("ProductServiceImpl------------------");
        }
    }

去掉之前的配置，加上注解，测试控制台正常打印