Spring Boot 配置文件中的花样，看这一篇足矣！

叁歲伎倆 2022-10-01 05:54 13阅读 0赞

在[快速入门][Link 1]一节中，我们轻松的实现了一个简单的RESTful API应用，体验了一下Spring Boot给我们带来的诸多优点，我们用非常少的代码量就成功的实现了一个Web应用，这是传统的Spring应用无法办到的，虽然我们在实现Controller时用到的代码是一样的，但是在配置方面，相信大家也注意到了，在上面的例子中，除了Maven的配置之后，就没有引入任何的配置。

这就是之前我们所提到的，Spring Boot针对我们常用的开发场景提供了一系列自动化配置来减少原本复杂而又几乎很少改动的模板化配置内容。但是，我们还是需要去了解如何在Spring Boot中修改这些自动化的配置内容，以应对一些特殊的场景需求，比如：我们在同一台主机上需要启动多个基于Spring Boot的web应用，若我们不为每个应用指定特别的端口号，那么默认的8080端口必将导致冲突。

如果您还有在读我的[Spring Cloud系列教程][Spring Cloud]，其实有大量的工作都会是针对配置文件的。所以我们有必要深入的了解一些关于Spring Boot中的配置文件的知识，比如：它的配置方式、如何实现多环境配置，配置信息的加载顺序等。

## 配置基础 ##

在[快速入门][Link 1]示例中，我们介绍Spring Boot的工程结构时，有提到过 `src/main/resources`目录是Spring Boot的配置目录，所以我们要为应用创建配置个性化配置时，就是在该目录之下。

Spring Boot的默认配置文件位置为： `src/main/resources/application.properties`。关于Spring Boot应用的配置内容都可以集中在该文件中了，根据我们引入的不同Starter模块，可以在这里定义诸如：容器端口名、数据库链接信息、日志级别等各种配置信息。比如，我们需要自定义web模块的服务端口号，可以在`application.properties`中添加`server.port=8888`来指定服务端口为8888，也可以通过`spring.application.name=hello`来指定应用名（该名字在Spring Cloud应用中会被注册为服务名）。

Spring Boot的配置文件除了可以使用传统的properties文件之外，还支持现在被广泛推荐使用的YAML文件。

> YAML（英语发音：/ˈjæməl/，尾音类似camel骆驼）是一个可读性高，用来表达资料序列的格式。YAML参考了其他多种语言，包括：C语言、Python、Perl，并从XML、电子邮件的数据格式（RFC 2822）中获得灵感。Clark Evans在2001年首次发表了这种语言，另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。目前已经有数种编程语言或脚本语言支援（或者说解析）这种语言。YAML是"YAML Ain’t a Markup Language"（YAML不是一种标记语言）的递回缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言），但为了强调这种语言以数据做为中心，而不是以标记语言为重点，而用反向缩略语重新命名。AML的语法和其他高阶语言类似，并且可以简单表达清单、散列表，标量等资料形态。它使用空白符号缩排和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种设定档、倾印除错内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。尽管它比较适合用来表达阶层式（hierarchical model）的数据结构，不过也有精致的语法可以表示关联性（relational model）的资料。由于YAML使用空白字元和分行来分隔资料，使得它特别适合用grep／Python／Perl／Ruby操作。其让人最容易上手的特色是巧妙避开各种封闭符号，如：引号、各种括号等，这些符号在巢状结构时会变得复杂而难以辨认。 —— 维基百科

YAML采用的配置格式不像properties的配置那样以单纯的键值对形式来表示，而是以类似大纲的缩进形式来表示。比如：下面的一段YAML配置信息

environments:
        dev:
            url: http://dev.bar.com
            name: Developer Setup
        prod:
            url: http://foo.bar.com
            name: My Cool App

与其等价的properties配置如下。

environments.dev.url=http://dev.bar.com
    environments.dev.name=Developer Setup
    environments.prod.url=http://foo.bar.com
    environments.prod.name=My Cool App

通过YAML的配置方式，我们可以看到配置信息利用阶梯化缩进的方式，其结构显得更为清晰易读，同时配置内容的字符量也得到显著的减少。除此之外，YAML还可以在一个单个文件中通过使用`spring.profiles`属性来定义多个不同的环境配置。例如下面的内容，在指定为test环境时，`server.port`将使用8882端口；而在prod环境，`server.port`将使用8883端口；如果没有指定环境，`server.port`将使用8881端口。

