狂神说SpringBoot03：yaml配置注入

狂神说SpringBoot系列连载课程，通俗易懂，基于SpringBoot2.2.5版本，欢迎各位狂粉转发关注学习。

微信公众号：狂神说（首发）    Bilibili：狂神说Java（视频）

未经做者受权，禁止转载

  yaml语法学习

配置文件

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

• 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"（还是一种标记语言）

这种语言以数据做为中心，而不是以标记语言为重点！

之前的配置文件，大多数都是使用xml来配置；好比一个简单的端口配置，咱们来对比下yaml和xml

传统xml配置：

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

yaml配置：

server： prot: 8080

 

 

yaml基础语法

说明：语法要求严格！

一、空格不能省略

二、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

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

 

字面量：普通的值  [ 数字，布尔值，字符串  ]

字面量直接写在后面就能够 ， 字符串默认不用加上双引号或者单引号；

k: v

注意：

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

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

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

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

 

对象、Map（键值对）

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

在下一行来写对象的属性和值得关系，注意缩进；好比：

student: name: qinjiang age: 3

行内写法

student: {name: qinjiang,age: 3}

 

 

数组（ List、set ）

用 - 值表示数组中的一个元素,好比：

pets: - cat - dog - pig

行内写法

pets: [cat,dog,pig]

修改SpringBoot的默认端口号

配置文件中添加，端口号的参数，就能够切换端口；

server: port: 8082

 

 

注入配置文件

yaml文件更强大的地方在于，他能够给咱们的实体类直接注入匹配值！

yaml注入配置文件

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

二、编写一个实体类 Dog；

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

三、思考，咱们原来是如何给bean注入属性值的！@Value，给狗狗类测试一下：

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

四、在SpringBoot的测试类下注入狗狗输出一下；

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

结果成功输出，@Value注入成功，这是咱们原来的办法对吧。

 

 五、咱们在编写一个复杂一点的实体类：Person 类

@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()方法 
}

六、咱们来使用yaml配置的方式进行注入，你们写的时候注意区别和优点，咱们编写一个yaml配置！

person: name: qinjiang age: 3 happy: false birth: 2000/01/01 maps: {k1: v1,k2: v2} lists: - code - girl - music dog: name: 旺财 age: 1

七、咱们刚才已经把person这个对象的全部值都写好了，咱们如今来注入到咱们的类中！

/* @ConfigurationProperties做用： 将配置文件中配置的每个属性的值，映射到这个组件中； 告诉SpringBoot将本类中的全部属性和配置文件中相关的配置进行绑定 参数 prefix = “person” : 将配置文件中的person下面的全部属性一一对应 */ @Component //注册bean
@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; }

 

八、IDEA 提示，springboot配置注解处理器没有找到，让咱们看文档，咱们能够查看文档，找到一个依赖！

 

 

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

 

九、确认以上配置都OK以后，咱们去测试类中测试一下：

@SpringBootTest class DemoApplicationTests { @Autowired Person person; //将person自动注入进来
 @Test public void contextLoads() { System.out.println(person); //打印person信息
 } }

 

yaml配置注入到实体类彻底OK！

课堂测试：

一、将配置文件的key 值 和 属性的值设置为不同，则结果输出为null，注入失败

二、在配置一个person2，而后将 @ConfigurationProperties(prefix = "person2") 指向咱们的person2；

加载指定的配置文件

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

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

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

name=kuangshen

二、而后在咱们的代码中指定加载person.properties文件

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

三、再次输出测试一下：指定配置文件绑定成功！

 

 

配置文件占位符

配置文件还能够编写占位符生成随机数

person: name: qinjiang${random.uuid} # 随机uuid age: ${random.int} # 随机int happy: false birth: 2000/01/01 maps: {k1: v1,k2: v2} lists: - code - girl - music dog: name: ${person.hello:other}_旺财 age: 1

 

 

回顾properties配置

咱们上面采用的yaml方法都是最简单的方式，开发中最经常使用的；也是springboot所推荐的！那咱们来唠唠其余的实现方式，道理都是相同的；写仍是那样写；配置文件除了yml还有咱们以前经常使用的properties ， 咱们没有讲，咱们来唠唠！

【注意】properties配置文件在写中文的时候，会有乱码 ， 咱们须要去IDEA中设置编码格式为UTF-8；

settings-->FileEncodings 中配置；

 

 

测试步骤：

一、新建一个实体类User

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

二、编辑配置文件 user.properties

user1.name=kuangshen user1.age=18 user1.sex=男

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

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

四、Springboot测试

@SpringBootTest class DemoApplicationTests { @Autowired User user; @Test public void contextLoads() { System.out.println(user); } }

结果正常输出：

 

 

对比小结

@Value这个使用起来并不友好！咱们须要为每一个属性单独注解赋值，比较麻烦；咱们来看个功能对比图

 

 

 

一、@ConfigurationProperties只须要写一次便可 ， @Value则须要每一个字段都添加

二、松散绑定：这个什么意思呢? 好比个人yml中写的last-name，这个和lastName是同样的， - 后面跟着的字母默认是大写的。这就是松散绑定。能够测试一下

三、JSR303数据校验 ， 这个就是咱们能够在字段是增长一层过滤器验证 ， 能够保证数据的合法性

四、复杂类型封装，yml中能够封装对象 ， 使用value就不支持

结论：

配置yml和配置properties均可以获取到值 ， 强烈推荐 yml；

若是咱们在某个业务中，只须要获取配置文件中的某个值，可使用一下 @value；

若是说，咱们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！