Spring动态生成Bean的定义-BeanDefinition源码解析

BeanFactoryPostProcessor
BeanDefinitionRegistryPostProcessor
ImportBeanDefinitionRegistrar

有的时候,我们需要在spring运行的时候,根据需要 动态添加之前没有定义的spring的bean,比如mybatis扫描某个包下的接口,转化为Mapper Bean。

Bean的定义在Spring中的组件名叫:BeanDefinition。
当我们创建了一个BeanDefinion后可以通过BeanDefinitionRegistry接口(ApplicationContext会实现此接口)将新的BeanDefinition注册到spring上下文中。
void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)

BeanFactoryPostProcessor(Bean工厂的后置处理器)

这个接口的作用是在Spring上下文的注册Bean定义的逻辑都跑完后,但是所有的Bean都还没真正实例化之前调用。
void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;
这个方法的主要用途就是通过注入进来的BeanFactory,在真正初始化Bean之前,再对spring上下文做一些动态修改。增加或者修改某些Bean定义的值,甚至再动态创建一些BeanDefinition都可以。
Demo:

@Override
  public void postProcessBeanFactory(final ConfigurableListableBeanFactory beanFactory) throws BeansException {
    GenericBeanDefinition beanDefinition = getGenericBeanDefinition();

    ((DefaultListableBeanFactory) beanFactory)
        .registerBeanDefinition("dynamicUser", beanDefinition);
  }
private GenericBeanDefinition getGenericBeanDefinition() {
    GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
    beanDefinition.setBeanClass(User.class);
    beanDefinition.getPropertyValues().add("name", "张三");
    return beanDefinition;
  }

BeanDefinitionRegistryPostProcessor(Bean注册器的后置处理器)

如上我们可以定义一个有关User这个Bean的定义,并且预先设置此Bean的Name属性值是
“张三”,最后注册到beanFactory中。

有鉴于此,Spring特意提供了一个更具体的子接口BeanDefinitionRegistryPostProcessor
这个子接口的方法postProcessBeanDefinitionRegistry会被Spring先于postProcessBeanFactory这个方法执行。不过呢,其实这2个方法都是注入的spring的上下文,只不过声明类型不同罢了。所以可以做的事一模一样。

 private GenericBeanDefinition getGenericBeanDefinition() {
    GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
    beanDefinition.setBeanClass(User.class);
    beanDefinition.getPropertyValues().add("name", "张三");
    return beanDefinition;
  }

  @Override
  public void postProcessBeanDefinitionRegistry(final BeanDefinitionRegistry registry) throws BeansException {
    GenericBeanDefinition beanDefinition = getGenericBeanDefinition();
    registry.registerBeanDefinition("dynamicUser2",beanDefinition);
  }

最后调用此spring上下文得到这个2个Bean:

public static void main(String[] args)
    {
        ConfigurableApplicationContext ctx = SpringApplication.run(DemoApplication.class, args);
        User dynamicUser = ctx.getBean("dynamicUser", User.class);
        System.out.println(dynamicUser);
        User dynamicUser2 = ctx.getBean("dynamicUser2", User.class);
        System.out.println(dynamicUser2);
    }

BeanDefinitionBuilder

建造者模式去创建一个BeanDefinition。从2.5之后GenericBeanDefinition代替了原本的RootBeanDefinition和ChildBeanDefinition。我们通常使用GenericBeanDefinition就足够了。
我们通过Builder模式去设置BeanDefinition一些常用方法:

//设置Bean的构造函数传入的参数值
public BeanDefinitionBuilder addConstructorArgValue(Object value)
//设置构造函数引用其他的bean
public BeanDefinitionBuilder addConstructorArgReference(String beanName)
//设置这个bean的 init方法和destory方法
public BeanDefinitionBuilder setInitMethodName(String methodName) 
public BeanDefinitionBuilder setDestroyMethodName(String methodName) 
//设置单例/多例
public BeanDefinitionBuilder setScope(String scope) 
//设置是否是个抽象的BeanDefinition,如果为true,表明这个BeanDefinition只是用来给子BeanDefinition去继承的,Spring不会去尝试初始化这个Bean。
public BeanDefinitionBuilder setAbstract(boolean flag) 
//是否懒加载,默认是false
public BeanDefinitionBuilder setLazyInit(boolean lazy) 
//自动注入依赖的模式,默认不注入
public BeanDefinitionBuilder setAutowireMode(int autowireMode) 
//检测依赖。
public BeanDefinitionBuilder setDependencyCheck(int dependencyCheck) 

以上,参考资料:http://www.logicbig.com/tutorials/spring-framework/spring-core/bean-definition/

ImportBeanDefinitionRegistrar

这个接口的实现类的作用是当这个接口的实现类被@Import接口引入某个被标记了@Configuration的注册类时,可以得到这个类的所有注解,然后做一些动态注册Bean的事儿。
比如在使用spring cloud feign组件的时候,我们这些写的

@SpringBootApplication
@EnableFeignClients(basePackages = "newbie.yyf.service.api.api")
public class Application {

观察EnableFeignClients这个注解里面是不是就使用了
"@Import(FeignClientsRegistrar.class)"
而FeignClientsRegistrar就实现了ImportBeanDefinitionRegistrar接口,所以这个接口的实现:

    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata,
            BeanDefinitionRegistry registry) {
        registerDefaultConfiguration(metadata, registry);
        registerFeignClients(metadata, registry);
    }

这里面的AnnotationMetadata到底会包含什么呢?其实就是被Import标记的Application这个注册文件的所有注解。
我们可以通过拿到注解上的一些配置信息去动态生成BeanDefinition,如果你熟悉Feign的作用的话,你可以想到主要是Feign的客户端接口的Mock Bean,就像mybatis一样。


image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,997评论 19 139
  • Spring容器高层视图 Spring 启动时读取应用程序提供的Bean配置信息,并在Spring容器中生成一份相...
    Theriseof阅读 2,854评论 1 24
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,974评论 6 342
  • 雨落花娇 青墙黛瓦 小巷落寞的身影中 谁家的白衣少年陌上无双 粉面含娇俏佳人 春雨润物 璀璨欲滴 你是人间的四月天...
    高嘉缕阅读 336评论 0 1
  • 早上跑步,听专栏,听到一个词语:刻意避开。发现这个词很有意思。 刻意避开的意思,就是尽量避开在自己不擅长的领域做决...
    逄格亮阅读 492评论 0 1