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

在快速入门一节中，咱们轻松的实现了一个简单的RESTful API应用，体验了一下Spring Boot给咱们带来的诸多优势，咱们用很是少的代码量就成功的实现了一个Web应用，这是传统的Spring应用没法办到的，虽然咱们在实现Controller时用到的代码是同样的，可是在配置方面，相信你们也注意到了，在上面的例子中，除了Maven的配置以后，就没有引入任何的配置。java

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

若是您还有在读个人Spring Cloud系列教程，其实有大量的工做都会是针对配置文件的。因此咱们有必要深刻的了解一些关于Spring Boot中的配置文件的知识，好比：它的配置方式、如何实现多环境配置，配置信息的加载顺序等。git

配置基础

在快速入门示例中，咱们介绍Spring Boot的工程结构时，有提到过 src/main/resources目录是Spring Boot的配置目录，因此咱们要为应用建立配置个性化配置时，就是在该目录之下。github

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

Spring Boot的配置文件除了可使用传统的properties文件以外，还支持如今被普遍推荐使用的YAML文件。spring

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操做。其让人最容易上手的特点是巧妙避开各类封闭符号，如：引号、各类括号等，这些符号在巢状结构时会变得复杂而难以辨认。 —— 维基百科sql

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为了可以更合理的重写各属性的值，使用了下面这种较为特别的属性加载顺序：

命令行中传入的参数。
SPRING_APPLICATION_JSON中的属性。SPRING_APPLICATION_JSON是以JSON格式配置在系统环境变量中的内容。
java:comp/env中的JNDI属性。
Java的系统属性，能够经过System.getProperties()得到的内容。
操做系统的环境变量
经过random.*配置的随机属性
位于当前应用jar包以外，针对不一样{profile}环境的配置文件内容，例如：application-{profile}.properties或是YAML定义的配置文件
位于当前应用jar包以内，针对不一样{profile}环境的配置文件内容，例如：application-{profile}.properties或是YAML定义的配置文件
位于当前应用jar包以外的application.properties和YAML配置内容
位于当前应用jar包以内的application.properties和YAML配置内容
在@Configuration注解修改的类中，经过@PropertySource注解定义的属性
应用默认属性，使用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：github.com/dyc87112/Sp…
Gitee：gitee.com/didispace/S…

若是您以为本文不错，欢迎Star、Follow支持！您的关注是我坚持的动力！