server:
        port: 8881
    ---
    spring:
        profiles: test
    server:
        port: 8882
    ---
    spring:
        profiles: prod
    server:
        port: 8883

**注意：YAML目前还有一些不足，它无法通过`@PropertySource`注解来加载配置。但是，YAML加载属性到内存中保存的时候是有序的，所以当配置文件中的信息需要具备顺序含义时，YAML的配置方式比起properties配置文件更有优势。**

### 自定义参数 ###

我们除了可以在Spring Boot的配置文件中设置各个Starter模块中预定义的配置属性，也可以在配置文件中定义一些我们需要的自定义属性。比如在`application.properties`中添加：

book.name=SpringCloudInAction
    book.author=ZhaiYongchao

然后，在应用中我们可以通过`@Value`注解来加载这些自定义的参数，比如：

@Component
    public class Book { 
    
        @Value("${book.name}")
        private String name;
        @Value("${book.author}")
        private String author;
    
        // 省略getter和setter
    }

`@Value`注解加载属性值的时候可以支持两种表达式来进行配置：

*  一种是我们上面介绍的PlaceHolder方式，格式为 `${...}`，大括号内为PlaceHolder
 *  另外还可以使用SpEL表达式（Spring Expression Language）， 格式为 `#{...}`，大括号内为SpEL表达式

### 参数引用 ###

在`application.properties`中的各个参数之间，我们也可以直接通过使用PlaceHolder的方式来进行引用，就像下面的设置：

book.name=SpringCloud
    book.author=ZhaiYongchao
    book.desc=${book.author}  is writing《${book.name}》

`book.desc`参数引用了上文中定义的`book.name`和`book.author`属性，最后该属性的值就是`ZhaiYongchao is writing《SpringCloud》`。

### 使用随机数 ###

在一些特殊情况下，有些参数我们希望它每次加载的时候不是一个固定的值，比如：密钥、服务端口等。在Spring Boot的属性配置文件中，我们可以通过使用`${random}`配置来产生随机的int值、long值或者string字符串，这样我们就可以容易的通过配置来属性的随机生成，而不是在程序中通过编码来实现这些逻辑。

`${random}`的配置方式主要有一下几种，读者可作为参考使用。

# 随机字符串
    com.didispace.blog.value=${random.value}
    # 随机int
    com.didispace.blog.number=${random.int}
    # 随机long
    com.didispace.blog.bignumber=${random.long}
    # 10以内的随机数
    com.didispace.blog.test1=${random.int(10)}
    # 10-20的随机数
    com.didispace.blog.test2=${random.int[10,20]}

**该配置方式可以用于设置应用端口等场景，避免在本地调试时出现端口冲突的麻烦**

### 命令行参数 ###

回顾一下在本章的快速入门中，我们还介绍了如何启动Spring Boot应用，其中提到了使用命令`java -jar`命令来启动的方式。该命令除了启动应用之外，还可以在命令行中来指定应用的参数，比如：`java -jar xxx.jar --server.port=8888`，直接以命令行的方式，来设置server.port属性，另启动应用的端口设为8888。

在命令行方式启动Spring Boot应用时，连续的两个减号`--`就是对`application.properties`中的属性值进行赋值的标识。所以，`java -jar xxx.jar --server.port=8888`命令，等价于我们在`application.properties`中添加属性`server.port=8888`。

通过命令行来修改属性值是Spring Boot非常重要的一个特性，通过此特性，理论上已经使得我们应用的属性在启动前是可变的，所以其中端口号也好、数据库连接也好，都是可以在应用启动时发生改变，而不同于以往的Spring应用通过Maven的Profile在编译器进行不同环境的构建。其最大的区别就是，Spring Boot的这种方式，可以让应用程序的打包内容，贯穿开发、测试以及线上部署，而Maven不同Profile的方案每个环境所构建的包，其内容本质上是不同的。但是，如果每个参数都需要通过命令行来指定，这显然也不是一个好的方案，所以下面我们看看如果在Spring Boot中实现多环境的配置。

