Web项目开发中,经常需要自定义一些属性,如数据库连接,第三方服务接口地址,第三方服务的appKey、appSecret等,以及针对不同环境,这些属性的值还需要有相应的调整,如开发环境、测试环境、生产环境所用数据库不同,则针对不同环境的同一属性需要配置不同的值。
传统自定义属性配置及访问
在传统的Spring Web应用中,自定义属性一般是通过在类路径中(如resources目录)添加一个类似my.properties配置文件(文件名自定义),然后在xml配置中通过
引入属性文件。再定义一个Bean来读取这些属性,Bean配置:
Bean定义:
public class MyPropertiesUtil { private static Properties properties; public static void init(Properties props) { properties = props; } public static String getValue(String key) { return properties.getProperty(key); }}
在其它需要访问的地方通过 MyPropertiesUtil.getValue() 方法来访问具体某个属性的值。
Spring Boot自定义属性配置及优先级
在Spring Boot中,可以在多个地方配置属性,包括.properties文件,.yaml文件,环境变量, 系统属性,命令行参数等, 这些属性都会被Spring Boot加载到Environment中,可通过@Value注解,Environment实例,或 @ConfigurationProperties注解的类来访问。
属性加载优先级顺序:
- 如果有使用devtools,devtools 全局设置的属性(用户目录 ~/.spring-bootdevtools.properties)
- 测试类的注解@TestPropertySource
- 测试类注解 @SpringBootTest#properties 配置的属性
- 命令行参数
- SPRING_APPLICATION_JSON里的属性(环境变量或系统属性)
- ServletConfig初始化参数
- ServletContext初始化参数
- JNDI参数 java:comp/env
- Java系统属性 System.getProperties()
- 操作系统环境变量
- RandomValuePropertySource 配置的属性 random.*
- jar包外部的applictaion-{profile}.properties,applictaion-{profile}.yml配置文件
- jar包内部的applictaion-{profile}.properties,applictaion-{profile}.yml配置文件
- jar包外部的applictaion.properties,applictaion.yml配置文件
- jar包内部的applictaion.properties,applictaion.yml配置文件
- @Configuration类上的 @PropertySource注解指定的配置文件
- 默认属性: SpringApplication.setDefaultProperties
上述属性配置,除了粗体标注的外,其它一般应用较少。序号低的配置优先级高于序号高的配置,即如果存在相同属性配置 ,则序号低的配置会覆盖序号高的配置。applictaion-{profile}.properties 一般用于具体某个环境特有的属性配置,如application-dev.properties用于开发环境,可通过 spring.profiles.active=dev指定加载dev环境配置
常用属性配置方式
- 命令行参数
- 启动Spring Boot应用时,可以指定命令行参数,如:
java -jar springboot-properties.jar --my.name=jboost@command_line
该参数值将会覆盖应用在其它地方配置的同名属性值。命令行参数放在xx.jar 的后面。
可以通过SpringApplication.setAddCommandLineProperties(false) 禁用命令行参数配置
- Java系统属性
- 同样在启动Spring Boot应用时,可以指定Java系统属性,一般见于自定义jvm参数,如:
java -Dmy.name=jboost@system_properties -jar springboot-properties.jar
Java系统属性放在java命令之后。
- 操作系统环境变量(实际应用其实较少)
- 配置过JAVA_HOME的应该理解何为环境变量。某些操作系统可能不支持.分隔的属性名,可以改为以下划线连接。Spring Boot将myName, my.name, MY_NAME视为等效。
- 应用属性配置文件(.properties文件或 .yml文件)
- .properties文件属性配置格式:
my.name=jboostmy.list[0]=aaa //配置列表my.list[1]=bbb
.yml文件属性配置格式:
my: name: devlink list: //配置列表 - aaa - bbb
yml中,属性名与值之间冒号后面必须有空格。
应用属性配置文件位置:
- jar包所在当前目录下的子目录/config(外置属性文件)
- jar包所在当前目录(外置属性文件)
- classpath根目录下的子目录/config(内置属性文件)
- classpath根目录(内置属性文件)
序号低的优先级高于序号高的优先级,即jar包外的配置优先级高于jar包内的配置。同一目录下,.properties文件的优先级高于.yml文件。application-{profile}.properties的优先级高于application.properties。
Spring Boot自定义属性访问方式
- 类中属性上添加 @Value(“${xx}”) 注解方式。如:
@Value("${my.name}")private String name;
可以指定默认值,如 @Value(“${my.name:jboost}”), 当my.name未配置时,默认使用值”jboost”
- 通过@ConfigurationProperties注解的类来访问。如定义:
@Component@ConfigurationProperties(prefix = "my")public class MyConfigProperties { private String name; private String website; //省略了getter、setter函数}
然后在需要访问的Bean中,通过@Autowired 注入MyConfigProperties实例,通过getName()方法即可访问my.name属性值。
@Autowiredprivate MyConfigProperties myConfigProperties;@Testpublic void testConfigurationProperties(){ System.out.println("test @ConfigurationProperties =========="); System.out.println(myConfigProperties.getName()); System.out.println(myConfigProperties.getWebsite());}
- 通过Environment 实例访问。如:
@Autowiredprivate Environment env;@Testpublic void testEnvironment(){ System.out.println("test Environment =========="); System.out.println(env.getProperty("my.name")); System.out.println(env.getProperty("my.website