美文网首页
SpringBoot动态注入Bean

SpringBoot动态注入Bean

作者: Zal哥哥 | 来源:发表于2021-01-31 17:37 被阅读0次

    目的:

    在程序运行期间,动态添加Bean进入到Spring容器。

    目前使用到的场景:

    对当当网的ElasticJob进行封装,通过自定义注解@ElasticJob的方式开启分布式定时任务。

    当所有的Bean都初始化完成之后,读取使用了@ElasticJob注解的所有Bean,然后创建SpringJobSchedule实例并添加到Spring容器中,实现任务的启动。

    实现方式:

    1.新建一个普通的Java类

    2.通过DefaultListableBeanFactory和BeanDefinitionBuilder实现Bean的动态注入

    @SpringBootApplication(scanBasePackages = {"org.example.*"}) 
    public class Application { public static void main(String[] args) {
            ConfigurableApplicationContext run = SpringApplication.run(Application.class);
            DefaultListableBeanFactory autowireCapableBeanFactory = (DefaultListableBeanFactory) run.getAutowireCapableBeanFactory();
            BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.rootBeanDefinition(Animal.class);
            beanDefinitionBuilder.addConstructorArgValue("喜鹊").addConstructorArgValue("绿色").addConstructorArgValue(3);
            String beanName = "AnimalAutoName"; //默认单例
            beanDefinitionBuilder.setScope("prototype");
            autowireCapableBeanFactory.registerBeanDefinition(beanName, beanDefinitionBuilder.getBeanDefinition());
            Object bean = run.getBean(beanName);
        }
    }
    

    流程:

    image

    在对Bean进行初始化设置时,是通过构造函数进行初始化(要按照构造函数参数顺序进行赋值)还是通过属性进行初始化或者是两者都可以,这完全取决于要动态注入的Bean。

    refer to:
    https://www.cnblogs.com/monument/p/12933915.html

    拓展理解

    我们通过getBean来获得对象,但这些对象都是事先定义好的,我们有时候要在程序中动态的加入对象.因为如果采用配置文件或者注解,我们要加入对象的话,还要重启服务,如果我们想要避免这一情况就得采用动态处理bean,包括:动态注入,动态删除。

    本节大纲 :

    (1)动态注入bean思路;
    (2)动态注入实现代码;
    (3)多次注入同一个bean的情况;
    (4)动态删除;
    
    

    接下来我们看下具体的内容:

    (1)动态注入bean思路;

    ​ 在具体进行代码实现的时候,我们要知道,Spring管理bean的对象是BeanFactory,具体的是DefaultListableBeanFactory,在这个类当中有一个注入bean的方法:registerBeanDefinition,在调用registerBeanDefinition方法时,需要BeanDefinition参数,那么这个参数怎么获取呢?Spring提供了BeanDefinitionBuilder可以构建一个BeanDefinition,那么我们的问题就是如何获取BeanFactory了,这个就很简单了,只要获取到ApplicationContext对象即可获取到BeanFacory了。

    (2)动态注入实现代码;

    综上所述,如果我们要编写一个简单里的例子的话,那么分以个几个步骤进行编码即可进行动态注入了:

    <1>. 获取ApplicationContext;
    <2>. 通过ApplicationContext获取到BeanFacotory;
    <3>. 通过BeanDefinitionBuilder构建BeanDefiniton;
    <4>. 调用beanFactory的registerBeanDefinition注入beanDefinition;
    <5>. 使用ApplicationContext.getBean获取bean进行测试;
    
    

    ​很明显我们需要先定义个类进行测试,比如TestService代码如下:

     package com.kfit.demo.service;  
     public class TestService {  
         private String name;  
         public String getName() {  
            return name;  
         }  
         public void setName(String name) {  
            this.name = name;  
         }  
         public void print(){  
            System.out.println("动态载入bean,name="+name);  
         }  
     }  
    注意:这里没有使用@Service和配置文件进行注入TestService。
    
    

    那么下面我们的目标就是动态注入TestService了,根据以上的分析,我们进行编码,具体代码如下:

    
    //获取context.  -- Angel -守护天使  
    ApplicationContext ctx =  (ApplicationContext) SpringApplication.run(App.class, args);  
    //获取BeanFactory  
    DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) ctx.getAutowireCapableBeanFactory();       
    //创建bean信息.  
    BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(TestService.class);  
    beanDefinitionBuilder.addPropertyValue("name","张三");          
    //动态注册bean.  
    defaultListableBeanFactory.registerBeanDefinition("testService", beanDefinitionBuilder.getBeanDefinition());  
    //获取动态注册的bean.  
    TestService testService =ctx.getBean(TestService.class);
    testService.print();  
    
    

    执行代码我们会在控制台看到如下打印信息:

    动态载入bean,name=张三
    
    

    ​ 到这里,就证明我们的代码很成功了。

    (3)多次注入同一个bean的情况;

    ​ 多次注入同一个bean的,如果beanName不一样的话,那么会产生两个Bean;如果beanName一样的话,后面注入的会覆盖前面的。

    第一种情况:beanName一样的代码:
    beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(TestService.class);  
    defaultListableBeanFactory.registerBeanDefinition("testService", beanDefinitionBuilder.getBeanDefinition());  
    TestService testService =ctx.getBean(TestService.class);
    testService.print();  
    
    

    运行看控制台: 动态载入bean,name=李四

    第二种情况:beanName不一样的代码:
    beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(TestService.class);  
    defaultListableBeanFactory.registerBeanDefinition("testService1", beanDefinitionBuilder.getBeanDefinition());  
    TestService testService =ctx.getBean(TestService.class);
    testService.print();  
    
    

    此时如果没有更改别的代码直接运行的话,是会报如下错误的:

    Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type [com.kfit.demo.service.TestService] is defined: expected single matching bean but found 2: testService1,testService 
    
    

    ​ 大体意思就是在getBean的时候,找到了两个bean,这时候就不知道要获取哪个了,所以在获取的时候,我们就要指定我们是要获取的testService还是testService1,只需要修改一句代码:

    将代码:

    TestService testService =ctx.getBean(TestService.class);
    
    

    修改为:

    TestService testService =ctx.getBean("testService");
    
    

    (4)动态删除;

    ​ 相对于动态注入,动态删除就很简单了,直接奉上代码:

     //删除bean.  
     defaultListableBeanFactory.removeBeanDefinition("testService"); 
    
    

    拓展参考:

    https://412887952-qq-com.iteye.com/blog/2348445

    相关文章

      网友评论

          本文标题:SpringBoot动态注入Bean

          本文链接:https://www.haomeiwen.com/subject/ruprtltx.html