spring boot 动态注入bean

方法一

SpringContextUtil

public class SpringContextUtil {
    private static ApplicationContext applicationContext;
    // 获取上下文
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }
    // 设置上下文
    public static void setApplicationContext(ApplicationContext applicationContext) {
        SpringContextUtil.applicationContext = applicationContext;
    }
    // 通过名字获取上下文中的 bean
    public static Object getBean(String name){
        return applicationContext.getBean(name);
    }
    // 通过类型获取上下文中的 bean
    public static Object getBean(Class<?> requiredType){
        return applicationContext.getBean(requiredType);
    }
}

启动类

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        ApplicationContext app =  SpringApplication.run(Application.class, args);
        SpringContextUtil.setApplicationContext(app);
    }
}

测试 bean

@Component
public class TestService {
    public String doService(String contxt){
        System.err.printf(contxt+"hello service");
        return  "hello service";
    }

}

// 无注入

public class TestController implements InitializingBean {
<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> <span class="hljs-title class_">TestService</span> testService;

<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-built_in">void</span> <span class="hljs-title function_">afterPropertiesSet</span>() throws <span class="hljs-title class_">Exception</span> {
    <span class="hljs-title class_">System</span>.<span class="hljs-property">out</span>.<span class="hljs-title function_">println</span>(<span class="hljs-string">"我是动态注册的你,不是容器启动的时候注册的你"</span>);
}

<span class="hljs-keyword">public</span> <span class="hljs-title class_">String</span> <span class="hljs-title function_">toAction</span>(<span class="hljs-params"><span class="hljs-built_in">String</span> content</span>){
    <span class="hljs-keyword">return</span> <span class="hljs-string">"--&gt;"</span> +  testService.<span class="hljs-title function_">doService</span>(content);
}

}

测试

@RestController
public class CallCSBController {
<span class="hljs-meta">@GetMapping("/bean")</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">registerBean</span><span class="hljs-params">()</span> {
    <span class="hljs-comment">//将applicationContext转换为ConfigurableApplicationContext</span>
    <span class="hljs-type">ConfigurableApplicationContext</span> <span class="hljs-variable">configurableApplicationContext</span> <span class="hljs-operator">=</span> (ConfigurableApplicationContext) SpringContextUtil.getApplicationContext();

    <span class="hljs-comment">// 获取bean工厂并转换为DefaultListableBeanFactory</span>
    <span class="hljs-type">DefaultListableBeanFactory</span> <span class="hljs-variable">defaultListableBeanFactory</span> <span class="hljs-operator">=</span> (DefaultListableBeanFactory) configurableApplicationContext.getBeanFactory();

    <span class="hljs-comment">// 通过BeanDefinitionBuilder创建bean定义</span>
    <span class="hljs-type">BeanDefinitionBuilder</span> <span class="hljs-variable">beanDefinitionBuilder</span> <span class="hljs-operator">=</span> BeanDefinitionBuilder.genericBeanDefinition(TestController.class);

    <span class="hljs-comment">// 设置属性userService,此属性引用已经定义的bean:userService,这里userService已经被spring容器管理了.</span>

// beanDefinitionBuilder.addPropertyReference("testService", "testService");

    <span class="hljs-comment">// 注册bean</span>
    defaultListableBeanFactory.registerBeanDefinition(<span class="hljs-string">"testController"</span>, beanDefinitionBuilder.getRawBeanDefinition());


    <span class="hljs-type">TestController</span> <span class="hljs-variable">userController</span> <span class="hljs-operator">=</span> (TestController) SpringContextUtil.getBean(<span class="hljs-string">"testController"</span>);

    <span class="hljs-keyword">return</span> userController.toAction(<span class="hljs-string">"动态注册生成调用"</span>);

    <span class="hljs-comment">//删除bean.</span>
    <span class="hljs-comment">//defaultListableBeanFactory.removeBeanDefinition("testService");</span>
}

}

以上参考
链接:https://www.jianshu.com/p/41c716e7c31b

方法二 (略有不同)

工具类

package com.theeternity.beans.applicationContextRegister;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**

  • @program: apiboot

  • @description: 获取 ApplicationContext, 实现动态注入 bean

  • @author: TheEternity Zhang

  • @create: 2019-06-22 12:15
    /
    @Component
    @Slf4j
    public class ApplicationContextRegister implements ApplicationContextAware {
    private static ApplicationContext APPLICATION_CONTEXT;
    /
    *

    • 设置 spring 上下文
    • @param applicationContext spring 上下文
    • @throws BeansException
    • */
      @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
      log.debug("ApplicationContext registed-->{}", applicationContext);
      APPLICATION_CONTEXT = applicationContext;
      }

    /**

    • 获取容器
    • @return
      */
      public static ApplicationContext getApplicationContext() {
      return APPLICATION_CONTEXT;
      }

    /**

    • 获取容器对象
    • @param type
    • @param <T>
    • @return
      */
      public static <T> T getBean(Class<T> type) {
      return APPLICATION_CONTEXT.getBean(type);
      }

    public static <T> T getBean(String name,Class<T> clazz){
    return APPLICATION_CONTEXT.getBean(name, clazz);
    }

    public static Object getBean(String name){
    return APPLICATION_CONTEXT.getBean(name);
    }
    }