### 多环境配置 ###

我们在开发任何应用的时候，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。

对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单。

在Spring Boot中多环境配置文件名需要满足`application-{profile}.properties`的格式，其中`{profile}`对应你的环境标识，比如：

*  `application-dev.properties`：开发环境
 *  `application-test.properties`：测试环境
 *  `application-prod.properties`：生产环境

至于哪个具体的配置文件会被加载，需要在`application.properties`文件中通过`spring.profiles.active`属性来设置，其值对应配置文件中的`{profile}`值。如：`spring.profiles.active=test`就会加载`application-test.properties`配置文件内容。

下面，以不同环境配置不同的服务端口为例，进行样例实验。

*  针对各环境新建不同的配置文件`application-dev.properties`、`application-test.properties`、`application-prod.properties`
 *  在这三个文件均都设置不同的`server.port`属性，如：dev环境设置为1111，test环境设置为2222，prod环境设置为3333
 *  application.properties中设置`spring.profiles.active=dev`，就是说默认以dev环境设置
 *  测试不同配置的加载
 *  执行`java -jar xxx.jar`，可以观察到服务端口被设置为`1111`，也就是默认的开发环境（dev）
 *  执行`java -jar xxx.jar --spring.profiles.active=test`，可以观察到服务端口被设置为`2222`，也就是测试环境的配置（test）
 *  执行`java -jar xxx.jar --spring.profiles.active=prod`，可以观察到服务端口被设置为`3333`，也就是生产环境的配置（prod）

按照上面的实验，可以如下总结多环境的配置思路：

*  `application.properties`中配置通用内容，并设置`spring.profiles.active=dev`，以开发环境为默认配置
 *  `application-{profile}.properties`中配置各个环境不同的内容
 *  通过命令行方式去激活不同环境的配置

### 加载顺序 ###

在上面的例子中，我们将Spring Boot应用需要的配置内容都放在了项目工程中，虽然我们已经能够通过`spring.profiles.active`或是通过Maven来实现多环境的支持。但是，当我们的团队逐渐壮大，分工越来越细致之后，往往我们不需要让开发人员知道测试或是生成环境的细节，而是希望由每个环境各自的负责人（QA或是运维）来集中维护这些信息。那么如果还是以这样的方式存储配置内容，对于不同环境配置的修改就不得不去获取工程内容来修改这些配置内容，当应用非常多的时候就变得非常不方便。同时，配置内容都对开发人员可见，本身这也是一种安全隐患。对此，现在出现了很多将配置内容外部化的框架和工具，后续将要介绍的Spring Cloud Config就是其中之一，为了后续能更好的理解Spring Cloud Config的加载机制，我们需要对Spring Boot对数据文件的加载机制有一定的了解。

Spring Boot为了能够更合理的重写各属性的值，使用了下面这种较为特别的属性加载顺序：

1.  命令行中传入的参数。
2.  `SPRING_APPLICATION_JSON`中的属性。`SPRING_APPLICATION_JSON`是以JSON格式配置在系统环境变量中的内容。
3.  `java:comp/env`中的`JNDI`属性。
4.  Java的系统属性，可以通过`System.getProperties()`获得的内容。
5.  操作系统的环境变量
6.  通过`random.*`配置的随机属性
7.  位于当前应用jar包之外，针对不同`{profile}`环境的配置文件内容，例如：`application-{profile}.properties`或是`YAML`定义的配置文件
8.  位于当前应用jar包之内，针对不同`{profile}`环境的配置文件内容，例如：`application-{profile}.properties`或是`YAML`定义的配置文件
9.  位于当前应用jar包之外的`application.properties`和`YAML`配置内容
10. 位于当前应用jar包之内的`application.properties`和`YAML`配置内容
11. 在`@Configuration`注解修改的类中，通过`@PropertySource`注解定义的属性
12. 应用默认属性，使用`SpringApplication.setDefaultProperties`定义的内容

**优先级按上面的顺序有高到低，数字越小优先级越高。**

可以看到，其中第7项和第9项都是从应用jar包之外读取配置文件，所以，实现外部化配置的原理就是从此切入，为其指定外部配置文件的加载位置来取代jar包之内的配置内容。通过这样的实现，我们的工程在配置中就变的非常干净，我们只需要在本地放置开发需要的配置即可，而其他环境的配置就可以不用关心，由其对应环境的负责人去维护即可。

