Spring Boot外部化配置实战解析

2024-11-01 12:26:31

一、流程分析

1.1 入口程序

在 SpringApplication#run(String... args) 方法中，外部化配置关键流程分为以下四步

public ConfigurableApplicationContext 

run(String... args) {

  ...

  SpringApplicationRunListeners listeners = getRunListeners(args); // 1

  listeners.starting();

  try {

    ApplicationArguments applicationArguments = new DefaultApplicationArguments(

      args);

    ConfigurableEnvironment environment = prepareEnvironment(listeners,

                                 applicationArguments); // 2

    configureIgnoreBeanInfo(environment);

    Banner printedBanner = printBanner(environment);

    context = createApplicationContext();

    exceptionReporters = getSpringFactoriesInstances(

      SpringBootExceptionReporter.class,

      new Class[] { ConfigurableApplicationContext.class }, context);

    prepareContext(context, environment, listeners, applicationArguments,

            printedBanner); // 3

    refreshContext(context); // 4

    afterRefresh(context, applicationArguments);

    stopWatch.stop();

    if (this.logStartupInfo) {

      new StartupInfoLogger(this.mainApplicationClass)

        .logStarted(getApplicationLog(), stopWatch);

    }

    listeners.started(context);

    callRunners(context, applicationArguments);

  }

  ...

}

1.2 关键流程思维导图

1.3 关键流程详解

对入口程序中标记的四步，分析如下

1.3.1 SpringApplication#getRunListeners

加载 META-INF/spring.factories

获取 SpringApplicationRunListener

的实例集合，存放的对象是 EventPublishingRunListener 类型以及自定义的 SpringApplicationRunListener 实现类型

1.3.2 SpringApplication#prepareEnvironment

prepareEnvironment 方法中，主要的三步如下

private ConfigurableEnvironment 

prepareEnvironment(SpringApplicationRunListeners listeners,

  ApplicationArguments applicationArguments) {

  // Create and configure the environment

  ConfigurableEnvironment environment = getOrCreateEnvironment(); // 2.1

  configureEnvironment(environment, applicationArguments.getSourceArgs()); // 2.2

  listeners.environmentPrepared(environment); // 2.3

  ...

  return environment;

}

1) getOrCreateEnvironment 方法

在 WebApplicationType.SERVLET web应用类型下，会创建 StandardServletEnvironment，本文以 StandardServletEnvironment 为例，类的层次结构如下

当创建 StandardServletEnvironment，StandardServletEnvironment 父类 AbstractEnvironment 调用 customizePropertySources 方法，会执行 StandardServletEnvironment#customizePropertySources和 StandardEnvironment#customizePropertySources ，源码如下AbstractEnvironment

public AbstractEnvironment() {

  customizePropertySources(this.propertySources);

  if (logger.isDebugEnabled()) {

    logger.debug("Initialized " + getClass().getSimpleName() + " with PropertySources " + this.propertySources);

  }

}

StandardServletEnvironment#customizePropertySources

/** Servlet context init parameters property source name: {@value} */

public static final 

StringSERVLET_CONTEXT_PROPERTY_SOURCE_NAME = "servletContextInitParams";

/** Servlet config init parameters property source name: {@value} */

public static final String 

SERVLET_CONFIG_PROPERTY_SOURCE_NAME = "servletConfigInitParams";

/** JNDI property source name: {@value} */

public static final String 

JNDI_PROPERTY_SOURCE_NAME = "jndiProperties";

@Override

protected void customizePropertySources(MutablePropertySources propertySources) {

  propertySources.addLast(new StubPropertySource(SERVLET_CONFIG_PROPERTY_SOURCE_NAME));

  propertySources.addLast(new StubPropertySource(SERVLET_CONTEXT_PROPERTY_SOURCE_NAME));

  if (JndiLocatorDelegate.isDefaultJndiEnvironmentAvailable()) {

    propertySources.addLast(new JndiPropertySource(JNDI_PROPERTY_SOURCE_NAME));

  }

  super.customizePropertySources(propertySources);

}

