Spring Boot 配置文件详解:自定义属性、随机数、多环境配置等
相信很多人选择Spring Boot主要是考虑到它既能兼顾Spring的强大功能,还能实现快速开发的便捷。我们在Spring Boot使用过程中,最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容,替代它的是在pom.xml
中引入模块化的Starter POMs
,其中各个模块都有自己的默认配置,所以如果不是特殊应用场景,就只需要在application.properties
中完成一些属性配置就能开启各模块的应用。
自定义属性与加载
我们在使用Spring Boot的时候,通常也需要定义一些自己使用的属性,我们可以如下方式直接定义:
czc.company.name=hangzhoucezhicheng
czc.employee.name=hly
然后通过@Value("${属性名}")
注解来加载对应的配置属性,具体如下:
@Data // lombok 实现get、set、toString等方法
@Component // 声明为Spring管理的Bean
public class ConfigrationProperties {
@Value(value = "${czc.company.name}") //配置文件的key
private String companyName;
@Value(value = "${czc.employee.name}") //配置文件的key
private String employeeName;
}
通过单元测试来验证BlogProperties中的属性是否已经根据配置文件加载了。
@SpringBootTest
@RunWith(SpringRunner.class)
public class ConfigrationPropertiesTest {
@Autowired
private ConfigrationProperties configrationProperties;
@Test
public void outProperties(){
System.out.println(configrationProperties.getCompanyName());
System.out.println( configrationProperties.getEmployeeName());
}
}
输出:
参数间的引用
在application.properties
中的各个参数之间也可以直接引用来使用,就像下面的设置:
czc.company.name=hangzhoucezhicheng
czc.employee.name=hly
czc.all.names=${czc.company.name}公司的员工有${czc.employee.name}
czc.all.names参数引用了上文中定义的company.name和employee.name属性,最后该属性的值就是hangzhoucezhicheng公司的员工有hly
使用随机数
在一些情况下,有些参数我们需要希望它不是一个固定的值,比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}
来产生int值、long值或者string字符串,来支持属性的随机值
如果配置文件中的汉子出现乱码:
File -> Settings -> Editor -> File Encodings
将Properties Files (*.properties)下的Default encoding for properties files设置为UTF-8,将Transparent native-to-ascii conversion前的勾选上。
通过命令行设置属性值
相信使用过一段时间Spring Boot的用户,一定知道这条命令: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应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事。
对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,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
中配置各个环境不同的内容 - 通过命令行方式去激活不同环境的配置