ImportBeanDefinitionRegistrar向容器中注册bean

一、ImportBeanDefinitionRegistrar

我们先来看看ImportBeanDefinitionRegistrar是个什么鬼，点击进入ImportBeanDefinitionRegistrar源码，如下所示。

public interface ImportBeanDefinitionRegistrar {default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,BeanNameGenerator importBeanNameGenerator) {registerBeanDefinitions(importingClassMetadata, registry);}default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {}
}

由源码可以看出，ImportBeanDefinitionRegistrar本质上是一个接口。在ImportBeanDefinitionRegistrar接口中，有一个registerBeanDefinitions()方法，通过registerBeanDefinitions()方法，我们可以向Spring容器中注册bean实例。Spring官方在动态注册bean时，大部分套路其实是使用ImportBeanDefinitionRegistrar接口。所有实现了该接口的类都会被ConfigurationClassPostProcessor处理，ConfigurationClassPostProcessor实现了BeanFactoryPostProcessor接口，进一步实现了BeanDefinitionRegistryPostProcessor。该接口主要功能是参与BeanFactory的建造，主要功能如下：解析加了@Configuration的配置类解析@ComponentScan扫描的包解析@ComponentScans扫描的包，解析@Bean,@Import ,@PreopertySource。所以ImportBeanDefinitionRegistrar中动态注册的bean是优先于依赖其的bean初始化的，也能被aop、validator等机制处理。

实现了ImportBeanDefinitionRegistrar的类，在refresh的invokeBeanFactoryPostProcessors阶段，调用到最后，会调用到registerBeanDefinitios

ImportBeanDefinitionRegistrar调用链

二、使用方法

ImportBeanDefinitionRegistrar需要配合@Import注解，@Import注解导入实现了ImportBeanDefinitionRegistrar接口的类。

ImportBeanDefinitionRegistrar实例

既然ImportBeanDefinitionRegistrar是一个接口，那我们就创建一个MyImportBeanDefinitionRegistrar类，实现ImportBeanDefinitionRegistrar接口，如下所示。

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar{/*** AnnotationMetadata: 当前类的注解信息* BeanDefinitionRegistry：BeanDefinition注册类* 通过调用BeanDefinitionRegistry接口的registerBeanDefinition()方法，可以将所有需要添加到容器中的bean注入到容器中。*/@Overridepublic void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {boolean dao1= registry.containsBeanDefinition("com.myImportBeanDefinitionRegistrar.MyDao1");boolean dao2= registry.containsBeanDefinition("com.myImportBeanDefinitionRegistrar.MyDao2");if (dao2 && dao1){BeanDefinition beanDefinition = new RootBeanDefinition(MyDao3.class);registry.registerBeanDefinition("myDao3", beanDefinition);}}
}

public class MyDao(1/2/3) {public void query(){System.out.println("query MyDao for MyImportSelect");}
}

@Import({MyDao1.class,MyDao2.class})
@EnableMyImportBeanDefinitionRegistrar
public class AppConfig {}@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MyImportBeanDefinitionRegistrar.class)
public @interface EnableMyImportBeanDefinitionRegistrar {}public class MyTest {public static void main(String[] args) {AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);Arrays.stream(ctx.getBeanDefinitionNames()).toList().forEach(System.out::println);}
}

通过EnableMyImportBeanDefinitionRegistrar 注解，我们根据条件判断，动态引入了MyDao3.class

三、大部分框架的套路也如此

openFeign

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(FeignClientsRegistrar.class)
public @interface EnableFeignClients {}FeignClientsRegistrar实现了ImportBeanDefinitionRegistrar接口

mybatis

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({MapperScannerRegistrar.class})
@Repeatable(MapperScans.class)
public @interface MapperScan {}MapperScannerRegistrar实现了ImportBeanDefinitionRegistrar接口

也有的是实现importSelector接口，通过返回一个包含类名的数组进行注入的

参考文章