StandardEnvironment#customizePropertySources

/** System environment property source name: {@value} */

public static final String 

SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME = "systemEnvironment";

/** JVM system properties property source name: {@value} */

public static final String 

SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME = "systemProperties";

@Override

protected void customizePropertySources(MutablePropertySources propertySources) {

  propertySources.addLast(new MapPropertySource(SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties()));

  propertySources.addLast(new SystemEnvironmentPropertySource(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,getSystemEnvironment());

}

PropertySources 顺序：

servletConfigInitParams
servletContextInitParams
jndiProperties
systemProperties
systemEnvironment

PropertySources 与 PropertySource 关系为 1 对 N

2) configureEnvironment 方法

调用 configurePropertySources(environment, args)，在方法里面设置 Environment 的 PropertySources ，包含 defaultProperties 和

SimpleCommandLinePropertySource（commandLineArgs），PropertySources 添加 defaultProperties 到最后，添加

SimpleCommandLinePropertySource（commandLineArgs）到最前面

PropertySources 顺序：

commandLineArgs
servletConfigInitParams
servletContextInitParams
jndiProperties
systemProperties
systemEnvironment
defaultProperties

3) listeners.environmentPrepared 方法

会按优先级顺序遍历执行 SpringApplicationRunListener#environmentPrepared，比如 EventPublishingRunListener 和自定义的 SpringApplicationRunListener

EventPublishingRunListener 发布

ApplicationEnvironmentPreparedEvent 事件

ConfigFileApplicationListener 监听

ApplicationEvent 事件、处理 ApplicationEnvironmentPreparedEvent 事件，加载所有 EnvironmentPostProcessor 包括自己，然后按照顺序进行方法回调

---ConfigFileApplicationListener#postProcessEnvironment方法回调，然后addPropertySources 方法调用

RandomValuePropertySource#addToEnvironment，在 systemEnvironment 后面添加 random，然后添加配置文件的属性源（详见源码ConfigFileApplicationListener.Loader#load()

扩展点

自定义 SpringApplicationRunListener ，重写 environmentPrepared 方法
自定义 EnvironmentPostProcessor
自定义 ApplicationListener 监听 ApplicationEnvironmentPreparedEvent 事件
ConfigFileApplicationListener，即是 EnvironmentPostProcessor ，又是 ApplicationListener ，类的层次结构如下

@Override

public void onApplicationEvent(ApplicationEvent event) {

  // 处理 ApplicationEnvironmentPreparedEvent 事件

  if (event instanceof ApplicationEnvironmentPreparedEvent) {

    onApplicationEnvironmentPreparedEvent(

      (ApplicationEnvironmentPreparedEvent) event);

  }

  // 处理 ApplicationPreparedEvent 事件

  if (event instanceof ApplicationPreparedEvent) {

    onApplicationPreparedEvent(event);

  }

}

private void onApplicationEnvironmentPreparedEvent(

  ApplicationEnvironmentPreparedEvent event) {

  // 加载 META-INF/spring.factories 中配置的 EnvironmentPostProcessor

  List

  // 加载自己 ConfigFileApplicationListener

  postProcessors.add(this);

  // 按照 Ordered 进行优先级排序

  AnnotationAwareOrderComparator.sort(postProcessors);

  // 回调 EnvironmentPostProcessor

  for (EnvironmentPostProcessor postProcessor : postProcessors) {

    postProcessor.postProcessEnvironment(event.getEnvironment(),                      event.getSpringApplication());

  }

}

List

  return SpringFactoriesLoader.loadFactories(EnvironmentPostProcessor.class,                        getClass().getClassLoader());

}

@Override

public void 

postProcessEnvironment(ConfigurableEnvironment environment,

                  SpringApplication application) {

  addPropertySources(environment, application.getResourceLoader());

}

