向Spring IOC 容器动态注册bean实现方式


Posted in Java/Android onJuly 15, 2022

本文的大纲

向Spring IOC 容器动态注册bean实现方式

从一个需求谈起

这周遇到了这样一个需求,从第三方的数据库中获取值,只是一个简单的分页查询,处理这种问题,我一般都是在配置文件中配置数据库的地址等相关信息,然后在Spring Configuration 注册数据量连接池的bean,然后再将数据库连接池给JdbcTemplate, 但是这种的缺陷是,假设填错了数据库地址和密码,或者换了数据库的地址和密码,在配置文件里面重启之后,都需要重启应用。

我想能不能动态的向Spring IOC容器中注册和加载bean呢,项目在界面上填写数据库的地址、用户名、密码,存储之后,将JdbcTemplate和另一个数据库连接池加载到IOC容器中。答案是可以的,我经过一番搜索写出了如下代码:

@Component
public class BeanDynamicRegister {
    private final ConfigurableApplicationContext configurableApplicationContext;
    public BeanDynamicRegister(ConfigurableApplicationContext configurableApplicationContext) {
        this.configurableApplicationContext = configurableApplicationContext;
    }
    /**
     * 此方法提供出去,供其他bean动态的向IOC容器中注册bean。
     * 代表使用构造器给bean赋值
     *
     * @param beanName bean名
     * @param clazz    bean类
     * @param args     用于向bean的构造函数中添加值 如果loadType是set,则要求传递map.map的key为属性名,value为属性值
     * @param <T>      返回一个泛型
     * @param loadType
     * @return
     */
    public <T> T registerBeanByLoadType(String beanName, Class<T> clazz, LoadType loadType, Object... args) {
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
        if (args.length > 0) {
            // 将参数加入到构造函数中
            switch (loadType) {
                case CONSTRUCTOR:
                    for (Object arg : args) {
                        beanDefinitionBuilder.addConstructorArgValue(arg);
                    }
                    break;
                case SETTER:
                    Map<String, Object> propertyMap = (Map<String, Object>) args[0];
                    for (Map.Entry<String, Object> stringObjectEntry : propertyMap.entrySet()) {
                        beanDefinitionBuilder.addPropertyValue(stringObjectEntry.getKey(), stringObjectEntry.getValue());
                    }
                    break;
                default:
                    break;
            }
        }
        BeanDefinition beanDefinition = beanDefinitionBuilder.getRawBeanDefinition();
        BeanDefinitionRegistry beanDefinitionRegistry = (BeanDefinitionRegistry) configurableApplicationContext.getBeanFactory();
        beanDefinitionRegistry.registerBeanDefinition(beanName, beanDefinition);
        return configurableApplicationContext.getBean(beanName, clazz);
    }
    public <T> T getBeanByName(String beanName,Class<T> requiredType){
        return  configurableApplicationContext.getBean(beanName,requiredType);
    }
    /**
     * 如果用户换了地址和密码,向IOC容器中移除bean。 重新注册
     *
     * @param beanName
     */
    public void removeBean(String beanName) {
        BeanDefinitionRegistry beanDefinitionRegistry = (BeanDefinitionRegistry) configurableApplicationContext.getBeanFactory();
        beanDefinitionRegistry.removeBeanDefinition(beanName);
    }
}
@SpringBootTest
class SsmApplicationTests {
    @Autowired
    private LoadBeanService loadBeanService;
    private NamedParameterJdbcTemplate jdbcTemplate;
    @Autowired
    private BeanDynamicRegister beanDynamicRegister;
    @Test
    public void test() {
        loadBeanService.loadDataSourceTest("root", "root");
        jdbcTemplate = beanDynamicRegister.getBeanByName("jdbcTemplateOne", NamedParameterJdbcTemplate.class);
        System.out.println("--------" + jdbcTemplate);
    }
}

结果: 

向Spring IOC 容器动态注册bean实现方式

我们就到这里了吗? 我们观察一下上面将一个bean加载到Spring IOC容器里经过了几步:

  • BeanDefineBuilder 构造BeanDefinition
  • 然后BeanDefinitionRegistry将其注册到IOC容器中。(这一步事实上只完成了注册,还未完成Bean的实例化,属性填充)

