Spring Boot配置文件详解
Spring Boot配置文件详解
导语:
相信很多⼈选择Spring Boot主要是考虑到它既能兼顾Spring的强⼤功能,还能实现快速开发的便捷。我们在Spring Boot使⽤过程中,最直观的感受就是没有了原来⾃⼰整合Spring应⽤时繁多的XML配置内容,替代它的是在 pom.xml 中引⼊模块化的 Starter POMs ,其中各个模块都有⾃⼰的默认配置,所以如果不是特殊应⽤场景,就只需要在 application.properties 中完成⼀些属性配置就能开启各模块的应⽤。
自定义属性与加载
我们在使⽤Spring Boot的时候,通常也需要定义⼀些⾃⼰使⽤的属性,我们可以如下⽅式直接定义:
com.didispace.blog.name=didi
com.didispace.blog.title=Spring Boot Learning
然后通过 @Value("${属性名}") 注解来加载对应的配置属性,具体如下:
@Component
@Data
public class BlogProperties {
@Value("${com.didispace.blog.name}")
private String name;
@Value("${com.didispace.blog.title}")
private String title;
}
按照惯例,通过单元测试来验证BlogProperties中的属性是否已经根据配置⽂件加载了。
@SpringBootTest
public class ApplicationTests {
@Autowired
private BlogProperties blogProperties;
@Test
public void getHello() {
assertEquals(blogProperties.getName(), "didi");
assertEquals(blogProperties.getTitle(), "Spring Boot Learning");
}
}
参数间的引用
在 application.properties 中的各个参数之间也可以直接引⽤来使⽤,就像下⾯的设置:
com.didispace.blog.name=didi
com.didispace.blog.title=Spring Boot Learning
com.didispace.blog.desc=${com.didispace.blog.name} is writing ${com.didispace.blog.title}
com.didispace.blog.desc 参数引⽤了上⽂中定义的 name 和 title 属性,最后该属性的值就是 didi is writing Spring Boot Learning 。
使用随机数
在⼀些情况下,有些参数我们需要希望它不是⼀个固定的值,⽐如密钥、服务端⼝等。
Spring Boot的属性配置⽂件中可以通过 ${random} 来产⽣int值、long值或者string字符串,来⽀持属性的随机值。
# 随机字符串
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 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 中配置各个环境不同的内容
- 通过命令⾏⽅式去激活不同环境的配置