3、SpringBoot：学习yaml语法

最新推荐文章于 2024-03-26 20:10:13 发布

Surplus...

最新推荐文章于 2024-03-26 20:10:13 发布

阅读量152

点赞数

分类专栏： SpringBoot 文章标签： spring boot

原文链接：https://www.bilibili.com/video/BV1PE411i7CV?p=17

版权

SpringBoot 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

文章目录

1、配置文件
2、yaml概述
3、yaml基础语法
4、注入配置文件（yaml注入）
5、加载指定的配置文件
6、配置文件占位符(配置文件还可以编写占位符生成随机数)
7、JSR303数据校验
- 1、如何使用
- 2、常见参数

1、配置文件

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

application.properties 语法结构 ：key=value
application.yml 语法结构 ：key：空格 value

配置文件的作用 ：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

2、yaml概述

YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）

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

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

传统xml配置：

<server>
    <port>8080<port>
</server>

yaml配置：

server：
  prot: 8080

3、yaml基础语法

语法要求

空格不能省略
以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
属性和值的大小写都是十分敏感的。

1、字面量：普通的值(数字，布尔值，字符串)

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

		k: v

注意：

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

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

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

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

2、对象、Map（键值对）

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

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

student:
    name: qinjiang
    age: 3

行内写法

	student: {name: qinjiang,age: 3}

3、数组（ List、set ）

用 - 值表示数组中的一个元素

	pets:
 		- cat
 		- dog
 		- pig

行内写法

	pets: [cat,dog,pig]

4、修改SpringBoot的默认端口号

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

	server:
  		port: 8082

4、注入配置文件（yaml注入）

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

2、编写一个实体类 Dog

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component  //将实体类注入spring的容器中
public class Dog {
    private String name;
    private Integer age;

    public Dog() {
    }

    public Dog(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

3、我们原来是使用给bean注入属性值的！@Value

public class Dog {
    @Value("哈哈")
    private String name;
    @Value("3")
    private Integer age;
  }

4、SpringBoot的测试类下注入狗狗输出一下

@SpringBootTest
class SpringbootYamlApplicationTests {

    @Autowired
    private Dog dog;

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

}

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

在这里插入图片描述

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

package com.jl.pojo;

import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;
@Component
public class People {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;

    public People() {
    }

    public People(String name, Integer age, Boolean happy, Date birth, Map<String, Object> map, List<Object> list, Dog dog) {
        this.name = name;
        this.age = age;
        this.happy = happy;
        this.birth = birth;
        this.map = map;
        this.list = list;
        this.dog = dog;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getHappy() {
        return happy;
    }

    public void setHappy(Boolean happy) {
        this.happy = happy;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMap() {
        return map;
    }

    public void setMap(Map<String, Object> map) {
        this.map = map;
    }

    public List<Object> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "People{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", happy=" + happy +
                ", birth=" + birth +
                ", map=" + map +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}

6、使用yaml配置的方式进行注入

person:
  name: jinglei
  age: ${random.int}
  happy: true
  birth: 1998/01/10
  map: {k1: v1,k2: v2}
  list:
    - code
    - music
    - play
  dog:
    name: 哈哈
    age: 3

7、将值注入到类中

@ConfigurationProperties作用

将配置文件中配置的每一个属性的值，映射到这个组件中；告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component
@ConfigurationProperties(prefix = "person")
public class People {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
  }

去除爆红的方式 ===>加入一个jar 包
在这里插入图片描述

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

8、配置完成之后进行测试

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }
}

结果：
在这里插入图片描述

5、加载指定的配置文件

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

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

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

	name=hhhhh

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

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

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

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

结论：

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

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

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

7、JSR303数据校验

1、如何使用

Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式；

@Component //注册bean
@ConfigurationProperties(prefix = "person")
@Validated  //数据校验
public class Person {

    @Email(message="邮箱格式错误") //name必须是邮箱格式
    private String name;
}

运行结果：default message [不是一个合法的电子邮件地址]

使用数据校验，可以保证数据的正确性；

2、常见参数

@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;

空检查
@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank   检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty   检查约束元素是否为NULL或者是EMPTY.
    
Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  
    
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内  
@Length(min=, max=) string is between min and max included.

日期检查
@Past       验证 Date 和 Calendar 对象是否在当前时间之前  
@Future     验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern    验证 String 对象是否符合正则表达式的规则

.......等等
除此以外，我们还可以自定义一些数据校验规则