1、Spring Environment概念简介

任何一个软件项目至少都需经过开发、测试、发布阶段，不同阶段有不同的运行环境，其对应的数据库、运行主机、存储、网络、外部服务也会有所区别，故大多数项目都有多套配置对应多个环境，一般来说有开发环境(dev)、测试环境(sit/test)、预生产环境(pre)和生产环境(prd)，有些项目可能还有验证新功能的灰度环境等。

Spring 框架从3.1版本以后提供了Environment接口，包含两个关键概念profiles和properties。Profile是Spring容器中所定义的Bean的逻辑组名称，当指定Profile激活时，才会将Profile中所对应的Bean注册到Spring容器中，并把相关能力开放给了开发者；而properties代表着一组键值对配置信息，其实现中借助了ConversionService实现，具备String到Object的转换能力。其类图如下：

2、Spring Boot Environment深入分析

2.1 Environment内部结构

Environment有三个实现类：

标准实现StandardEnvironment,继承于AbstractEnvironment，重写customizePropertySources方法增加系统环境属性

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()));
 }

Servlet容器实现StandardServletEnvironment，继承于StandardEnvironment，重写customizePropertySources方法增加Servlet和JNDI属性来源

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);
}

StandardReactiveWebEnvironment 响应式web容器实现，继承于StandardEnvironment

对于web应用来说Environment实现是StandardServletEnvironment，其主要功能由抽象类AbstractEnvironment来实现，最核心的2个字段如下:

public abstract class AbstractEnvironment {
   private final MutablePropertySources propertySources = new MutablePropertySources();

   private final ConfigurablePropertyResolver propertyResolver =
      new PropertySourcesPropertyResolver(this.propertySources);

   public <T> T getProperty(String key, Class<T> targetType) {
         return this.propertyResolver.getProperty(key, targetType);
   }
}

其中propertySources(MutablePropertySources对象)存放所有Environment所有的PropertySource(代表一个配置来源)，内部是CopyOnWriteArrayList，提供有序添加PropertySource能力。

public class MutablePropertySources {
   private final List<PropertySource<?>> propertySourceList = new CopyOnWriteArrayList<>();
   public void addFirst(PropertySource<?> propertySource){
   }
   public void addLast(PropertySource<?> propertySource){
   }
   public void addBefore(String relativePropertySourceName, PropertySource<?> propertySource){
   }
   public void addAfter(String relativePropertySourceName, PropertySource<?> propertySource){
   }
}

调用Environment的API获取property时内流程是propertyResolver遍历所有PropertySource查询property，并进行占位符替换处理后返回结果。

public class PropertySourcesPropertyResolver {
   private final PropertySources propertySources;

   protected <T> T getProperty(String key, Class<T> targetValueType, boolean resolveNestedPlaceholders) {
      if (this.propertySources != null) {
         for (PropertySource<?> propertySource : this.propertySources) {
             Object value = propertySource.getProperty(key);
            if (value != null) {
               if (resolveNestedPlaceholders && value instanceof String) {
                  value = resolveNestedPlaceholders((String) value);
               }
               logKeyFound(key, propertySource, value);
               return convertValueIfNecessary(value, targetValueType);
            }
         }
      }
     return null;
   }
}

2.2 Environment初始化

Spring Boot通过SPI和Listener机制完成各个组件的初始化，Environment的初始化是其中一个环节，其主要流程如下:

运行SpringApplication
通过SPI机制加载所有ApplicationListener类，其中包含配置文件应用监听器

META-INF/spring.factories：

org.springframework.context.ApplicationListener= org.springframework.boot.context.config.ConfigFileApplicationListener

准备Environment相关配置信息
通知所有ApplicationListener处理ApplicationEnvironmentPreparedEvent事件
ConfigFileApplicationListener处理此事件，通过SPI机制加载EnvironmentPostProcessor实现类列表，调用各个类的postProcessEnvironment方法把对应的环境配置信息加载到Environment对象中

META-INF/spring.factories：

org.springframework.boot.env.EnvironmentPostProcessor =\
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor,\
org.springframework.boot.env.SpringApplicationJsonEnvironmentPostProcessor,\
org.springframework.boot.env.SystemEnvironmentPropertySourceEnvironmentPostProcessor

4个处理器的作用说明：

ConfigFileApplicationListener作为EnvironmentPostProcessor一个实现，通过SPI机制加载PropertySourceLoader接口的实现类来完成配置文件加载，分别是properties格式和yaml格式的配置加载器