/**

 * Add config file property sources to the specified environment.

 * @param environment the environment to add source to

 * @param resourceLoader the resource loader

 * @see 

#addPostProcessors(ConfigurableApplicationContext)

 */

protected void 

addPropertySources(ConfigurableEnvironment environment,

                 ResourceLoader resourceLoader) {

RandomValuePropertySource.addToEnvironment(environment);

  // 添加配置文件的属性源

  new Loader(environment, resourceLoader).load();

}

RandomValuePropertySource

public static void 

addToEnvironment(ConfigurableEnvironment environment) {

  // 在 systemEnvironment 后面添加 random

  environment.getPropertySources().addAfter(

    StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,

    new RandomValuePropertySource(RANDOM_PROPERTY_SOURCE_NAME));

  logger.trace("RandomValuePropertySource add to Environment");

}

添加配置文件的属性源：执行

new Loader(environment, resourceLoader).load();，

调用 load(Profile, DocumentFilterFactory, DocumentConsumer)（getSearchLocations()

获取配置文件位置，可以指定通过 spring.config.additional-location 、spring.config.location 、spring.config.name 参数或者使用默认值），然后调用 addLoadedPropertySources -> addLoadedPropertySource（加载查找出来的 PropertySource 到 PropertySources，并确保放置到 defaultProperties 的前面）

默认的查找位置，配置为

"classpath:/,classpath:/config/,file:./,file:./config/"，查找顺序从后向前

PropertySources 顺序：

commandLineArgs
servletConfigInitParams
servletContextInitParams
jndiProperties
systemProperties
systemEnvironment
random
application.properties ...
defaultProperties

1.3.3 SpringApplication#prepareContext

prepareContext 方法中，主要的三步如下

private void 

prepareContext(ConfigurableApplicationContext context,

              ConfigurableEnvironment environment,

              SpringApplicationRunListeners listeners,

              ApplicationArguments applicationArguments,

              Banner printedBanner) {

  ...

  applyInitializers(context); // 3.1

  listeners.contextPrepared(context); //3.2

  ...

  listeners.contextLoaded(context); // 3.3

}

1）applyInitializers 方法

会遍历执行所有的 ApplicationContextInitializer#initialize

扩展点

自定义 ApplicationContextInitializer

2）listeners.contextPrepared 方法

会按优先级顺序遍历执行 SpringApplicationRunListener#contextPrepared，比如 EventPublishingRunListener 和自定义的 SpringApplicationRunListener

扩展点

自定义 SpringApplicationRunListener ，重写 contextPrepared 方法

3）listeners.contextLoaded 方法

会按优先级顺序遍历执行 SpringApplicationRunListener#contextLoaded，比如 EventPublishingRunListener 和自定义的 SpringApplicationRunListener

EventPublishingRunListener 发布

ApplicationPreparedEvent 事件

ConfigFileApplicationListener 监听

ApplicationEvent 事件处理

ApplicationPreparedEvent 事件

扩展点

自定义 SpringApplicationRunListener ，重写 contextLoaded 方法
自定义 ApplicationListener ，监听 ApplicationPreparedEvent 事件

ConfigFileApplicationListener

@Override

public void onApplicationEvent(ApplicationEvent event) {

  // 处理 ApplicationEnvironmentPreparedEvent 事件

  if (event instanceof 

ApplicationEnvironmentPreparedEvent) {

    onApplicationEnvironmentPreparedEvent(

      (ApplicationEnvironmentPreparedEvent) event);

  }

  // 处理 ApplicationPreparedEvent 事件

  if (event instanceof ApplicationPreparedEvent) {

    onApplicationPreparedEvent(event);

  }

}

private void onApplicationPreparedEvent(ApplicationEvent event) {

  this.logger.replayTo(ConfigFileApplicationListener.class);

  addPostProcessors(((ApplicationPreparedEvent) event).getApplicationContext());

}