联系我们前面的文章《Spring Bean 的生命周期》,我们将Spring 的生命周期理解为“Spring 给我们提供的一些扩展接口,如果bean实现了这些这些接口,应用在启动的过程中会回调这些接口的方法。” , 这个理解并不完善,缺少了解析BeanDefinition这个阶段。

Spring Bean的生命周期再完善

BeanDefinition

那BeanDefinition是什么? BeanDefinition是一个接口,我们进Spring 官网(https://docs.spring.io/spring...)大致看一下:

A bean definition can contain a lot of configuration information, including constructor arguments, property values, and container-specific information, such as the initialization method, a static factory method name, and so on. A child bean definition inherits configuration data from a parent definition. The child definition can override some values or add others as needed. Using parent and child bean definitions can save a lot of typing. Effectively, this is a form of templating.

bean 的定义信息可以包含许多配置信息,包括构造函数参数,属性值和特定于容器的信息,例如初始化方法,静态工厂方法名称等。子 bean 定义可以从父 bean 定义继承配置数据。子 bean 的定义信息可以覆盖某些值,或者可以根据需要添加其他值。使用父 bean 和子 bean 的定义可以节省很多输入(实际上,这是一种模板的设计形式)。

这段说的可能有点抽象, 你点BeanDefinition进去,你就会发现有很多熟悉的面孔:

向Spring IOC 容器动态注册bean实现方式

Bean的作用域: 单例,还是多例。

向Spring IOC 容器动态注册bean实现方式

lazyInit是否是懒加载。

这些都是描述Spring Bean的信息,我们可以类比到Java中的类,每个类都会有class属性,我们在配置类或者xml中的配置Bean的元信息,也被映射到这里。供IOC容器将Bean加入时使用。所以我们可以为对Spring Bean的生命周期的理解打一个补丁:

  • 从xml或配置类中解析BeanDefintion
  • BeanDefinition 注册,此时还未完成Bean的实例化。

我们可以打断点来验证一下:

向Spring IOC 容器动态注册bean实现方式

向Spring IOC 容器动态注册bean实现方式

  • Bean 实例化
  • Bean的属性赋值+依赖注入
  • Bean的初始化阶段的方法回调
  • Bean的销毁。

向Spring IOC 容器动态注册bean实现方式

Bean 加入IOC容器的几种方式

我们这里再来总结一下一个Bean注入Spring IOC容器的几种形式:

启动时加入

  • 配置类: @Configuration+@Bean
  • 配置文件: xml

注解形式

  • @Component
  • @Service
  • @Controller
  • @Repository
  • @import
  • @Qualifier
  • @Resource
  • @Inject

运行时加入

这三种最终都是通过BeanDefinitionRegistry来注入的,ImportBeanDefinitionRegistrar是一个接口,留给我们实现的方法如下:

default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
}
  • ImportBeanDefinitionRegistrar
  • 手动构造BeanDefinition注入(我们上面就是自己手动构造BeanDefinition注入)
  • 借助BeanDefinitionRegistryPostProcessor注入

​ BeanDefinitionRegistryPostProcessor也是一个接口,留给我们实现的方法如下:

void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;

从spring容器中动态添加或移除bean

public class DemoUtil {
    @Autowired
    private ApplicationContext applicationContext;
//添加bean
    public void addBean(String beanName, Class<?> beanClass) {
        BeanDefinitionRegistry beanDefinitionRegistry = (BeanDefinitionRegistry) applicationContext.getAutowireCapableBeanFactory();
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(beanClass);
        BeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
        if (!beanDefinitionRegistry.containsBeanDefinition(beanName)) {
            beanDefinitionRegistry.registerBeanDefinition(beanName, beanDefinition);
        }
    }
//移除bean
    public void removeBean(String beanName) {
        BeanDefinitionRegistry beanDefinitionRegistry = (BeanDefinitionRegistry) applicationContext.getAutowireCapableBeanFactory();
        beanDefinitionRegistry.getBeanDefinition(beanName);
        beanDefinitionRegistry.removeBeanDefinition(beanName);
    }
}

参考资料

以上就是向Spring IOC 容器动态注册bean实现方式的详细内容,更多关于Spring IOC 容器动态注册bean的资料请关注三水点靠木其它相关文章!


Tags in this post...