org.springframework.boot.env.PropertySourceLoader=\
org.springframework.boot.env.PropertiesPropertySourceLoader,\
org.springframework.boot.env.YamlPropertySourceLoader

Spring默认加载配置文件的位置是classpath:/,classpath:/config/,file:./,file:./config/，文件名为application。其主要流程是：

从环境中获取指定profile集合，包括active和include
加载application.yaml(或application.properties)文件
读取配置文件转为PropertySource对象，并获取profiles.active和profiles.include配置项，加入到profile集合
遍历profile集合，加载application-${profile}.yaml,重复上一步骤，直至配置完所有profile

ConfigFileApplicationListener.Loader#load()

public void load() {
   this.profiles = new LinkedList<>();
   this.processedProfiles = new LinkedList<>();
   this.activatedProfiles = false;
   this.loaded = new LinkedHashMap<>();
   initializeProfiles();
   while (!this.profiles.isEmpty()) {
      Profile profile = this.profiles.poll();
      if (profile != null && !profile.isDefaultProfile()) {
         addProfileToEnvironment(profile.getName());
      }
      load(profile, this::getPositiveProfileFilter,
            addToLoaded(MutablePropertySources::addLast, false));
      this.processedProfiles.add(profile);
   }
   resetEnvironmentProfiles(this.processedProfiles);
   load(null, this::getNegativeProfileFilter,
         addToLoaded(MutablePropertySources::addFirst, true));
   addLoadedPropertySources();
}

private void load(PropertySourceLoader loader, String location, Profile profile,
      DocumentFilter filter, DocumentConsumer consumer) {
   
      Resource resource = this.resourceLoader.getResource(location);
      String name = "applicationConfig: [" + location + "]";
      List<Document> documents = loadDocuments(loader, name, resource);
      
      List<Document> loaded = new ArrayList<>();
      for (Document document : documents) {
         if (filter.match(document)) {
            addActiveProfiles(document.getActiveProfiles());
            addIncludedProfiles(document.getIncludeProfiles());
            loaded.add(document);
         }
      }
}

最后形成有优先级顺序的PropertySource集合，其顺序如下：

故开发者可以从Environment中获取系统相关所有配置信息，包括系统和Java环境信息、容器和应用程序配置，例如

environment.getProperty(“user.home”) 获取系统环境用户目录
environment.getProperty(“java.vendor”) 获取Java环境JDK厂商
environment.getProperty(“random.int(3,10)”) 通过随机化配置获取[3,10)之间的随机数
environment.getProperty(“server.port”) 获取配置文件中容器监听端口

3、配置实践

3.1 Active Profile配置

从上面的分析可以看出指定profile的配置优先于默认配置，故可以把与环境无关的配置放在application.yaml中，环境相关的配置写在application-${profile}.yaml中。其中激活profile指定有三种方式：

命令行启动参数设置 --spring.profiles.active={profile}
Java环境或系统环境变量 spring.profiles.active={profile}
application.yaml中spring.profiles.active配置项

其实这三种都还是通过Environment自身的PropertySource获取的，分别是CommandLinePropertySource、SystemEnvironmentPropertySource和MapPropertySource#application.yaml。优先级从前到后，命令行指定的profile优先级最高，其次是环境变量，最后才是配置文件。前两种一般是本地开发测试时使用，大部分项目要求在打包时就需要生成特定环境的构件，所以需要在application.yaml中指定profile，实现方法一般有两种：

（1）maven profile配合 resource filter机制

通过配置maven profile指定对应不同环境的变量配置文件，application相关配置相同名称的占位符，通过maven resource filter在resource process阶段替换。举例说明：
vars目录包含dev和sit环境的变量配置文件
vars.dev.properties：

env.profile=dev

var.sit.properties

env.profile=sit

spring boot配置占位符

spring:
  profiles:
    active: ${env.profile}

maven profiles配置

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <profile.active>dev</profile.active >
        </properties>
    </profile>
    <profile>
        <id>sit</id>
        <properties>
            <profile.active >sit</profile.active >
        </properties>
    </profile>
</profiles>

占位符替换