// 添加 PropertySourceOrderingPostProcessor 处理器，配置 PropertySources

protected void addPostProcessors(ConfigurableApplicationContext context) {

  context.addBeanFactoryPostProcessor(

    new PropertySourceOrderingPostProcessor(context));

}

PropertySourceOrderingPostProcessor

// 回调处理（在配置类属性源解析）

@Override

public void 

postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)

  throws BeansException {

  reorderSources(this.context.getEnvironment());

}

// 调整 PropertySources 顺序，先删除 defaultProperties， 再把 defaultProperties 添加到最后

private void reorderSources(ConfigurableEnvironment environment) {

  PropertySource

    .remove(DEFAULT_PROPERTIES);

  if (defaultProperties != null) {

    environment.getPropertySources().addLast(defaultProperties);

  }

}

PropertySourceOrderingPostProcessor 是 BeanFactoryPostProcessor

1.3.4 SpringApplication#refreshContext

会进行 @Configuration 配置类属性源解析，处理 @PropertySource annotations on your @Configuration classes，但顺序是在 defaultProperties 之后，下面会把defaultProperties 调整到最后

AbstractApplicationContext#refresh 调用 invokeBeanFactoryPostProcessors(PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors)，然后进行 BeanFactoryPostProcessor 的回调处理，比如 PropertySourceOrderingPostProcessor 的回调（源码见上文）

PropertySources 顺序：

commandLineArgs
servletConfigInitParams
servletContextInitParams
jndiProperties
systemProperties
systemEnvironment
random
application.properties ...
@PropertySource annotations on your @Configuration classes
defaultProperties

（不推荐使用这种方式，推荐使用在 refreshContext 之前准备好，@PropertySource 加载太晚，不会对自动配置产生任何影响）

二、扩展外部化配置属性源

2.1 基于 EnvironmentPostProcessor 扩展

public class CustomEnvironmentPostProcessor 

implements EnvironmentPostProcessor

2.2 基于 ApplicationEnvironmentPreparedEvent 扩展

public class 

ApplicationEnvironmentPreparedEventListener implements ApplicationListener

2.3 基于 SpringApplicationRunListener 扩展

public class CustomSpringApplicationRunListener implements SpringApplicationRunListener, Ordered

可以重写方法 environmentPrepared、contextPrepared、contextLoaded 进行扩展

2.4 基于 ApplicationContextInitializer 扩展

public class CustomApplicationContextInitializer implements ApplicationContextInitializer

关于与 Spring Cloud Config Client 整合，对外部化配置加载的扩展（绑定到Config Server，使用远端的property sources 初始化 Environment），参考源码PropertySourceBootstrapConfiguration（是对 ApplicationContextInitializer 的扩展）、ConfigServicePropertySourceLocator#locate

获取远端的property sources是 RestTemplate 通过向 http://{spring.cloud.config.uri}/{spring.application.name}/{spring.cloud.config.profile}/{spring.cloud.config.label} 发送 GET 请求方式获取的

2.5 基于 ApplicationPreparedEvent 扩展

public class ApplicationPreparedEventListener 

implements ApplicationListener

2.6 扩展实战

2.6.1 扩展配置

在 classpath 下添加配置文件 META-INF/spring.factories，内容如下

# Spring Application Run Listeners

org.springframework.boot.SpringApplicationRunListener=\

springboot.propertysource.extend.listener.CustomSpringApplicationRunListener

# Application Context Initializers

org.springframework.context.ApplicationContextInitializer=\

springboot.propertysource.extend.initializer.CustomApplicationContextInitializer

# Application Listeners

org.springframework.context.ApplicationListener=\

springboot.propertysource.extend.event.listener.ApplicationEnvironmentPreparedEventListener,\

springboot.propertysource.extend.event.listener.ApplicationPreparedEventListener

# Environment Post Processors

org.springframework.boot.env.EnvironmentPostProcessor=\

springboot.propertysource.extend.processor.CustomEnvironmentPostProcessor

