yamlspringboot

狂神哔哩哔哩视频地址:https://space.bilibili.com/95256449

配置文件

SpringBoot使用一个全局的配置文件 &＃xff0c; 配置文件名称是固定的

• application.properties
• • 语法结构 &＃xff1a;key&＃61;value
• application.yml
• • 语法结构 &＃xff1a;key&＃xff1a;空格 value

**配置文件的作用 &＃xff1a;**修改SpringBoot自动配置的默认值&＃xff0c;因为SpringBoot在底层都给我们自动配置好了&＃xff1b;

比如我们可以在配置文件中修改Tomcat 默认启动的端口号&＃xff01;测试一下&＃xff01;

server.port&＃61;8081


yaml概述

YAML是 “YAML Ain’t a Markup Language” &＃xff08;YAML不是一种标记语言&＃xff09;的递归缩写。在开发的这种语言时&＃xff0c;YAML 的意思其实是&＃xff1a;“Yet Another Markup Language”&＃xff08;仍是一种标记语言&＃xff09;

这种语言以数据作为中心&＃xff0c;而不是以标记语言为重点&＃xff01;

以前的配置文件&＃xff0c;大多数都是使用xml来配置&＃xff1b;比如一个简单的端口配置&＃xff0c;我们来对比下yaml和xml

传统xml配置&＃xff1a;

<server><port>8081<port>
server>


yaml配置&＃xff1a;

server&＃xff1a;prot: 8080


yaml基础语法

说明&＃xff1a;语法要求严格&＃xff01;

1、空格不能省略

2、以缩进来控制层级关系&＃xff0c;只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

字面量&＃xff1a;普通的值 [ 数字&＃xff0c;布尔值&＃xff0c;字符串 ]

字面量直接写在后面就可以 &＃xff0c; 字符串默认不用加上双引号或者单引号&＃xff1b;

k: v


注意&＃xff1a;

• “ ” 双引号&＃xff0c;不会转义字符串里面的特殊字符 &＃xff0c; 特殊字符会作为本身想表示的意思&＃xff1b;

  比如 &＃xff1a;name: “kuang \n shen” 输出 &＃xff1a;kuang 换行 shen

• ‘’ 单引号&＃xff0c;会转义特殊字符 &＃xff0c; 特殊字符最终会变成和普通字符一样输出

  比如 &＃xff1a;name: ‘kuang \n shen’ 输出 &＃xff1a;kuang \n shen

对象、Map&＃xff08;键值对&＃xff09;

#对象、Map格式
k: v1:v2:


在下一行来写对象的属性和值得关系&＃xff0c;注意缩进&＃xff1b;比如&＃xff1a;

student:name: qinjiangage: 3


行内写法

student: {name: qinjiang,age: 3}


数组&＃xff08; List、set &＃xff09;

用 - 值表示数组中的一个元素,比如&＃xff1a;

pets:- cat- dog- pig


行内写法

pets: [cat,dog,pig]


修改SpringBoot的默认端口号

配置文件中添加&＃xff0c;端口号的参数&＃xff0c;就可以切换端口&＃xff1b;

server:port: 8082


注入配置文件

yaml文件更强大的地方在于&＃xff0c;他可以给我们的实体类直接注入匹配值&＃xff01;

yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml

2、编写一个实体类 Dog&＃xff1b;

package com.kuang.springboot.pojo;&＃64;Component //注册bean到容器中
public class Dog {private String name;private Integer age;//有参无参构造、get、set方法、toString()方法
}


3、思考&＃xff0c;我们原来是如何给bean注入属性值的&＃xff01;&＃64;Value&＃xff0c;给狗狗类测试一下&＃xff1a;

&＃64;Component //注册bean
public class Dog {&＃64;Value("阿黄")private String name;&＃64;Value("18")private Integer age;
}


4、在SpringBoot的测试类下注入狗狗输出一下&＃xff1b;