<build>
    <filters>
        <filter>${maven.multiModuleProjectDirectory}/vars/vars.${profile.active}.properties</filter>
    </filters>
    <resources>
        <resource>
            <directory>${basedir}/src/main/resources</directory>
            <includes>
                <include>**/*.*</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

（2）maven profile指定resource目录包含多级application.yaml
在src/main/profiles包含环境相关的目录如dev、sit，每个目录都包含对应的application.yaml，如dev目录application.yaml内容为

spring:
  profiles:
    active: dev

在maven中指定resources目录包含profile对应的目录

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
        </resource>
        <resource>
            <directory>src/main/profiles/${profile.active}</directory>
        </resource>
    </resources>

src/main/resources/config目录放置环境无关的配置application.yaml和环境相关的配置application-{profile}.yaml，构建时把包含active profile的application.yaml打包到classpath:/根目录，最终构件目录是：

classpath:/
	application.yaml
	config/
		pplication.yaml、application-dev.yaml、application-sit.yaml

3.2 Inculde Profile配置

在实际项目中可能会出现不同的环境也有部分配置相同的情况，例如开发环境和测试环境数据库相同，但redis不同。若每个环境只有一个配置，相同配置项会出现在多个文件，修改时也要编辑多个地方，不符合DRY(Don’t Repeat Yourself )原则。所以应该把不同环境相同部分抽离出来成为一个profile，通过include方式引用，即便捷又清晰，也足够灵活。配置示例如下：

application-dev.yaml

spring:
  profiles:
    include: database-sit,redis-dev

application-sit.yaml

spring:
  profiles:
    include: database-sit,redis-sit

还有三个子profile配置文件application-redis-dev.yaml、application-redis-sit.yaml、application-database-sit.yaml分别配置各自参数。

当然也可以通过多个profile指定，但若应用要求运行环境具备唯一性，则需要其他配置变量配合实现，稍显繁琐，所以指定一个active profile并包含多个子profile应该是更优的解决方案。

4、苏宁易购的多环境配置设计

4.1 苏宁云环境管理

苏宁易购所有业务系统都运行在苏宁私有云上且分布在多个机房，每个业务有多个模块和部署单元，为此苏宁云在建设之初就考虑到环境相关的问题，从服务器申请、软件开发、测试到发布，环境的概念贯穿始终。

苏宁业务系统的环境是与机房(数据中心)、服务器、系统模块、统一配置相关的，需要系统设计时规划好环境信息，如XX机房集成测试环境、XX机房压测环境、XX机房生产环境。在申请资源指明环境对应的部署单元及服务器，在代码中配置相关profile信息，并在持续集成平台定义环境打包时对应的profile和部署单元。如下图是一个包含2个机房4个环境的系统：

4.2 苏宁统一配置管理(SCM)

项目源码放置配置文件对于小型项目来说比较便捷，但对于包含数千个系统的大型平台却有很多弊端如缺乏对配置数据的集中掌控，运维风险逐渐累积；配置管理工作繁杂、配置迁移人工介入过多，风险极大；无法很好的满足内控要求等等。为了解决这些问题，苏宁基于Zookeeper自研了统一配置管理系统SCM，具备毫秒级同步、本地文件和内存两级缓存、多机房部署等高可用特性，且支持版本化、回滚、流程审核、权限控制等功能。

项目中使用SCM功能需要在maven中集成snf-scm-client依赖，并在资源目录中加入一个scm.properties文件，其中配置了SCM服务器和环境信息。SCM客户端提供了配置读取和变化监听接口，业务方可以基于此能力灵活方便定制业务框架的功能。

5、总结

在项目中大家可以根据实际情况结合maven工具灵活配置profile和参数配置信息，除了设置default、active、include profile之外，YAML格式配置文件还支持多profile并设置复杂逻辑关系如production & eu-central、 production & (eu-central | eu-west)等。另外Spring Boot在各个环节都使用SPI机制，具备良好的扩展性，可以定制EnvironmentPostProcessor或PropertySourceLoader的实现满足业务框架个性化需求。

作者介绍

胡正林，苏宁科技集团消费者平台高级架构师，十余年软件开发经验，熟悉大型分布式高并发系统架构和开发，目前主要负责易购各系统架构优化与大促保障工作。
黄小虎，苏宁科技集团消费者平台购物流程架构负责人，全面负责苏宁易购商品详情页、购物车、大聚会等核心系统的优化及大促保障工作。对电商交易流程和业务有较深入的思考和研究，专注于高并发大型电商网站的架构设计、高可用的系统设计。曾主导和参与了 Commerce 系统拆分、商品详情页接入层优化、云信客服系统重构等重大技术攻关项目。现致力于打造苏宁易购新一代核心购物流程系统，希望将购物体验做到极致。

创作场景

Spring Boot 多环境配置最佳实践