Java/Android 相关文章推荐
SpringBoot项目中控制台日志的保存配置操作
Jun 18 Java/Android
Java各种比较对象的方式的对比总结
Jun 20 Java/Android
springboot如何初始化执行sql语句
Jun 22 Java/Android
mybatis中sql语句CDATA标签的用法说明
Jun 30 Java/Android
dubbo集成zipkin获取Traceid的实现
Jul 26 Java/Android
RestTemplate如何通过HTTP Basic Auth认证示例说明
Mar 17 Java/Android
Java 通过手写分布式雪花SnowFlake生成ID方法详解
Apr 07 Java/Android
Springboot-cli 开发脚手架,权限认证,附demo演示
Apr 28 Java/Android
Ubuntu18.04下QT开发Android无法连接设备问题解决实现
Jun 01 Java/Android
Qt数据库应用之实现图片转pdf
Jun 01 Java/Android
SpringBoot项目多数据源及mybatis 驼峰失效的问题解决方法
Jul 07 Java/Android
Springboot集成kafka高级应用实战分享
Aug 14 Java/Android
SpringBoot详解执行过程
Jul 15 #Java/Android
spring 项目实现限流方法示例
SpringBoot详解整合Redis缓存方法
Jul 15 #Java/Android
maven 解包依赖项中的文件的解决方法
Jul 15 #Java/Android
SpringBoot详解自定义Stater的应用
Jul 15 #Java/Android
MyBatis XPathParser解析器使用范例详解
Jul 15 #Java/Android
SpringBoot接入钉钉自定义机器人预警通知
Jul 15 #Java/Android
You might like
动态生成gif格式的图像要注意?
2006/10/09 PHP
计算一段日期内的周末天数的php代码(星期六,星期日总和)
2009/11/12 PHP
PHP Undefined index报错的修复方法
2011/07/17 PHP
提高PHP性能的编码技巧以及性能优化详细解析
2013/08/24 PHP
php中$美元符号与Zen Coding冲突问题解决方法分享
2014/05/28 PHP
php获取文章内容第一张图片的方法示例
2017/07/03 PHP
IE和Mozilla的兼容性汇总event
2007/08/12 Javascript
使用JQuery进行跨域请求
2010/01/25 Javascript
window.open 以post方式传递参数示例代码
2014/02/27 Javascript
js实现网页倒计时、网站已运行时间功能的代码3例
2014/04/14 Javascript
jQuery获得包含margin的outerWidth和outerHeight的方法
2015/03/25 Javascript
基于JavaScript实现仿京东图片轮播效果
2015/11/06 Javascript
MVC Ajax Helper或Jquery异步加载部分视图
2015/11/29 Javascript
Bootstrap插件全集
2016/07/18 Javascript
js实现图片淡入淡出切换简易效果
2016/08/22 Javascript
Kindeditor单独调用单图上传增加预览功能的实例
2017/07/31 Javascript
jQuery实现点击图标div循环放大缩小功能
2018/09/30 jQuery
使用taro开发微信小程序遇到的坑总结
2019/04/08 Javascript
详解mpvue开发微信小程序基础知识
2019/09/23 Javascript
在vue中把含有html标签转为html渲染页面的实例
2019/10/28 Javascript
Preload基础使用方法详解
2020/02/03 Javascript
深入浅析golang zap 日志库使用(含文件切割、分级别存储和全局使用等)
2020/02/19 Javascript
vue使用lodop打印控件实现浏览器兼容打印的方法
2021/02/07 Vue.js
[01:07:22]2014 DOTA2华西杯精英邀请赛 5 24 DK VS VG加赛
2014/05/26 DOTA
Python的Tornado框架实现图片上传及图片大小修改功能
2016/06/30 Python
如何在python中使用selenium的示例
2017/12/26 Python
python实现nao机器人身体躯干和腿部动作操作
2019/04/29 Python
检测tensorflow是否使用gpu进行计算的方式
2020/02/03 Python
检测用户浏览器是否支持CSS3的方法
2009/08/29 HTML / CSS
酒店服务与管理毕业生求职信
2013/11/02 职场文书
建筑行业的大学生自我评价
2013/12/08 职场文书
优秀毕业生主要事迹材料
2015/11/04 职场文书
2019银行竞聘书
2019/06/21 职场文书
高效笔记技巧分享:学会这些让你不再困扰
2019/09/04 职场文书
AJAX引擎原理以及XmlHttpRequest对象的axios、fetch区别详解
2022/04/09 Javascript
vue如何在data中引入图片的正确路径
2022/06/05 Vue.js