SpringBoot03：yaml配置注入_springbootyaml配置

目录

一、yaml语法学习

1、配置文件

2、yaml概述

3、yaml基础语法

3.1、字面量：普通的值【数字、布尔值、字符串】

3.2、对象、Map(键值对)

3.3、行内写法：

3.4、数组（list、set）

二、注入配置文件

1、yaml注入配置文件

2、加载指定的配置文件

3、配置文件占位符

4、回顾properties配置

5、对比小结

6、结论

---

一、yaml语法学习

1、配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的

• application.properties
  • 语法：key=value
• application.yaml
  • 语法：key: value

配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；比如我们可以在配置文件中修改Tomcat默认启动的端口号！

server.port=8081

2、yaml概述

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发这种语言时，YAML的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。
这种语言以数据作为中心，而不是以标记语言为重点！

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml
传统xml配置：

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

yaml的配置：

server：
  prot: 8080

3、yaml基础语法

说明：语法要求严格！
1、空格不能省略；
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
3、属性和值的大小写都是十分敏感的。

3.1、字面量：普通的值【数字、布尔值、字符串】

字面量直接写在后面就可以，字符串默认不加上双引号或单引号：k: v

注意：

• “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；

  比如 ：name: "kuang \n shen"   输出 ：kuang  换行   shen

• '' 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出

  比如 ：name: ‘kuang \n shen’   输出 ：kuang  \n   shen

3.2、对象、Map(键值对)

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

对象的属性和值的关系，注意缩进：例如：

#对象
student:
  name: liwanyu
  age: 13

3.3、行内写法：

student: {name: qinjiang,age: 3}
pets1: [cat,dog,pig]

3.4、数组（list、set）

用    - 值    表示数值中的一个元素。比如：

#数组
pets:
  - cat
  - dog
  - pig

3.5、修改SpringBoot的默认端口号

配置文件中添加、端口号的参数，就可以切换端口；

server:
  port: 8082

二、注入配置文件

yaml文件更强大的地方在于，它可以给我们的实体类直接注入匹配值

1、yaml注入配置文件

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

2、编写一个实体类Dog；

@Component  //注册bean到容器中去
public class Dog {
    private String name;
    private Integer age;
    //有参无参构造、get、set方法、toString()方法  
}

3、思考：原来如何给bean值注入属性值的？@Value测试Dog类

@Component  //注册bean到容器中去
public class Dog {
    @Value("阿黄")
    private String name;
    @Value("17")
    private Integer age;
    //有参无参构造、get、set方法、toString()方法  
}

4、在SpringBoot的测试类下注入Dog类测试。

@SpringBootTest
class Springboot03WebApplicationTests {
    @Autowired
    private Dog dog;
    @Test
    void contextLoads() {
        System.out.println(dog);
    }
}

运行结果：Dog{name='阿黄', age=17}
5、编写Person类

@Component
@ConfigurationProperties(prefix = "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;
    //有参无参构造、get、set方法、toString()方法  
}

6、使用yaml配置的方式进行注入，大家写的时候注意区别和优势

person:
  name: liwanyu
  age: 12
  happy: false
  birth: 1998/04/18
  maps: {k1: v1,k2: v2}
  lists:
    - cat
    - pig
    - dog
  dog:
    name: 旺财
    age: 1

7、将person类和yaml文件进行绑定

/**@ConfigurationProperties的作用：
 * 将配置文件中配置的每一个属性的值映射到这个组件中
 * 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 * 参数prefix = ‘person’：将配置文件中的person下面的属性严格一一对应 *
 */
@Component
@ConfigurationProperties(prefix = "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提示：SpringBoot配置注解处理器没有找到，查看文档找到依赖

 导入依赖：

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

9、确认以上配置无误后，进行测试

@SpringBootTest
class Springboot03WebApplicationTests {
    @Autowired
    private Dog dog;
    @Test
    void contextLoads() {
        System.out.println(dog);
    }
}

测试结果：

Person{name='liwanyu', age=12, happy=false, birth=Sat Apr 18 00:00:00 CST 1998, maps={k1=v1, k2=v2}, lists=[cat, pig, dog], dog=Dog{name='旺财', age=1}}

课堂测试：

1、将配置文件的key 值 和 属性的值设置为不一样，则结果输出为null，注入失败
测试结果：
Person{name='liwanyu001', age=null, happy=null, birth=Sun Apr 18 00:00:00 CST 1999, maps={k1=v1, k2=v2}, lists=[cat, pig, dog], dog=Dog{name='旺财1', age=1}}

2、在配置一个person2，然后将 @ConfigurationProperties(prefix = "person2") 指向我们的person2；
测试结果：
Person{name='liwanyu001', age=13, happy=true, birth=Sun Apr 18 00:00:00 CST 1999, maps={k1=v1, k2=v2}, lists=[cat, pig, dog], dog=Dog{name='旺财1', age=1}}

2、加载指定的配置文件

@PropertySource：加载指定的配置文件；

@ConfigurationProperties：默认从全局配置文件中获取值；

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

name=testName

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

@Component  //注册bean对象
//@ConfigurationProperties(prefix = "person1")
@PropertySource(value = "classpath:person.properties")
public class Person {
    @Value("${name}")
    private String name;
    .....
}

注意：使用注解@PropertySource时需要使用@Value来获取配置文件中的属性值。
3、再次输出测试：指定配置文件绑定成功！
Person{name='testName', age=null, happy=null, birth=null, maps=null, lists=null, dog=null}

3、配置文件占位符

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

person1:
  name: liwanyu001${random.uuid}
  age: ${random.int} #随机int
  happy: true
  birth: 1999/04/18
  maps: {k1: v1,k2: v2}
  lists:
    - cat
    - pig
    - dog
  dog:
    name: ${person.hello:other}_旺财
    age: 1

4、回顾properties配置

上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！配置文件除了yml还有我们之前最常用的properties！

注意：properties配置文件在写中文的时候会有乱码，我们需要去IDEA中设置编码格式为utf-8
settings-》file Encodings中配置:

测试步骤： 
1、新建一个实体类User:

//注册bean
@Component
public class User {
    private String name;
    private int age;
    private String sex;
    .......
}

2、编辑配置文件user.properties;

user1.name=liwanyu
user1.age=1
usee1.sex=女

3、我们在User类上使用@Value来进行注入！

//注册bean
@Component
@PropertySource(value = "classpath:user.properties")
public class User {
    @Value("${user1.name}")  //从配置文件中取值
    private String name;
    @Value("#{1*2}")  //#{SPEL} Spring表达式
    private int age;
    @Value("男") //字面量
    private String sex;
    ........
}

4、Springboot测试

注意：由这张图可以看出@Value注解上自定义的属性值 的使用优先于配置文件中的属性值的使用。

5、对比小结

@Value这个使用起来并不友好，需要为每个属性单独注解赋值，比较麻烦！对比图如下：

1、@ConfigurationProperties只需要写一次即可；@Value则需要每个字段都添加；
2、松散绑定：比如我的yml文件中写的last-name，这个和lastName是一样的，-后面跟着的字母默认是大写的，这就是松散绑定；

3、JSR303数据校验 ， 这个就是我们可以在字段上增加一层过滤器验证 ， 可以保证数据的合法性
4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持。

6、结论

1、配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；
2、如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
3、如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties。