pringBoot使用一个全局的配置文件 , 配置文件名称是固定的
application.properties
语法结构 :key=value
application.yml
语法结构 :key:空格 value
配置文件的作用 :修改SpringBoot自动配置的默认值,因为SpringBoot在底层都给我们自动配置好了;
比如我们可以在配置文件中修改Tomcat 默认启动的端口号!测试一下!
server.port=8081
yaml
YAML是 “YAML Ain’t a Markup Language” (YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:“Yet Another Markup Language”(仍是一种标记语言)
**这种语言以数据作为中心,而不是以标记语言为重点!
传统的配置文件
<server>
<port>8081<port>
</server>
yaml的配置
server:
prot: 8081
yam语法严格
1 在配置时 以 键: 值 的方式
空格不能省略
例如 :
name: wf
2 以缩进来控制层级关系,只要是左边对齐的一列数据都是同一个层级的。
例如 :
name: wf
age: 15
3、属性和值的大小写都是十分敏感的。
字面量:普通的值 [ 数字,布尔值,字符串 ]
字面量直接写在后面就可以 , 字符串默认不用加上双引号或者单引号;
K: v
注意:
“ ” 双引号,会转义字符串里面的特殊字符 , 特殊字符会作为本身想表示的意思;
比如 :name: “kuang \n shen” 输出 :kuang 换行 shen
’ ’ 单引号,不会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出
比如 :name: ‘kuang \n shen’ 输出 :kuang \n shen
对象 map存储
maps: { k1: 第一个,k2: 第二个 }
日期Data
date: 2021/21/11
list集合
lists:
- aa
- bb
- aaa
对象存储
dog:
name: 小白
age: 2
## `注入配置文件
yaml文件更强大的地方在于,他可以给我们的实体类直接注入匹配值!
1、在springboot项目中的resources目录下新建一个文件 application.yaml
2、编写一个实体类 Person
```java
package com.kuang.springboot02cofing.pojo;
import lombok.*;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* @Author: Mr.Wang
* @Component 注册bean到容器中
* @ConfigurationProperties(prefix = "person")
* prefix = "person" 绑定application.yaml 的数据
*/
// 有参构成
@AllArgsConstructor
// get set toString
@Data
@NoArgsConstructor// 无参构成
// 泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注
@Component
// prefix = "person" 绑定application.yaml 的数据
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date date;
private Map<String, Object> maps;
private List<Object> lists;
}
- application.yaml.yaml编写
person:
name: 'w \n b'
age: 12
happy: true
date: 2021/21/11
maps: { k1: 第一个,k2: 第二个 }
lists:
- aa
- bb
- aaa
dog:
name: 小白
age: 2
4、IDEA 提示,springboot配置注解处理器没有找到,让我们看文档,我们可以查看文档,找到一个依赖
配置依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
- 测验
@Test
void t2() {
System.err.println (person.toString ());
}
结果
Person(name=w \n b, age=12, happy=true, date=Sun Sep 11 00:00:00 CST 2022, maps={k1=第一个, k2=第二个}, lists=[aa, bb, aaa])
对比原来的方式
- 建立实体类
package com.kuang.springboot02cofing.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
@AllArgsConstructor
@NoArgsConstructor
@Data
@Controller // 注册到 bean到容器中
public class Dog {
@Value("小黑")
private String name;
@Value("12")
private int age;
}
2、在SpringBoot的测试类下注入狗狗输出一下;
package com.kuang.springboot02cofing;
import com.kuang.springboot02cofing.pojo.Dog;
import com.kuang.springboot02cofing.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class Springboot02CofingApplicationTests {
@Autowired
private Dog dog;
@Autowired
private Person person;
@Test
void contextLoads() {
System.out.println (dog.toString ());
}
- 结果成功输出,@Value注入成功,这是我们原来的办法对吧。
Dog(name=小黑, age=12)
yaml配置注入到实体类完全OK!
1、将配置文件的key 值 和 属性的值设置为不一样,则结果输出为null,注入失败
2、在配置一个person2,然后将 @ConfigurationProperties(prefix = “person2”) 指向我们的person2;
ConfigurationProperties只需要写一次即可 , @Value则需要每个字段都添加
2、松散绑定:这个什么意思呢? 比如我的yml中写的last-name,这个和lastName是一样的, - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下
3、JSR303数据校验 , 这个就是我们可以在字段是增加一层过滤器验证 , 可以保证数据的合法性
4、复杂类型封装,yml中可以封装对象 , 使用value就不支持
结论:
配置yml和配置properties都可以获取到值 , 强烈推荐 yml;
如果我们在某个业务中,只需要获取配置文件中的某个值,可以使用一下 @value;
如果说,我们专门编写了一个JavaBean来和配置文件进行一一映射,就直接@configurationProperties,不要犹豫!
JSR303数据校验