配置文件详解包括：自定义属性、随机数、多环境配置等
很多人选择Spring Boot主要是考虑到它既能兼顾Spring的强大功能，还能实现快速开发的便捷。我们在Spring Boot使用过程中，最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容；
application.properties： 主要用来配置数据库连接、日志相关配置等。除了这些配置内容之外，本文具体介绍一些在application.properties配置中的其他特性和使用方法。
一、自定义属性与加载
我们在使用Spring Boot构建项目的时候，通常需要定义一些自己使用的属性，我们可以如下方式直接定义：
com.author.blog.name=wellscom.author.blog.url=https://www.yuque.com/wells
然后通过 @Value(“${}”) 注解来加载对应的配置属性，具体如下：
package com.wells.demo.config;import org.springframework.beans.factory.annotation.Value;import org.springframework.stereotype.Component;/*** Created by Wells on 2019年01月10日*/@Componentpublic class BlogProperties {@Value("${com.author.blog.name}")private String name;@Value("${com.author.blog.url}")private String url;// setter and getter省略}
通过单元测试来验证 BlogProperties 中的属性是否已经根据配置文件加载了：
package com.wells.demo;
import com.wells.demo.config.BlogProperties;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
@Autowired
private BlogProperties blogProperties;
@Test
public void testBlogProperties() {
Assert.assertEquals("wells", blogProperties.getName());
Assert.assertEquals("https://www.yuque.com/wells", blogProperties.getUrl());
}
}
如果相等则不会输出任何东西，否则输出如下：
二、参数间的引用
在application.properties中的各个参数之间也可以直接引用来使用，就像下面的设置：
com.author.blog.name=wells
com.author.blog.url=https://www.yuque.com/wells
com.author.blog.desc=${com.author.blog.name}的博客地址:${com.author.blog.url}
com.author.blog.desc 参数引用了上下文中定义的 com.author.blog.name 和 com.author.blog.url 属性的值，因此该属性的值就是: wells的博客地址:https://www.yuque.com/wells
三、使用随机数
在一些情况下，有些参数我们需要希望它不是一个固定的值，比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过 ${random} 来产生int值、long值或者string字符串，来支持属性的随机值。
# 随机字符串
com.wells.random.value=${random.value}
# 随机int
com.wells.random.int=${random.int}
# 随机long
com.wells.random.long=${random.long}
# 10以内的随机数
com.wells.random.int1=${random.int(10)}
# 10-20的随机数
com.wells.random.int2=${random.int[10,20]}
测试结果：
c771e5c19cbaba897328b29ac0eba698
790480319
-6891824040198920785
9
10
四、通过命令行设置属性值
在通过SpringBoot构建过web应用的用户，一定知道这条命令：
java -jar xxx.jar —server.port=8888
通过使用 —server.port 属性来设置 xxx.jar 应用的端口为8888。
在命令行运行时，连续的两个减号 — 就是对 application.properties 中的属性值进行赋值的标识。
所以，java -jar xxx.jar —server.port=8888 命令，等价于我们在 application.properties 中添加属性server.port=8888，该设置在样例工程中可见，读者可通过删除该值或使用命令行来设置该值来验证。
注意：
通过命令行来修改属性值固然提供了不错的便利性，但是通过命令行就能更改应用运行的参数，那岂不是很不安全？是的，所以Spring Boot也贴心的提供了屏蔽命令行访问属性的设置，只需要将这句添加到主类中就能屏蔽：
SpringApplication.setAddCommandLineProperties(false)
五、多环境配置
在开发Spring Boot Web应用时，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。
对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单：
在Spring Boot中多环境配置文件名需要满足 application-{profile}.properties 的格式，其中 profile 对应你的环境标识，比如：
- application-dev.properties：开发环境
- application-test.properties：测试环境
- application-prod.properties：生产环境
至于哪个具体的配置文件会被加载，需要在 application.properties 文件中通过 spring.profile.active 属性来设置，其值对应 {profile} 值，例如：
spring.profiles.active=test 就会加载application-test.properties 配置文件内容
下面，以不同环境配置不同的服务端口为例，进行样例实验。
- 针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties
- 在这三个文件均都设置不同的 server.port 属性，如：dev环境设置为8080，test环境设置为8081，prod环境设置为8082
- application.properties中设置spring.profiles.active=dev，就是说默认以dev环境设置
- 测试不同配置的加载
- 执行java -jar xxx.jar，可以观察到服务端口被设置为8080，也就是默认的开发环境（dev）
- 执行java -jar xxx.jar —spring.profiles.active=test，可以观察到服务端口被设置为8081，也就是测试环境的配置（test）
- 执行java -jar xxx.jar —spring.profiles.active=prod，可以观察到服务端口被设置为8082，也就是生产环境的配置（prod）
按照上面的实验，可以如下总结多环境的配置思路：
- application.properties中配置通用内容，并设置spring.profiles.active=dev，以开发环境为默认配置
- application-{profile}.properties中配置各个环境不同的内容
- 通过命令行方式去激活不同环境的配置
六、配置文件加载顺序
SpringBoot配置文件可以使用yml格式和properties格式
分别的默认命名为：application.yml、application.properties
存放目录
SpringBoot配置文件默认可以放到以下目录中，可以自动读取到：
- 项目根目录中config目录下
- 项目根目录下
- 项目resources目录中config目录下
- 项目的resources目录下
读取顺序
如果在不同的目录中存在多个配置文件，它的读取顺序是：
- config/application.properties（项目根目录中config目录下）
- config/application.yml（项目根目录中config目录下）
- application.properties（项目根目录下）
- application.yml（项目根目录下）
- resources/config/application.properties（项目resources目录中config目录下）
- resources/config/application.yml（项目resources目录中config目录下）
- resources/application.properties（项目的resources目录下）
resources/application.yml（项目的resources目录下）
注意：
- 如果同一个目录下，有application.yml也有application.properties，默认先读取application.properties。
- 如果同一个配置属性，在多个配置文件都配置了，默认使用第1个读取到的，后面读取的不覆盖前面读取到的。
- 创建SpringBoot项目时，一般的配置文件放置在 “项目的resources目录下”
多知道点：
application.yml配置如下：
com:
author:
blog:
name: root.config.yml.wells
url: https://www.yuque.com/wells
key后面的冒号，后面一定要跟一个空格，否则会读取失败
七、代码示例
完整示例：SpringBoot配置文件详解
若有收获，就点个赞吧
0 人点赞
