1. 自动配置
Spring Boot提供了对应进行自动化配置。相对于xml来说,是不需要自己显示的申明的,大多数情况下,默认的配置基本可以实现开发功能。
Spring Boot不单单从application.propertes获取配置,我们可以在程序中多种设置配置属性。属性的获取是有优先级的,如下列表:
- Devtools的全局设置文件,在主目录下面如,~/.spring-boot-devtools.properties,这个时候Devtools需要激活。
- 在测试类中使用@TestPropertySource注解。
- 在使用@SpringBootTest注解的测试类中,指定配置通过@SpringBootTest的properties属性,比如:
@SpringBootTest(properties = {"user.name=hello","user.age=10"})
这样会覆盖user.name和user.age的属性值 - 命令行参数
通过 java -jar app.jar --name="spring" --server.port=9999方式来传递参数。参数可以是自定义的,也可以是SpringBoot默认的参数。spring常用的应用属性,可以参考这里Spring Boot参数 - 来自java:comp/env的JNDI属性
- java系统属性(System.getProperties())
- 操作系统的环境变量
- RandomValuePropertySource配置的random.*属性值
- jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
- jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
- jar包外部的application.properties或application.yml(不带spring.profile)配置文件
- jar包内部的application.properties或application.yml(不带spring.profile)配置文件
- @Configuration注解类上的@PropertySource
- 通过SpringApplication.setDefaultProperties指定的默认属性
2. 属性文件位置
SpringApplication会根据application.properties或者application.yml文件,将属性加载到spring的环境中,文件查找的顺序如下:
- 当前文件夹下的 /config目录
- 当前目录
- 类路径classPath下面的/config包
- classPath根路径
3. 属性的使用
使用@Value注解
通过@Value注解可以将属性值注入进来使用@ConfigurationProperties
Spring Boot可以方便的将一个属性注入到一个配置对象中。举个例子,编写配置属性类。
@Component
@ConfigurationProperties(prefix = "home")//将配置文件中以 home 前缀的属性值自动绑定到对应的字段中
@Data
public class HomeProperties {
private String province;
private String city;
private String desc;
//家乡特产
private List<String> specialty = new ArrayList<>();
}
上面的代码的set和get方法使用lombook的@Data自动完成 。再配置属性文件application.properties或者application.yml
home.province=ZheJiang
home.city=WenLing
home.desc=dev: I'm living in ${home.province} ${home.city}.
home.specialty[0]=specialty1
home.specialty[1]=specialty2
Spring Boot会自动将prefix = "home"前缀为home的属性注入到对应的类中。上面的配置文件中使用了占位符,后面会讲到,对于list类型的属性,Spring Boot会自动进行类型装换,注意List需要进行初始化
- 属性占位符
前面的例子中已经看到了占位符的使用。
home.desc=dev: I'm living in ${home.province} ${home.city}.
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。通过如${home.province:默认名称}方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。由于${}方式会被Maven处理。如果你pom继承的spring-boot-starter-parent,Spring Boot 已经将maven-resources-plugins默认的${}方式改为了@ @方式,例如@name@。
- profile文件指定
在开发过程中有时候需要根据不同的环境进行不同的配置,可以根据环境配置不同的参数。在application.properties中指定spring.profiles.active的值,然后再配置相应的环境配置文件,格式如下:application-{profile}.properties。比如application.properties指定环境为dev环境
spring.profiles.active=dev
编写application-dev.properties和application-prod.properties属性文件,Spring Boot加载的时候会加载application-dev.properties文件的配置。
- 属性验证
可以使用JSR-303注解进行验证,例如:
@Component
@ConfigurationProperties(prefix = "home")//将配置文件中以 home 前缀的属性值自动绑定到对应的字段中
@Data
@Validated
public class HomeProperties {
@NotNull
private String province1;
private String city;
private String desc;
//家乡特产
private List<String> specialty = new ArrayList<>();
}
使用JSR-303的注解@Validated标志在对于的类上面,然后使用 @NotNull注解标识属性不能为空。