配置文件
SpringBoot使用一个文件进行全局配置,文件名是固定的:
- application.properties
- application.yaml
其作用是修改SpringBoot自动配置的默认值,这些默认值SpringBoot在底层给我们自动配置好了。
YAML语法
YAML基本语法
- 使用缩进表示层级关系
- 缩进时使用空格
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
- 大小写敏感
YAML支持三种数据结构
- 对象:键值对的集合
- 数组:一组按次序排列的值
- 字面量:单个的、不可再分的值
具体请看YAML入门教程。
配置文件注入
application.yaml配置文件内容:
person:
lastName: Scott
age: 20
boss: false
birth: 2020/02/02
maps: {k1: v1, k2: v2}
lists:
- liu
- liang
dog:
name: 旺财
age: 2
JavaBean
package com.andy.springbootdemo.entity;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 将配置文件中配置的属性值映射到这个组件中
*
* @ConfigurationProperties: 告知SpringBoot将类中的所有属性和配置文件中相关的配置进行绑定
* prefix = "person":配置文件中哪个下面的所有属性进行一一映射
*
* 只有组件是容器中的组件,才能使用容器提供的@ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;
@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + ''' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Boolean getBoss() {
return boss;
}
public void setBoss(Boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, Object> getMaps() {
return maps;
}
public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}
public List<Object> getLists() {
return lists;
}
public void setLists(List<Object> lists) {
this.lists = lists;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
}
package com.andy.springbootdemo.entity;
public class Dog {
private String name;
private Integer age;
@Override
public String toString() {
return "Dog{" +
"name='" + name + ''' +
", age=" + age +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
在POM文件中导入配置文件处理器:
<!-- 导入配置文件处理器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
此后编写配置就有提示啦!
![d44970568653b4de9fa66f2504839d8a.png](https://i-blog.csdnimg.cn/blog_migrate/24e471e42ab618144d09eff48815858e.png)
我们在test
下java
目录下包中的SpringBootDemoApplicationTests
类中编写如下代码:
package com.andy.springbootdemo;
import com.andy.springbootdemo.entity.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
/**
* SpringBoot单元测试
*
* 可以在测试期间很方便地使用自动注入等容器的功能
*/
@SpringBootTest
class SpringBootDemoApplicationTests {
@Autowired
Person person;
@Test
void contextLoads() {
System.out.println(person);
}
}
然后运行contextLoads
方法:
![adc72a6c9801a3df1f0a8108d14d9fe3.png](https://i-blog.csdnimg.cn/blog_migrate/469876b89604d4eedf954b43b008e569.png)
控制台输出如下所示:
![3db6c452aef09b703eb568f466251e7d.png](https://i-blog.csdnimg.cn/blog_migrate/d42df69578b87df06a34d12650f2ba11.png)
顺利地获取到配置文件中的数据。
接下来,我们来获取application.properties文件中的配置数据,文件中的内容如下:
person.age=12
person.birth=2020/02/02
person.boss=false
person.last-name=张三
person.lists=1,2,3
person.maps.k1=v1
person.maps.k2=v2
person.dog.name=dsff
person.dog.age=2
再次运行contextLoads
方法,控制台输出:
![72dfc2af659cf111620185d80133b304.png](https://i-blog.csdnimg.cn/blog_migrate/8cf29b6822a719af48d7011de023d1ff.png)
出现乱码了,我们设置一下即可:
![31c36e132e0fc6ff9331964e274ed388.png](https://i-blog.csdnimg.cn/blog_migrate/5efa132c84b5a74d88a89dc78e402abf.jpeg)
再次运行:
![25c5e72946fc3a7cb48da47e006998fc.png](https://i-blog.csdnimg.cn/blog_migrate/238e54b47dc53e08697f098d81dc0cba.png)
可以看到,正常输出了。
@Value获取值和@ConfigurationProperties获取值比较
我们也可以通过@Value
注解获取值
@Component
public class Person {
// ${key}从环境变量、配置文件中获取值
@Value("${person.last-name}")
private String lastName;
// #{SpEL}从表达式中获取值
@Value("#{12 + 3}")
private Integer age;
// 字面量
@Value("true")
private Boolean boss;
private Date birth;
![3868a49c02fc1bc1d60554d82b81cb3a.png](https://i-blog.csdnimg.cn/blog_migrate/23aea17915eed45cb24a57db708eceb1.png)
对比如下:
![662a737a04cc8c4815d9d8fa3d811b94.png](https://i-blog.csdnimg.cn/blog_migrate/d15d29b5b9534ff388964704a7a53fc9.png)
配置文件注入值数据校验
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
@Email
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
运行结果如下:
![824b050de0ff8b5aeba8cdc386218953.png](https://i-blog.csdnimg.cn/blog_migrate/4c8b4ce5de7abdbaa2a2b64777e880b9.png)
@PropertySource
@PropertySource
加载指定的配置文件。
@Component
@ConfigurationProperties(prefix = "person")
@PropertySource(value = {"classpath:person.properties"})
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;
person.properties文件内容如下:
person.age=12
person.birth=2020/02/02
person.boss=false
person.last-name=无敌
person.lists=1,2,3
person.maps.k1=v1
person.maps.k2=v2
person.dog.name=dsff
person.dog.age=2
运行结果:
![633f6937a8ac7a02390f1e71c27f81db.png](https://i-blog.csdnimg.cn/blog_migrate/5bbf8e048488b10b17bd778f1f6cd62c.png)
@ImportResource
导入Spring的配置文件,让配置文件中的内容生效。
配置文件占位符
随机数
${random.int}
${random.value}
${random.long}
${random.int(10)}
占位符获取之前配置的值,如果没有可以使用指定的默认值。
person.age=12
person.birth=2020/02/02
person.boss=false
person.last-name=张三${random.int}
person.lists=1,2,3
person.maps.k1=v1
person.maps.k2=v2
person.dog.name=${person.hello: kiki}
person.dog.age=2
Profile多环境支持
多Profile文件
我们在编写主配置文件时,文件名可以是application-{profile}.properties
或application-{profile}.yml
。
默认使用application.properties
文件。
YAML支持多文档块方式
server:
port: 8021
spring:
profiles:
active: dev
---
server:
port: 8023
spring:
profiles: dev
---
server:
port: 8025
spring:
profiles: prod
激活指定Profile
- 在
application.properties
文件中指定spring.profiles.active=dev
。 - 命令行指定选项
--spring.profiles.active=dev
'。 - 虚拟机参数
-Dspring.profiles.active=dev
。
![9aba5756a6b853db7fc35c997ff8f793.png](https://i-blog.csdnimg.cn/blog_migrate/d9763549ee0a8349fd34185f02186e11.jpeg)
更多内容请看Spring Boot Reference Guide。