SpringBoot03:yaml配置注入

SpringBoot03: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配置:


    8081

yaml配置:

server:
      port: 8081

yaml基础语法

说明:语法要求严格

1.空格不能省略

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

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

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

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

k: v

注意:

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

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

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

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

对象、Map(键值对)

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注入配置文件

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

2.编写一个实体类 Cat;

@Data
@AllArgsConstructor
@NoArgsConstructor

@Component
public class Cat {
    @Value("暖暖")
    private String name;
    @Value("3")
    private Integer age;
}

3.思考,我们原来是如何给bean注入属性值的!@Value,给喵喵类测试一下:

@Data
@AllArgsConstructor
@NoArgsConstructor

@Component
public class Cat {
    @Value("暖暖")
    private String name;
    @Value("3")
    private Integer age;
}

4.在SpringBoot的测试类下注入喵喵输出一下

@SpringBootTest
class Springboot02ConfigApplicationTests {

    @Autowired
    Cat cat;

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

}

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

输出结果:Cat(name=暖暖, age=3)

5.我们在编写一个复杂一点的实体类:Person 类

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
public class Person {

//    @Value("${name}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map maps;
    private List lists;
    private Cat cat;
} 
  

6.我们来使用yaml配置的方式进行注入,大家写的时候注意区别和优势,我们编写一个yaml配置!

person:
  name: 壮壮
  age: 18
  happy: false
  birth: 2022/06/06
  maps: {k1: v1,k2: v2}
  lists:
    - money
    - girl
    - house
  cat:
    name: 暖暖
    age: 3

7.我们刚才已经把person这个对象的所有值都写好了,我们现在来注入到我们的类中!

/*
@ConfigurationProperties作用:
将配置文件中配置的每一个属性的值,映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

//    @Value("${name}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map maps;
    private List lists;
    private Cat cat;
} 
  

8.IDEA 提示,springboot配置注解处理器没有找到,让我们看文档,我们可以查看文档,找到一个依赖!

SpringBoot03:yaml配置注入_第1张图片



  org.springframework.boot
  spring-boot-configuration-processor
  true

9.确认以上配置都OK之后,我们去测试类中测试一下:

@SpringBootTest
class Springboot02ConfigApplicationTests {

    @Autowired
    Person person;

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

}

结果:所有值全部注入成功!

Person(name=壮壮, age=18, happy=false, birth=Mon Jun 06 00:00:00 CST 2022, maps={k1=v1, k2=v2}, lists=[money, girl, house], cat=Cat(name=暖暖, age=3))

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

课堂测试:

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

2、在配置一个person2,然后将 @ConfigurationProperties(prefix = "person2") 指向我们的person2;

加载指定的配置文件

**@PropertySource :**加载指定的配置文件;

@configurationProperties:默认从全局配置文件中获取值;

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

name=壮壮

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

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
//@ConfigurationProperties(prefix = "person")
@PropertySource(value = "classpath:person.properties")
public class Person {

    @Value("${name}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map maps;
    private List lists;
    private Cat cat;
} 
  

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

测试结果:Person(name=壮壮, age=null, happy=null, birth=null, maps=null, lists=null, cat=null)

配置文件占位符

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

person:
  name: 壮壮${random.uuid}
  age: 18
  happy: false
  birth: 2022/06/06
  maps: {k1: v1,k2: v2}
  lists:
    - money
    - girl
    - house
  cat:
    name: 暖暖${random.uuid}
    age: 3

回顾properties配置

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

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

settings-->FileEncodings 中配置;

对比小结

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

SpringBoot03:yaml配置注入_第2张图片

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

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

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

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

结论:

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

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

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

你可能感兴趣的:(spring,boot)