yaml语法学习及JSR303数据校验

╰+攻爆jí腚メ 2022-09-03 01:22 141阅读 0赞

> 配置文件

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配置：

yaml配置：

server：
      prot: 8080

> yaml基础语法

说明：语法要求严格！

1、空格不能省略

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

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

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

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

k: v

注意：

*  “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
    
    比如 ：name: “kuang \\n shen” 输出 ：kuang 换行 shen
 *  ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
    
    比如 ：name: ‘kuang \\n shen’ 输出 ：kuang \\n shen
    
    --------------------

> 注入配置文件

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

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

2、编写一个实体类Person 类

package com.bing.pojo;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    import java.util.List;
    import java.util.Map;
    
    @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;
    
        public Person() { 
        }
    
        public Person(String name, Integer age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) { 
            this.name = name;
            this.age = age;
            this.happy = happy;
            this.birth = birth;
            this.maps = maps;
            this.lists = lists;
            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> getMaps() { 
            return maps;
        }
    
        public void setMaps(Map<String, Object> maps) { 
            this.maps = maps;
        }
    
        public List<Object> getLists() { 
            return lists;
        }
    
        public void setLists(List<Object> lists) { 
            this.lists = lists;
        }
    
        public Dog getDog() { 
            return dog;
        }
    
        public void setDog(Dog dog) { 
            this.dog = dog;
        }
    
        @Override
        public String toString() { 
            return "Person{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", happy=" + happy +
                    ", birth=" + birth +
                    ", maps=" + maps +
                    ", lists=" + lists +
                    ", dog=" + dog +
                    '}';
        }
    }

3、我们来使用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

4、我们刚才已经把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;
    }

5、测试：

@SpringBootTest
    class Springboot01HellowordApplicationTests { 
    
        @Autowired
        private Person person;
    
        @Test
        void contextLoads() { 
            System.out.println(person);
        }
    
    }

结果：所有值全部注入成功！  
![在这里插入图片描述][1744a608b41b4d99a6478756be2982df.PNG_pic_center]

--------------------

## JSR303数据校验 ##

导入spring-boot-starter-validation依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
        <version>2.5.2</version>
    </dependency>

persong类：

增加 **@Validated** 注解，和 **@Email()** 注解

@Component //注册bean到容器中
    @ConfigurationProperties(prefix = "person")
    @Validated
    public class Person { 
    
        @Email()
        private String name;
        private Integer age;
        private Boolean happy;
        private Date birth;
        private Map<String,Object> maps;
        private List<Object> lists;
        private Dog dog;
        、、、
    }

然后再启动test进行测试：

运行结果报错：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA5NjM1Mw_size_16_color_FFFFFF_t_70_pic_center]  
**使用数据校验，可以保证数据的正确性；**

常见参数

@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 对象是否符合正则表达式的规则
    
    .......等等
    除此以外，我们还可以自定义一些数据校验规则

[1744a608b41b4d99a6478756be2982df.PNG_pic_center]: /images/20220829/35077f093d144cc4ac5e3a33896c29b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA5NjM1Mw_size_16_color_FFFFFF_t_70_pic_center]: /images/20220829/d991c477891049138ca74375d718e8fe.png