SpringBoot中动态注册Bean的方式
创始人
2025-01-11 16:04:52
0

测试环境,本文源码

  • Java:8
  • SpringBoot:2.5.14
  • 示例场景:动态注册ProxyServlet,间接实现类似于Nginx的反向代理功能

先理解如何实现动态注册 Bean

由于在 SpringBoot 中,先进行 Bean 的定义,再根据定义进行 Bean 的实例化,所以实现动态 Bean ,我们只需要动态注册 Bean 定义即可。

这就用到了 BeanDefinitionRegistryPostProcessorpostProcessBeanDefinitionRegistry 这个方法。

源码注释

Modify the application context’s internal bean definition registry after its standard initialization. All regular bean definitions will have been loaded, but no beans will have been instantiated yet. This allows for adding further bean definitions before the next post-processing phase kicks in.

所有常规的Bean都已经定义但尚未实例化时,这时候,你可以再新增 Bean 定义

一、通用方式

先说一个小插曲,建议搭配源码食用。假如三个类,他们分别实现且只实现了以下三个接口

  • BeanDefinitionRegistryPostProcessor
  • ApplicationContextAware
  • EnvironmentAware

这时候,这三个 Bean 的默认加载顺序如下。

并且,这三个 Bean 的方法执行顺序也是跟加载顺序相同。

但是,如果 Bean 实现了一个比 ApplicationContextAware 或者 EnvironmentAware 更先加载的 Bean ,那么就会出现先执行 setApplicationContext 或者 setEnvironment 的方法,为啥嘞?

是因为在 Bean 初始化前,先判定有没有实现 Aware 接口,如果实现过了,那么就直接优先调用 Aware 中的方法。如图。

既然明白了这个流程,那我们就可以实现功能了。

该通用方式是适用于 SpringBoot 框架中通用动态注册 Bean 的做法。主要是通过 BeanDefinitionRegistryPostProcessor 动态注册 Bean 定义。

import org.mitre.dsmiley.httpproxy.ProxyServlet; import org.springframework.beans.BeansException; import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.support.BeanDefinitionRegistry; import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor; import org.springframework.boot.web.servlet.ServletRegistrationBean; import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment;  import java.util.HashMap; import java.util.Map;  /**  * 动态配置bean  *  * @author chenchuancheng  * @since 2024/07/11 22:50  */ @Configuration public class DynamicBeanConfig implements BeanDefinitionRegistryPostProcessor, EnvironmentAware {      private Environment environment;      @Override     public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {         BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(ServletRegistrationBean.class);         builder.addConstructorArgValue(new ProxyServlet());         builder.addConstructorArgValue(environment.getProperty("proxy.servletUrl"));         Map initParams = new HashMap<>();         initParams.put("targetUri", environment.getProperty("proxy.targetUrl"));         initParams.put("log", "true");         builder.addPropertyValue("initParameters", initParams);         builder.addPropertyValue("name", environment.getProperty("proxy.name"));         registry.registerBeanDefinition("proxyServlet", builder.getBeanDefinition());     }      @Override     public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {     }      @Override     public void setEnvironment(Environment environment) {         this.environment = environment;     } } 

除了实现 Aware 接口,也可以通过构造函数注入,也可以保证调用方法时有值了。

二、特定方式

这个是使用 ServletContext 动态注册 Servlet 的方式。

import org.mitre.dsmiley.httpproxy.ProxyServlet; import org.springframework.boot.web.servlet.ServletContextInitializer; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment;  import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.ServletRegistration; import java.util.HashMap; import java.util.Map;  @Configuration public class ProxyServletInitializer implements ServletContextInitializer {      private final Environment environment;      public ProxyServletInitializer(Environment environment) {         this.environment = environment;     }      @Override     public void onStartup(ServletContext servletContext) throws ServletException {         registerProxyServlet(servletContext,environment.getProperty("proxy.name"),environment.getProperty("proxy.targetUrl"));     }      private void registerProxyServlet(ServletContext servletContext, String name, String targetUri) {         ProxyServlet proxyServlet = new ProxyServlet();         ServletRegistration.Dynamic registration = servletContext.addServlet(name + "ProxyServlet", proxyServlet);         registration.setLoadOnStartup(1);         registration.addMapping("/" + name + "/*");                  Map initParameters = new HashMap<>();         initParameters.put("targetUri", targetUri);         initParameters.put("log", "true");         registration.setInitParameters(initParameters);     } } 

相关内容

热门资讯

有挂透视!哈糖大菠萝挂,小程序... 有挂透视!哈糖大菠萝挂,小程序微乐陕西挖坑辅助,窍要教程(详细教程)-哔哩哔哩该软件可以轻松地帮助玩...
目前!开心游戏辅助软件,盛世辅... 目前!开心游戏辅助软件,盛世辅助,方案教程(有挂透明挂)-哔哩哔哩1、开心游戏辅助软件免费脚本咨询教...
教程辅助!微信小程序游戏充值破... 教程辅助!微信小程序游戏充值破解,wepoker辅助工具,模块教程(真实有挂)-哔哩哔哩1、全新机制...
透视数据!德州私人局怎么透视,... 透视数据!德州私人局怎么透视,中至赣州小程序辅助器,妙招教程(有挂秘籍)-哔哩哔哩1、超多福利:超高...
科普透视!德普之星辅助器app... 科普透视!德普之星辅助器app,微乐四川亲友圈辅助器,指引教程(有挂方法)-哔哩哔哩1、德普之星辅助...
目前!唯思竞技辅助器,万能微信... 目前!唯思竞技辅助器,万能微信小游戏辅助器,要领教程(有挂猫腻)-哔哩哔哩一、万能微信小游戏辅助器游...
教程攻略!椰岛常胜游戏辅助,w... 教程攻略!椰岛常胜游戏辅助,werplan脚本,讲义教程(有挂方式)-哔哩哔哩1、点击下载安装,椰岛...
据目击者称!pokemmo脚本... 据目击者称!pokemmo脚本辅助器,广东雀神辅助器,法子教程(有挂详细)-哔哩哔哩;1、任何pok...
辅助透视!hardrock作弊... 辅助透视!hardrock作弊,微乐自建房辅助软件如何下载,机巧教程(确实有挂)-哔哩哔哩1、下载好...
长期以来!雀友会钻石辅助器潮汕... 长期以来!雀友会钻石辅助器潮汕麻将,欢乐情怀游戏源码,方案教程(有挂功能)-哔哩哔哩1)雀友会钻石辅...