## 2.x 新特性 ##

在Spring Boot 2.0中推出了Relaxed Binding 2.0，对原有的属性绑定功能做了非常多的改进以帮助我们更容易的在Spring应用中加载和读取配置信息。下面本文就来说说Spring Boot 2.0中对配置的改进。

### 配置文件绑定 ###

#### 简单类型 ####

在Spring Boot 2.0中对配置属性加载的时候会除了像1.x版本时候那样**移除特殊字符**外，还会将配置均以**全小写**的方式进行匹配和加载。所以，下面的4种配置方式都是等价的：

*  properties格式：

spring.jpa.databaseplatform=mysql
    spring.jpa.database-platform=mysql
    spring.jpa.databasePlatform=mysql
    spring.JPA.database_platform=mysql

*  yaml格式：

spring:
      jpa:
        databaseplatform: mysql
        database-platform: mysql
        databasePlatform: mysql
        database_platform: mysql

**Tips：推荐使用全小写配合`-`分隔符的方式来配置，比如：`spring.jpa.database-platform=mysql`**

#### List类型 ####

在properties文件中使用`[]`来定位列表类型，比如：

spring.my-example.url[0]=http://example.com
    spring.my-example.url[1]=http://spring.io

也支持使用**逗号**分割的配置方式，上面与下面的配置是等价的：

spring.my-example.url=http://example.com,http://spring.io

而在yaml文件中使用可以使用如下配置：

spring:
      my-example:
        url:
          - http://example.com
          - http://spring.io

也支持**逗号**分割的方式：

spring:
      my-example:
        url: http://example.com, http://spring.io

**注意：在Spring Boot 2.0中对于List类型的配置必须是连续的，不然会抛出`UnboundConfigurationPropertiesException`异常，所以如下配置是不允许的：**

foo[0]=a
    foo[2]=b

**在Spring Boot 1.x中上述配置是可以的，`foo[1]`由于没有配置，它的值会是`null`**

#### Map类型 ####

Map类型在properties和yaml中的标准配置方式如下：

*  properties格式：

spring.my-example.foo=bar
    spring.my-example.hello=world

*  yaml格式：

spring:
      my-example:
        foo: bar
        hello: world

**注意：如果Map类型的key包含非字母数字和`-`的字符，需要用`[]`括起来，比如：**

spring:
      my-example:
        '[foo.baz]': bar

### 环境属性绑定 ###

**简单类型**

在环境变量中通过小写转换与`.`替换`_`来映射配置文件中的内容，比如：环境变量`SPRING_JPA_DATABASEPLATFORM=mysql`的配置会产生与在配置文件中设置`spring.jpa.databaseplatform=mysql`一样的效果。

**List类型**

由于环境变量中无法使用`[`和`]`符号，所以使用`_`来替代。任何由下划线包围的数字都会被认为是`[]`的数组形式。比如：

MY_FOO_1_ = my.foo[1]
    MY_FOO_1_BAR = my.foo[1].bar
    MY_FOO_1_2_ = my.foo[1][2]

另外，最后环境变量最后是以数字和下划线结尾的话，最后的下划线可以省略，比如上面例子中的第一条和第三条等价于下面的配置：

MY_FOO_1 = my.foo[1]
    MY_FOO_1_2 = my.foo[1][2]

### 系统属性绑定 ###

**简单类型**

系统属性与文件配置中的类似，都以移除特殊字符并转化小写后实现绑定，比如下面的命令行参数都会实现配置`spring.jpa.databaseplatform=mysql`的效果：

-Dspring.jpa.database-platform=mysql
    -Dspring.jpa.databasePlatform=mysql
    -Dspring.JPA.database_platform=mysql

**List类型**

系统属性的绑定也与文件属性的绑定类似，通过`[]`来标示，比如：

-D"spring.my-example.url[0]=http://example.com"
    -D"spring.my-example.url[1]=http://spring.io"

同样的，他也支持逗号分割的方式，比如：

-Dspring.my-example.url=http://example.com,http://spring.io