以上的扩展可以选取其中一种进行扩展，只是属性源的加载时机不太一样

2.6.2 扩展实例代码

https://github.com/shijw823/springboot-externalized-configuration-extend.git

PropertySources 顺序：

propertySourceName: [ApplicationPreparedEventListener], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [CustomSpringApplicationRunListener-contextLoaded], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [CustomSpringApplicationRunListener-contextPrepared], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [CustomApplicationContextInitializer], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [bootstrapProperties], propertySourceClassName: [CompositePropertySource]

propertySourceName: [configurationProperties], propertySourceClassName: [ConfigurationPropertySourcesPropertySource]

propertySourceName: [CustomSpringApplicationRunListener-environmentPrepared], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [CustomEnvironmentPostProcessor-dev-application], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [ApplicationEnvironmentPreparedEventListener], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [commandLineArgs], propertySourceClassName: [SimpleCommandLinePropertySource]

propertySourceName: [servletConfigInitParams], propertySourceClassName: [StubPropertySource]

propertySourceName: [servletContextInitParams], propertySourceClassName: [ServletContextPropertySource]

propertySourceName: [systemProperties], propertySourceClassName: [MapPropertySource]

propertySourceName: [systemEnvironment], propertySourceClassName: [OriginAwareSystemEnvironmentPropertySource]