测试 bean

@Component
public class TestService {
    public String doService(String contxt){
        System.err.printf(contxt+"hello service");
        return  "hello service";
    }
}

// 无注入
public class TestController implements InitializingBean {

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> <span class="hljs-title class_">TestService</span> testService;

<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-built_in">void</span> <span class="hljs-title function_">afterPropertiesSet</span>() throws <span class="hljs-title class_">Exception</span> {
    <span class="hljs-title class_">System</span>.<span class="hljs-property">out</span>.<span class="hljs-title function_">println</span>(<span class="hljs-string">"我是动态注册的你,不是容器启动的时候注册的你"</span>);
}

<span class="hljs-keyword">public</span> <span class="hljs-title class_">String</span> <span class="hljs-title function_">toAction</span>(<span class="hljs-params"><span class="hljs-built_in">String</span> content</span>){
    <span class="hljs-keyword">return</span> <span class="hljs-string">"--&gt;"</span> +  testService.<span class="hljs-title function_">doService</span>(content);
}

}

测试

@RestController
public class CallCSBController {
<span class="hljs-operator">@</span>GetMapping(<span class="hljs-string">"/bean"</span>)
<span class="hljs-keyword">public</span> String registerBean() {
    <span class="hljs-comment">//将applicationContext转换为ConfigurableApplicationContext</span>
    ConfigurableApplicationContext configurableApplicationContext <span class="hljs-operator">=</span> (ConfigurableApplicationContext) ApplicationContextRegister.getApplicationContext();

    <span class="hljs-comment">// 获取bean工厂并转换为DefaultListableBeanFactory</span>
    DefaultListableBeanFactory defaultListableBeanFactory <span class="hljs-operator">=</span> (DefaultListableBeanFactory) configurableApplicationContext.getBeanFactory();

    <span class="hljs-comment">// 通过BeanDefinitionBuilder创建bean定义</span>
    BeanDefinitionBuilder beanDefinitionBuilder <span class="hljs-operator">=</span> BeanDefinitionBuilder.genericBeanDefinition(TestController.<span class="hljs-keyword">class</span>);

    <span class="hljs-comment">// 设置属性userService,此属性引用已经定义的bean:userService,这里userService已经被spring容器管理了.</span>

// beanDefinitionBuilder.addPropertyReference("testService", "testService");

    <span class="hljs-comment">// 注册bean</span>
    defaultListableBeanFactory.registerBeanDefinition(<span class="hljs-string">"testController"</span>, beanDefinitionBuilder.getRawBeanDefinition());


    TestController userController <span class="hljs-operator">=</span> (TestController) ApplicationContextRegister.getBean(<span class="hljs-string">"testController"</span>);

    <span class="hljs-keyword">return</span> userController.toAction(<span class="hljs-string">"动态注册生成调用"</span>);

    <span class="hljs-comment">//删除bean.</span>
    <span class="hljs-comment">//defaultListableBeanFactory.removeBeanDefinition("testService");</span>
}
第一种方法的另外一种形式
<span class="hljs-operator">/**</span>
<span class="hljs-comment">//获取ApplicationContext</span>
ApplicationContext ctx<span class="hljs-operator">=</span>ApplicationContextRegister.getApplicationContext();
<span class="hljs-comment">//获取BeanFactory  </span>
DefaultListableBeanFactory defaultListableBeanFactory <span class="hljs-operator">=</span> (DefaultListableBeanFactory) ctx.getAutowireCapableBeanFactory();       
<span class="hljs-comment">//创建bean信息.  </span>
BeanDefinitionBuilder beanDefinitionBuilder <span class="hljs-operator">=</span> BeanDefinitionBuilder.genericBeanDefinition(TestService.<span class="hljs-keyword">class</span>);  
beanDefinitionBuilder.addPropertyValue(<span class="hljs-string">"name"</span>,<span class="hljs-string">"张三"</span>);          
<span class="hljs-comment">//动态注册bean.  </span>
defaultListableBeanFactory.registerBeanDefinition(<span class="hljs-string">"testService"</span>, beanDefinitionBuilder.getBeanDefinition());  
<span class="hljs-comment">//获取动态注册的bean.  </span>
TestService testService <span class="hljs-operator">=</span>ctx.getBean(TestService.<span class="hljs-keyword">class</span>);、testService.print();  
<span class="hljs-operator">*/</span>

<span class="hljs-operator">@</span>GetMapping(<span class="hljs-string">"/bean2"</span>)
<span class="hljs-keyword">public</span> String registerBean2() {

    TestController userController <span class="hljs-operator">=</span> (TestController) ApplicationContextRegister.getBean(TestController.<span class="hljs-keyword">class</span>);

    <span class="hljs-keyword">return</span> userController.toAction(<span class="hljs-string">"动态注册生成调用"</span>);

}

}

以上参考:

主力:https://www.jianshu.com/p/41c716e7c31b
辅助:https://www.jb51.net/article/140157.htm

拓展理解

我们通过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