### 属性的读取 ###

上文介绍了Spring Boot 2.0中对属性绑定的内容，可以看到对于一个属性我们可以有多种不同的表达，但是如果我们要在Spring应用程序的environment中读取属性的时候，每个属性的唯一名称符合如下规则：

*  通过`.`分离各个元素
 *  最后一个`.`将前缀与属性名称分开
 *  必须是字母（a-z）和数字(0-9)
 *  必须是小写字母
 *  用连字符`-`来分隔单词
 *  唯一允许的其他字符是`[`和`]`，用于List的索引
 *  不能以数字开头

所以，如果我们要读取配置文件中`spring.jpa.database-platform`的配置，可以这样写：

this.environment.containsProperty("spring.jpa.database-platform")

而下面的方式是无法获取到`spring.jpa.database-platform`配置内容的：

this.environment.containsProperty("spring.jpa.databasePlatform")

**注意：使用`@Value`获取配置内容的时候也需要这样的特点**

### 全新的绑定API ###

在Spring Boot 2.0中增加了新的绑定API来帮助我们更容易的获取配置信息。下面举个例子来帮助大家更容易的理解：

**例子一：简单类型**

假设在propertes配置中有这样一个配置：`com.didispace.foo=bar`

我们为它创建对应的配置类：

@Data
    @ConfigurationProperties(prefix = "com.didispace")
    public class FooProperties { 
    
        private String foo;
    
    }

接下来，通过最新的`Binder`就可以这样来拿配置信息了：

@SpringBootApplication
    public class Application { 
    
        public static void main(String[] args) { 
            ApplicationContext context = SpringApplication.run(Application.class, args);
    
            Binder binder = Binder.get(context.getEnvironment());
    
            // 绑定简单配置
            FooProperties foo = binder.bind("com.didispace", Bindable.of(FooProperties.class)).get();
            System.out.println(foo.getFoo());
        }
    }

**例子二：List类型**

如果配置内容是List类型呢？比如：

com.didispace.post[0]=Why Spring Boot
    com.didispace.post[1]=Why Spring Cloud
    
    com.didispace.posts[0].title=Why Spring Boot
    com.didispace.posts[0].content=It is perfect!
    com.didispace.posts[1].title=Why Spring Cloud
    com.didispace.posts[1].content=It is perfect too!

要获取这些配置依然很简单，可以这样实现：

ApplicationContext context = SpringApplication.run(Application.class, args);
    
    Binder binder = Binder.get(context.getEnvironment());
    
    // 绑定List配置
    List<String> post = binder.bind("com.didispace.post", Bindable.listOf(String.class)).get();
    System.out.println(post);
    
    List<PostInfo> posts = binder.bind("com.didispace.posts", Bindable.listOf(PostInfo.class)).get();
    System.out.println(posts);

## 代码示例 ##

本教程配套仓库：

*  Github：[https://github.com/dyc87112/SpringBoot-Learning/tree/2.x][https_github.com_dyc87112_SpringBoot-Learning_tree_2.x]
 *  Gitee：[https://gitee.com/didispace/SpringBoot-Learning/tree/2.x][https_gitee.com_didispace_SpringBoot-Learning_tree_2.x]

**如果您觉得本文不错，欢迎Star、Follow支持！您的关注是我坚持的动力！**

### 相关阅读 ###

*  [Spring Boot 1.x：属性配置文件详解][Spring Boot 1.x]
 *  [Spring Boot 2.0：配置绑定 2.0 全解析][Spring Boot 2.0_ 2.0]

[Link 1]: http://blog.didispace.com/spring-boot-learning-21-1-1/
[Spring Cloud]: http://blog.didispace.com/spring-cloud-learning/
[https_github.com_dyc87112_SpringBoot-Learning_tree_2.x]: https://github.com/dyc87112/SpringBoot-Learning/tree/2.x
[https_gitee.com_didispace_SpringBoot-Learning_tree_2.x]: https://gitee.com/didispace/SpringBoot-Learning/tree/2.x
[Spring Boot 1.x]: http://blog.didispace.com/springbootproperties/
[Spring Boot 2.0_ 2.0]: http://blog.didispace.com/Spring-Boot-2-0-feature-1-relaxed-binding-2/