配置文件application.properties

配置文件application.properties

Spring Boot通过pom.xml中引入模块化的Stater,使得常规的开发场景可以很快把应用搭建起来。在使用Spring Boot的过程中,除了可以在pom.xml中配置一些内容外,一些项目相关的配置也可以在application.properties中通过配置来完成。application.properties的默认配置查看这里。

一般属性使用

比如我们可以配置程序的端口,名字等,这类一般属性配置后是直接可以被Spring Boot识别使用的,如下:

spring.application.name=compute-service
server.port=80
server.tomcat.uri-encoding=GBK

自定义属性

跟一般属性类似,我们也可以定义我们自己的属性,比如:

com.blog.name=博客
com.blog.uri=博客地址

但是自定义的属性需要通过 @Value 注解来匹配才能让Spring Boot识别出来:

@Component
public class BlogConfig {

    @Value("${com.blog.name}")
    private String name;

    @Value("${com.blog.uri}")
    private String uri;

    // 省略getter和setter
}

参数引用

application.properties中定义的属性可以直接被其他配置引用:

com.blog.name=博客
com.blog.uri=博客地址
com.blog.title=${com.blog.name}的地址是${com.blog.uri}

使用随机数

在一些情况下,有些参数我们需要希望它不是一个固定的值,比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}来产生int值、long值或者string字符串,来支持属性的随机值:

# 随机字符串
com.blog.stringValue=${random.value}
# 随机int
com.blog.numberValue=${random.int}
# 随机long
com.blog.bignumberValue=${random.long}
# 10以内的随机数
com.blog.randomValue0=${random.int(10)}
# 10-20的随机数
com.blog.randomValue1=${random.int[10,20]}

命令行替代application.properties

相信使用过一段时间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配置文件内容。

配置文件的优先级

SpringApplication将从以下位置加载application.properties文件,并把它们添加到Spring Environment中:

  • 当前目录下的/config子目录
  • 当前目录
  • classpath下的/config包
  • classpath根路径(root)

该列表是按优先级排序的(列表中位置高的路径下定义的属性将覆盖位置低的)

此外,如果你在相同优先级位置同时有application.properties和application.yml,那么application.yml里面的属性就会覆盖application.properties里的属性。

你可能感兴趣的:(配置文件application.properties)