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

测试环境,本文源码

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

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

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

这就用到了 BeanDefinitionRegistryPostProcessor 中 postProcessBeanDefinitionRegistry 这个方法。

源码注释

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、智星菠萝德州透视辅助软件激活码多个强度级别...
正版作弊器插件!AAPoKer... 正版作弊器插件!AAPoKer多功能有开挂-好像有挂秘诀1、点击下载安装,AAPoKer脚本分类一目...
正版作弊器脚本!AAPoKer... 正版作弊器脚本!AAPoKer多功能存在有开挂-果然有挂方式1、完成AAPoKer辅助器v3.3的残...
正版透视挂app!wpk多功能... 正版透视挂app!wpk多功能有开挂-其实有挂助手1、wpk免费脚本咨询教程、wpk免费脚本弱密码等...
正版作弊器工具!wpk多功能有... 正版作弊器工具!wpk多功能有开挂-总是有人有挂1)wpk免费钻石:进一步探索wpk免费脚本大陆,与...
正版作弊器app!aapoke... 正版作弊器app!aapoker多功能真的是有开挂-真是有挂分享aapoker辅助器是一种具有地方特...
正版透视挂方法!aapoker... 正版透视挂方法!aapoker多功能有开挂-本来有挂细节1、下载好aapoker脚本下载之后点击打开...
正版外挂技巧!WePoKer多... 正版外挂技巧!WePoKer多功能真的是有开挂-其实有挂神器1、游戏颠覆性的策略玩法,独创攻略技巧玩...
正版辅助方法!wpk多功能存在... 正版辅助方法!wpk多功能存在有开挂-竟然有挂秘笈wpk透视方法中分为三种模型:wpk靠谱、wpk辅...
正版辅助器器!智星德州扑克多功... 正版辅助器器!智星德州扑克多功能有开挂-一贯有挂方式1)智星德州扑克免费钻石:进一步探索智星德州扑克...