SpringBoot中动态注册Bean的方式发布于2024-07-08 22:04:27，更新于2024-07-17 23:43:06，标签：java 文章会持续修订，转载请注明来源地址：https://meethigher.top/blog

在这之前，先记录一个 SpringBoot 中通过 Environment 加载配置文件转换成对应实体的方式。

首先我们的配置文件如下

proxy:
  servlets:
    - name: proxy
      servletUrl: /*
      targetUrl: http://10.0.0.1:4321
      log:
        enable: true
        logFormat: "{remoteAddr} {method} uri: {source} --> {target}"
      corsControl:
        enable: false
        allowCORS: true
    - name: proxy
      servletUrl: /*
      targetUrl: http://10.0.0.1:4321
      log:
        enable: true
        logFormat: "{remoteAddr} {method} uri: {source} --> {target}"
      corsControl:
        enable: false
        allowCORS: true

其次我们的实体类如下

@Data
public class ServletInfo {

    private String name;

    /**
     * /* represents all interfaces below proxy /, no distinction between /* and /**
     */
    private String servletUrl;

    private String targetUrl;

    private LOG log;

    private CORSControl corsControl;

    public Map<String, String> toMap() {
        Map<String, String> map = new LinkedHashMap<>();
        map.put("proxy.name", getName());
        map.put("proxy.servletUrl", getServletUrl());
        map.put("proxy.targetUrl", getTargetUrl());
        map.put("proxy.log.enable", String.valueOf(getLog().isEnable()));
        map.put("proxy.log.logFormat", String.valueOf(getLog().getLogFormat()));
        map.put("proxy.corsControl.enable", String.valueOf(getCorsControl().isEnable()));
        map.put("proxy.corsControl.allowCORS", String.valueOf(getCorsControl().isAllowCORS()));
        return map;
    }


    /**
     * 跨域控制
     *
     * @author chenchuancheng
     * @since 2024/06/29 11:59
     */
    @Data
    public static class CORSControl {
        /**
         * true表示所有的代理请求的跨域都由自己管理
         * false表示所有的代理请求的跨域由被代理方控制
         */
        private boolean enable;

        /**
         * 当enable=true时，该参数才会生效
         * 如果该参数为true表示所有经过代理的服务都允许跨域
         * 如果该参数为true表示所有经过代理的服务均不允许跨域
         */
        private boolean allowCORS;

    }

    @Data
    public static class LOG {
        private boolean enable;
        /**
         * Configure the agent’s log format. The options are remoteAddr、remotePort、userAgent、method、source、target
         */
        private String logFormat;
    }
}

最后，封装一个通过 Environment 加载配置文件转换成对应实体的通用方法

public static List<ServletInfo> yaml2EntityByEnvironment(Environment environment) {
    List<ServletInfo> servletInfos=new ArrayList<>();
    int index = 0;
    while (true) {
        String prefix = "proxy.servlets[" + index + "]";
        String name = environment.getProperty(prefix + ".name");
        if (name == null) {
            break;
        }
        ServletInfo servletInfo = new ServletInfo();
        servletInfo.setName(name);
        servletInfo.setServletUrl(environment.getProperty(prefix + ".servletUrl"));
        servletInfo.setTargetUrl(environment.getProperty(prefix + ".targetUrl"));

        ServletInfo.LOG log = new ServletInfo.LOG();
        log.setEnable(Boolean.parseBoolean(environment.getProperty(prefix + ".log.enable")));
        log.setLogFormat(environment.getProperty(prefix + ".log.logFormat"));
        servletInfo.setLog(log);

        ServletInfo.CORSControl corsControl = new ServletInfo.CORSControl();
        corsControl.setEnable(Boolean.parseBoolean(environment.getProperty(prefix + ".corsControl.enable")));
        corsControl.setAllowCORS(Boolean.parseBoolean(environment.getProperty(prefix + ".corsControl.allowCORS")));
        servletInfo.setCorsControl(corsControl);

        servletInfos.add(servletInfo);
        index++;
    }
    return servletInfos;
}

下面是正文。

测试环境，本文源码

• 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<String, String> 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<String, String> initParameters = new HashMap<>();
        initParameters.put("targetUri", targetUri);
        initParameters.put("log", "true");
        registration.setInitParameters(initParameters);
    }
}