SpringBoot - yaml配置注入

Posted Lam

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot - yaml配置注入相关的知识,希望对你有一定的参考价值。

一、yaml语法

1)配置文件

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

  • application.properties

    • 语法结构 :key=value

  • application.yml

    • 语法结构 :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、属性和值的大小写都是十分敏感的。

字面量:普通的值  [ 数字,布尔值,字符串  ]

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

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文件更强大的地方在于,他可以给我们的实体类直接注入匹配值!

● 我们原来是通过@Value配置注入bean属性值的:

1、使用@Value注入属性

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

2、在SpringBoot的测试类下注入狗狗输出一下;

@SpringBootTest
class DemoApplicationTests {

    @Autowired //将狗狗自动注入进来
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }
}

3、结果成功输出,@Value注入成功,这是我们原来的办法

下面我们通过配置文件方式配置注入

1)yaml注入配置文件 - @configurationProperties

使用yml注入属性:默认从全局配置文件中获取值,在springboot项目中的resources目录下新建一个文件 application.yml

1、使用yaml配置的方式进行注入,写的时候注意区别和优势

person:
  name: 纳鲁多
  age: 22
  happy: true
  birth: 2019/09/14
  maps: {k1: v1,k2: v2}
  lists:
    - 哈哈哈
    - 呵呵呵
    - 嘻嘻嘻
  dog:
    name: 旺财
    age: 3

2、@ConfigurationProperties:将yml配置中的person这个对象,注入到我们的类中!

作用:

将配置文件中配置的每一个属性的值,映射到这个组件中;

告诉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;

    // 有参无参构造、get、set方法、toString()方法  

3、配置@ConfigurationProperties注解:IDEA 提示,springboot配置注解处理器没有找到,我们可以查看文档,找到一个依赖!

导入配置文件处理器,配置文件进行绑定就会有提示,需要重启或刷新Maven

4、确认以上配置都之后,进行一下测试:

@SpringBootTest
class Springboot002ApplicationTests {

    @Autowired
    private Person person;

    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

yaml配置注入到实体类完全OK!

2)加载指定的配置文件 - @PropertySource

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

[ settings -> FileEncodings 中配置;

1、resources目录下新建一个 person.properties 文件

name=一只人
age=18

2、使用@PropertySource注解在类中指定加载 person.properties 文件,含中文时可以使用encoding属性指定编码

@Component
@PropertySource(value = "classpath:person.properties",encoding = "UTF-8")
public class Person {

    @Value("${name}") // 使用@Value+EL表达式,取出配置文件的属性值
    private String name;
    @Value("${age}")
    private Integer age;
    ....
}

3、再次输出测试一下:指定配置文件绑定成功!

3)配置文件占位符

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

person:
  name: ${random.uuid} # 随机uuid
  age: ${random.int}   # 随机int
  happy: true
  dogname: bigbig
  maps: {k1: v1,k2: v2}
  lists:
    - 哈哈哈
    - 呵呵呵
    - 嘻嘻嘻
  dog:
    name: ${person.dogname:dogname} # 如果冒号左边不为空\':\'就输出左边的,否则输出右边
    age: ${person.dogage:1}
    happy: ${person.doghappy:${person.happy}} # 可以嵌套

测试输出:

Person{name=\'b531332d-ae05-4587-8980-1eda5d05bcc2\', age=350630538,

happy=true, maps={k1=v1, k2=v2}, lists=[哈哈哈, 呵呵呵, 嘻嘻嘻],

dog=Dog{name=\'bigbig\', age=1, happy=true}}

4)对比小结

@Value这个使用起来并不友好!我们需要为每个属性单独注解赋值,比较麻烦。

  @ConfigurationProperties @Value
功能 支持 一个个绑定
松散绑定(松散语法) 支持 不支持
SpEl 不支持 支持
JSP303数据校验 支持 不支持
复杂类型封装 支持 不支持

1、@ConfigurationProperties只需要写一次即可 ,@Value则需要每个字段都添加

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

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

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

结论:

配置 yml 和配置 properties 都可以获取到值,强烈推荐 yml;

如果我们在某个业务中,只需要获取配置文件中的某个值,可以使用一下 @Value;

如果说,我们专门编写了一个JavaBean来和配置文件进行一一映射,就直接@ConfigurationProperties

 

@转载于 - 狂神

以上是关于SpringBoot - yaml配置注入的主要内容,如果未能解决你的问题,请参考以下文章

springboot----四yaml配置注入

SpringBoot - yaml配置注入

springboot yaml配置注入

SpringBoot--yaml语法讲解 & 注入配置文件

SpringBoot:yaml配置注入和JSR303数据校验

SpringBoot_application.yaml配置