本文详细介绍了SpringBoot的配置文件使用，包括.properties和.yml两种格式，以及如何通过@Value和@ConfigurationProperties注解注入配置值。还探讨了.yml文件的复杂类型封装和占位符使用。此外，文章提到了JSR303数据校验，展示了如何使用@Validated和各种校验注解确保数据合法性。最后，讨论了不同位置配置文件的加载优先级及多环境配置的切换方法。
Spring Boot学习
官网：https://spring.io/projects/spring-boot#overview
参考视频：【狂神说Java】SpringBoot最新教程IDEA版通俗易懂_哔哩哔哩_bilibili
项目完整参考代码：lexiaoyuan/SpringBootStudy: My Spring Boot study notes (github.com)、SpringBootStudy: 我的Spring Boot学习笔记 (gitee.com)
Spring Boot配置
配置文件
SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的
-
application.properties
- 语法结构 ：key=value
-
application.yml【现在推荐使用的】
- 语法结构 ：key：空格 value
配置文件的作用： 修改SpringBoot自动配置的默认值
yaml概述
YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）
这种语言以数据作为中心，而不是以标记语言为重点！
yaml基础语法
说明：语法要求严格！
1、空格不能省略
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
3、属性和值的大小写都是十分敏感的。
# 普通的key-value
name: lexiaoyuan
# 对象
student:
name: lexiaoyuanbeta
age: 21
# 行内写法
studentbeta: {name: lexiaoyuan, age: 21}
# 数组
pets:
- dog
- cat
- pig
petsbeta: [dog, cat, pig]
通过@Value注解来注入值
- 新建实体类
Dog.java
@Component
public class Dog {
// 通过@Value注解来注入值
@Value("胖哈")
private String name;
@Value("2")
private int age;
public Dog() {
}
public Dog(String name, int age) {
this.name = name;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "Dog{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
- 在新建Spring Boot项目时自动生成的测试类
Springboot02ConfigApplicationTests.java中写测试
@SpringBootTest
class Springboot02ConfigApplicationTests {
@Autowired
private Dog dog;
@Test
void contextLoads() {
System.out.println(dog.toString());
}
}
- 运行测试类
通过.yml配置文件来注入值
- 新建实体类
Person.java
import java.util.Date;
import java.util.List;
import java.util.Map;
@Component
public class Person {
private String name;
private int age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
public Person() {
}
public Person(String name, int age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
this.name = name;
this.age = age;
this.happy = happy;
this.birth = birth;
this.maps = maps;
this.lists = lists;
this.dog = dog;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public Boolean getHappy() {
return happy;
}
public void setHappy(Boolean happy) {
this.happy = happy;
}
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;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
", happy=" + happy +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
}
- 写
application.yml配置文件
person:
name: lexiaoyuan
age: 21
happy: true
birth: 1999/2/11
maps: {k1: v1, k2: v2}
lists:
- book
- code
- bug
dog:
name: 胖哈beta
age: 1
- 在Person类上添加注解
@ConfigurationProperties
/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@ConfigurationProperties(prefix = "person")
public class Person {
// ...
}
- 在
pom.xml中添加一个依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
- 在
Springboot02ConfigApplicationTests.java中写测试
@SpringBootTest
class Springboot02ConfigApplicationTests {
@Autowired
private Dog dog;
@Autowired
private Person person;
@Test
void contextLoads() {
System.out.println(dog.toString()); // Dog{name='胖哈', age=2}
System.out.println(person.toString());
}
}
- 运行测试类，输出：
Dog{name=‘胖哈’, age=2}
Person{name=‘lexiaoyuan’, age=21, happy=true, birth=Thu Feb 11 00:00:00 CST 1999, maps={k1=v1, k2=v2}, lists=[book, code, bug], dog=Dog{name=‘胖哈beta’, age=1}}
表示值均注入成功！
加载指定的配置文件
- 在resources目录下新建
person.properties
name=lexiaoyuanbeta
- 修改
Person.java，通过@PropertySource注解来指定加载文件
//@ConfigurationProperties(prefix = "person")
@PropertySource(value = "classpath:person.properties")
public class Person {
@Value("${name}") //支持SPEL表达式
private String name;
private int age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
// ...
}
- 再次运行测试类
可以看到，也注入成功。
.yml中配置占位符
- 修改
application.yml
person:
name: lexiaoyuan${random.uuid}
age: ${random.int}
happy: true
birth: 1999/2/11
maps: {k1: v1, k2: v2}
lists:
- book
- code
- bug
dog:
name: ${person.hello:汪汪汪}胖哈beta #如果person对象有hello属性，就取其值，否则取汪汪汪
age: 1
# hello: hello world!
- 修改
Person.java为原来的样子
@ConfigurationProperties(prefix = "person")
//@PropertySource(value = "classpath:person.properties")
public class Person {
//@Value("${name}") //支持SPEL表达式
private String name;
private int age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
// ...
}
- 再运行测试类
- 没有hello属性
Dog{name=‘胖哈’, age=2}
Person{name=‘lexiaoyuan6f3ed2b3-a6f2-4a44-bea6-9f97ee74beb0’, age=-34976505, happy=true, birth=Thu Feb 11 00:00:00 CST 1999, maps={k1=v1, k2=v2}, lists=[book, code, bug], dog=Dog{name=‘汪汪汪胖哈beta’, age=1}}
- 有hello属性
Dog{name=‘胖哈’, age=2}
Person{name=‘lexiaoyuan9145dacd-2235-4222-80ce-4a5f358fb9db’, age=446368262, happy=true, birth=Thu Feb 11 00:00:00 CST 1999, maps={k1=v1, k2=v2}, lists=[book, code, bug], dog=Dog{name=‘hello world!胖哈beta’, age=1}}
对比小结
1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下
3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性
4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持
结论
配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！
JSR303数据校验
Springboot中可以用
@Validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。
- 常见的数据校验注解
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) string is between min and max included.
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则【支持正则表达式】
- 修改
Person.java
@ConfigurationProperties(prefix = "person")
@Validated //数据校验
public class Person {
@Email //name只能为Email格式
private String name;
private int age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
// ...
}
- 再运行测试类，会报如下错误，提示name的值的格式错误。
- 修改
application.yml，再运行测试类
person:
name: lexiaoyuan@lxy.com #修改为Email格式
# ...
- 补充：所有格式校验注解的位置
不同位置配置文件的优先级
注意：配置文件的文件名必须是application.yml 或 application.preproties
- 1、
file:./config/。是指在工程的根目录下的config目录下。现在工程目录下新建config文件夹，再在config目录下新建application.yml。
server:
port: 8081 # 设置服务器启动端口为8081，默认是8080
- 2、
file:./。是指在工程的根目录下新建application.yml
server:
port: 8084
- 3、
classpath:/config/。是指在类路径下的config目录下。在resources目录下新建config目录，再在config目录下新建application.yml
server:
port: 8085
- 4、
classpath:/。是指在类路径下新建application.yml。（新建项目的默认位置）
server:
port: 8086
- 现在运行以下项目，看会启动哪个端口
可以看到，启动的是8081端口，即1、中file:./config/目录下。
- 现在删掉1、中新建的config目录，再运行看。
可以看到，启动的是8084端口，即2、中file:./目录下。
- 再删掉2、中
file:./目录，再运行看。
可以看到，启动的是8085端口，即3、中classpath:/config/目录下。
- 再删掉3、中
classpath:/config/目录，在运行看。
可以看到，启动的是8086端口，即4、中classpath:/目录下。
配置多环境切换
- 修改
application.yml
server:
port: 8081
--- # yml支持分割线，表示多文档块
# 开发环境
server:
port: 8084
spring:
profiles: dev
---
# 测试环境
server:
port: 8085
spring:
profiles: test
- 运行项目，看是用的那个端口
可以看到，用的是8081端口。
- 再修改
application.yml
server:
port: 8081
spring:
profiles:
active: dev # 激活dev环境
--- # yml支持分割线，表示多文档块
# 开发环境
server:
port: 8084
spring:
profiles: dev
---
# 测试环境
server:
port: 8085
spring:
profiles: test
可以看到，已成功启用了dev环境，使用的是8084端口
- 再修改
application.yml
server:
port: 8081
spring:
profiles:
active: test # 激活test环境
--- # yml支持分割线，表示多文档块
# 开发环境
server:
port: 8084
spring:
profiles: dev
---
# 测试环境
server:
port: 8085
spring:
profiles: test
可以看到，已成功启用了test环境，使用的是8085端口
- 注意：
如果yml和properties同时都配置了端口，并且没有激活其他环境 ， 默认会使用properties配置文件的！
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