&＃64;SpringBootTest
class DemoApplicationTests {&＃64;Autowired //将狗狗自动注入进来Dog dog;&＃64;Testpublic void contextLoads() {System.out.println(dog); //打印看下狗狗对象}}


结果成功输出&＃xff0c;&＃64;Value注入成功&＃xff0c;这是我们原来的办法对吧。

5、我们在编写一个复杂一点的实体类&＃xff1a;Person 类

&＃64;Component //注册bean到容器中
public class Person {private String name;private Integer age;private Boolean happy;private Date birth;private Map<String,Object> maps;private List<Object> lists;private Dog dog;//有参无参构造、get、set方法、toString()方法
}


6、我们来使用yaml配置的方式进行注入&＃xff0c;大家写的时候注意区别和优势&＃xff0c;我们编写一个yaml配置&＃xff01;

person:name: qinjiangage: 3happy: falsebirth: 2000/01/01maps: {k1: v1,k2: v2}lists:- code- girl- musicdog:name: 旺财age: 1


7、我们刚才已经把person这个对象的所有值都写好了&＃xff0c;我们现在来注入到我们的类中&＃xff01;

/*
&＃64;ConfigurationProperties作用&＃xff1a;
将配置文件中配置的每一个属性的值&＃xff0c;映射到这个组件中&＃xff1b;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix &＃61; “person” : 将配置文件中的person下面的所有属性一一对应
*/
&＃64;Component //注册bean
&＃64;ConfigurationProperties(prefix &＃61; "person")
public class Person {private String name;private Integer age;private Boolean happy;private Date birth;private Map<String,Object> maps;private List<Object> lists;private Dog dog;
}


8、IDEA 提示&＃xff0c;springboot配置注解处理器没有找到&＃xff0c;让我们看文档&＃xff0c;我们可以查看文档&＃xff0c;找到一个依赖&＃xff01;


<dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-configuration-processorartifactId><optional>trueoptional>
dependency>


9、确认以上配置都OK之后&＃xff0c;我们去测试类中测试一下&＃xff1a;

&＃64;SpringBootTest
class DemoApplicationTests {&＃64;AutowiredPerson person; //将person自动注入进来&＃64;Testpublic void contextLoads() {System.out.println(person); //打印person信息}}


结果&＃xff1a;所有值全部注入成功&＃xff01;

yaml配置注入到实体类完全OK&＃xff01;

课堂测试&＃xff1a;

1、将配置文件的key 值 和 属性的值设置为不一样&＃xff0c;则结果输出为null&＃xff0c;注入失败

2、在配置一个person2&＃xff0c;然后将 &＃64;ConfigurationProperties(prefix &＃61; “person2”) 指向我们的person2&＃xff1b;

加载指定的配置文件

**&＃64;PropertySource &＃xff1a;**加载指定的配置文件&＃xff1b;

&＃64;configurationProperties&＃xff1a;默认从全局配置文件中获取值&＃xff1b;

1、我们去在resources目录下新建一个person.properties文件

name&＃61;kuangshen


2、然后在我们的代码中指定加载person.properties文件

&＃64;PropertySource(value &＃61; "classpath:person.properties")
&＃64;Component //注册bean
public class Person {&＃64;Value("${name}")private String name;......
}


3、再次输出测试一下&＃xff1a;指定配置文件绑定成功&＃xff01;

配置文件占位符

配置文件还可以编写占位符生成随机数

person:name: qinjiang${random.uuid} # 随机uuidage: ${random.int} # 随机inthappy: falsebirth: 2000/01/01maps: {k1: v1,k2: v2}lists:- code- girl- musicdog:name: ${person.hello:other}_旺财age: 1


回顾properties配置

我们上面采用的yaml方法都是最简单的方式&＃xff0c;开发中最常用的&＃xff1b;也是springboot所推荐的&＃xff01;那我们来唠唠其他的实现方式&＃xff0c;道理都是相同的&＃xff1b;写还是那样写&＃xff1b;配置文件除了yml还有我们之前常用的properties &＃xff0c; 我们没有讲&＃xff0c;我们来唠唠&＃xff01;

【注意】properties配置文件在写中文的时候&＃xff0c;会有乱码 &＃xff0c; 我们需要去IDEA中设置编码格式为UTF-8&＃xff1b;

settings–>FileEncodings 中配置&＃xff1b;

测试步骤&＃xff1a;

1、新建一个实体类User

&＃64;Component //注册bean
public class User {private String name;private int age;private String sex;
}


2、编辑配置文件 user.properties

user1.name&＃61;kuangshen
user1.age&＃61;18
user1.sex&＃61;男


3、我们在User类上使用&＃64;Value来进行注入&＃xff01;

&＃64;Component //注册bean
&＃64;PropertySource(value &＃61; "classpath:user.properties")
public class User {//直接使用&＃64;value&＃64;Value("${user.name}") //从配置文件中取值private String name;&＃64;Value("#{9*2}") // #{SPEL} Spring表达式private int age;&＃64;Value("男") // 字面量private String sex;
}


4、Springboot测试

&＃64;SpringBootTest
class DemoApplicationTests {&＃64;AutowiredUser user;&＃64;Testpublic void contextLoads() {System.out.println(user);}}


结果正常输出&＃xff1a;

对比小结

&＃64;Value这个使用起来并不友好&＃xff01;我们需要为每个属性单独注解赋值&＃xff0c;比较麻烦&＃xff1b;我们来看个功能对比图

1、&＃64;ConfigurationProperties只需要写一次即可 &＃xff0c; &＃64;Value则需要每个字段都添加

2、松散绑定&＃xff1a;这个什么意思呢? 比如我的yml中写的last-name&＃xff0c;这个和lastName是一样的&＃xff0c; - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验 &＃xff0c; 这个就是我们可以在字段是增加一层过滤器验证 &＃xff0c; 可以保证数据的合法性

4、复杂类型封装&＃xff0c;yml中可以封装对象 &＃xff0c; 使用value就不支持

结论&＃xff1a;

配置yml和配置properties都可以获取到值 &＃xff0c; 强烈推荐 yml&＃xff1b;

如果我们在某个业务中&＃xff0c;只需要获取配置文件中的某个值&＃xff0c;可以使用一下 &＃64;value&＃xff1b;

如果说&＃xff0c;我们专门编写了一个JavaBean来和配置文件进行一一映射&＃xff0c;就直接&＃64;configurationProperties&＃xff0c;不要犹豫&＃xff01;