24.3. 应用属性文件

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

  1. 当前目录下的/config子目录

  2. 当前目录

  3. classpath下的/config

  4. classpath根路径(root)

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

你可以使用YAML('.yml')文件替代'.properties'。

如果不喜欢将application.properties作为配置文件名,你可以通过指定spring.config.name环境属性来切换其它的文件名,也可以使用spring.config.location环境属性引用一个明确的路径(目录位置或文件路径列表以逗号分割)。下面的例子展示了怎么指定一个不同的文件名:

$ java -jar myproject.jar --spring.config.name=myproject

下面的例子展示了怎么指定两个路径:

$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

在初期需要根据spring.config.namespring.config.location决定加载哪个文件,所以它们必须定义为环境属性(通常为OS环境变量,系统属性或命令行参数)。

如果spring.config.location包含目录(相对于文件),那它们应该以/结尾(运行时,spring.config.name关联的名称会在被加载前被追加到后面,包括profile-specific的文件名)。spring.config.location下定义的文件使用方法跟往常一样,没有profile-specific变量支持的属性,会被profile-specific的属性覆盖。

配置位置按相反的顺序搜索。默认地,配置好的位置是classpath:/,classpath:/config/,file:./,file:./config/。产生的搜索顺序为:

  1. file:./config/

  2. file:./

  3. classpath:/config/

  4. classpath:/

当使用spring.config.location配置好自定义的配置位置时,它们会代替默认位置。比如,如果用值classpath:/custom-config/,file:./custom-config/配置了spring.config.location,搜索顺序会变成:

  1. file:./custom-config/

  2. classpath:custom-config/

或者,当使用spring.config.additional-location配置好自定义的配置位置时,,它们会在默认位置的基础上被使用。自定义的位置会在默认位置之前被搜索。例如,如果配置了自定义的位置classpath:/custom-config/,file:./custom-config/,搜索的顺序会变成:

  1. file:./custom-config/

  2. classpath:custom-config/

  3. file:./config/

  4. file:./

  5. classpath:/config/

  6. classpath:/

这种搜索排序允许你在一个配置文件里指定默认值,然后有选择地覆盖那些值。你可以选择默认位置中的一处,在这儿的application.properties(或者任何由spring.config.name指定的名字)里为应用设置默认值。然后,在运行时使用在自定义的位置上的不同的文件,覆盖这些默认值。

如果使用环境变量而不是系统属性,需要注意多数操作系统的key名称不允许以句号分割(period-separated),但你可以使用下划线(underscores)代替(比如,使用SPRING_CONFIG_NAME代替spring.config.name)。

如果你的应用运行在容器中,那么JNDI属性(java:comp/env)或servlet上下文初始化参数可以用来代替环境变量或系统属性,当然也可以使用环境变量或系统属性。

最后更新于