propertySourceName: [random], propertySourceClassName: [RandomValuePropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/springApplicationRunListener.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/applicationListener.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/applicationContextInitializer.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/environmentPostProcessor.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/application.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/extend/config/config.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [applicationConfig: [classpath:/application.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [springCloudClientHostInfo], propertySourceClassName: [MapPropertySource]

propertySourceName: [applicationConfig: [classpath:/bootstrap.properties]], propertySourceClassName: [OriginTrackedMapPropertySource]

propertySourceName: [propertySourceConfig], propertySourceClassName: [ResourcePropertySource]

propertySourceName: [defaultProperties], propertySourceClassName: [MapPropertySource]

bootstrapProperties 是获取远端（config-server）的 property sources

加载顺序也可参考 http://{host}:{port}/actuator/env

PropertySources 单元测试顺序：

@TestPropertySource#properties
@SpringBootTest#properties
@TestPropertySource#locations

三、参考资料

https://docs.spring.io/spring-boot/docs/2.0.5.RELEASE/reference/htmlsingle/#boot-features-external-config

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

详解spring boot引入外部jar包的坑

前言:由于项目需求,短信验证码的接口需要换成阿里大于的,但是尴尬的发现阿里大于的jar包没有maven版本的,于是便开始了一上午的操蛋引包之路.按照套路来说,自然应该是百度一波,但是百度了好久,找了好多方案之后发现,没一个有用的,而且文章的抄袭.拷贝十分严重,试了N种方案,都是错的,都没有将外部jar包打包到BOOK-INF文件夹下.最终,在第N次尝试之后,终于在打的jar包里将外部的jar包导入进来.特此记录下,防止再犯!!! 首先在新建libs文件夹(根目录或者resource目录下都可以)
SpringBoot应用War包形式部署到外部Tomcat的方法

这一篇文章介绍SpringBoot应用修改默认打jar形式部署为打war包形式,部署到外部Tomcat. SpringBoot应用默认打包成为可执行jar模式让我们感觉到部署的便捷,接下来给大家介绍一下SpringBoot项目打War包形式部署到外部Tomcat. 修改原有项目 1.修改项目打开项目,修改pom文件: 1.项目中加入spring-boot-starter-web(如果是已经加入该依赖的项目可以忽略)和spring-boot-starter-tomcat依赖. 2.packagi
spring boot 自定义规则访问获取内部或者外部静态资源图片的方法

项目中需要将图片放在磁盘上,不能将图片放在webapp下面! springboot默认配置基本上可以满足我们的日常需要.但是项目中大量用户上传的图片,不能放在tomcat下面,这样子每次重新部署项目的时候,图片就失效了,很是麻烦. 所以此时就需要自定义配置springboot的项目静态文件映射 springboot默认的配置规则映射 /** 到 classpath:/static classpath:/public classpath:/resources classpath:/META-IN
详解spring boot 使用application.properties 进行外部配置

application.properties大家都不陌生,我们在开发的时候,经常使用它来配置一些可以手动修改而且不用编译的变量,这样的作用在于,打成war包或者jar用于生产环境时,我们可以手动修改环境变量而不用再重新编译. spring boo默认已经配置了很多环境变量,例如,tomcat的默认端口是8080,项目的contextpath是"/"等等,可以在这里看spring boot默认的配置信息http://docs.spring.io/spring-boot/docs/curr
SpringBoot 创建web项目并部署到外部Tomcat

前言使用SpringBoot来开发项目相对于传统模式,要快速优雅许多,相信目前国内绝大部分web项目的开发还没有使用SpringBoot来做,如果你正需要开发一个web项目,不妨尝试使用SpringBoot来做. 本身SpringBoot是内嵌了web服务器,不需要单独的Tomcat,但是实际生产环境中,如果是web项目,Tomcat肯定是运维部门部署好了的,这个Tomcat,做了一些个性化的设置,开发出来的项目需要部署到这个Tomcat,如果是使用SpringBoot开发web服务,我认为可
Springboot引用外部配置文件的方法步骤

现在的项目越来越多的都是打包成jar运行尤其是springboot项目,这时候配置文件如果一直放在项目中,每次进行简单的修改时总会有些不方便,这里我们看下打包成jar之后,从外部配置文件中读取配置信息. 首先想到的是通过java代码读取外边某个路径下的文件,但是开始做之后发现好多问题.后来又找其它解决方案,正好搜到一种简单的解决方式: java -jar demo.jar --Dspring.config.location=myapplication.properties 这样就可以通过@val
Spring Boot 把配置文件和日志文件放到jar外部

如果不想使用默认的application.properties,而想将属性文件放到jar包外面,可以使用如下两种方法: 只能设置全路径.因为Java -jar运行jar包时,无法指定classpath(无论通过参数还是环境变量,设置的classpath都会被覆盖). 方法1:命令行传参指定spring.config.location java -jar -Dspring.config.location=D:\zTest\config\config1.properties springbootre
Spring boot外部配置（配置中心化）详解

前言在项目中为了灵活配置,我们常采用配置文件,常见的配置文件就比如xml和properties,springboot允许使用properties和yaml文件作为外部配置.现在编译器对于yaml语言的支持还不够好,目前还是使用properties文件作为外部配置. 在Spring cloud config出来之前, 自己实现了基于ZK的配置中心, 杜绝了本地properties配置文件, 原理很简单, 只是重载了PropertyPlaceholderConfigurer的mergeProper
Spring Boot打jar包后配置文件的外部优化配置方法

在未进行任何处理的情况下,Spring Boot会默认使用项目中的 application.properties 或者 application.yml 来读取项目所需配置. 我这里只记录几种自己所用到的. 访问命令行属性在默认的情况下, SpringApplication 会将任何命令行选项参数(以 - 开头 --server.port=9000)转换为 property 并添加到Spring环境当中. 例如,启动项目的时候指定端口: java -jar analysis-speech-too
spring boot启动时加载外部配置文件的方法

前言相信很多人选择Spring Boot主要是考虑到它既能兼顾Spring的强大功能,还能实现快速开发的便捷.本文主要给大家介绍了关于spring boot启动时加载外部配置文件的相关内容,下面话不多说了,来随着小编一起学习学习吧. 业务需求: 加载外部配置文件,部署时更改比较方便. 先上代码: @SpringBootApplication public class Application { public static void main(String[] args) throws Exce

Spring Boot外部化配置实战解析

相关推荐

随机推荐