每一个应用软件都离不开数据的校验，比如在提交表单时需要对用户提交的字段内容进行长度验证、非空验证等等。有的小伙伴在做字段内容校验时采用的依然是最原始的校验方式——获取字段内容，用 if-else 对内容进行验证。这种校验方式当然没问题，但是却需要写很多行代码去实现校验的功能，也就让我们的编码效率和代码可读性都降低了很多，那么今天就给各位小伙伴介绍另一种方式——使用 @Valid 注解实现字段校验。

字段校验

首先我们先新建一个学生类（类也很简单，只有姓名和年龄两个字段）

/** * 学生类 * @description: Student * @author: 庄霸.liziye * @create: 2022-02-16 11:12 **/public class Student {    /**     * 学生姓名     */    private String name;    /**     * 学生年龄     */    private Integer age;    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public int getAge() {        return age;    }    public void setAge(int age) {        this.age = age;    }}

接下来我们再新建一个 Cotroller ，来模拟新增学生的操作过程

import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/** * 模拟学生新增的过程 * @description: StudentController * @author: 庄霸.liziye * @create: 2022-02-16 11:19 **/@RestController@RequestMapping("/student")public class StudentController {    @GetMapping("/add")    public String add(Student student){                return "添加成功";    }}

假如此时要求学生姓名不能为空且长度不能超过10，那么我们按照以前的校验方式（if-else）来写就是这样子的

import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/** * 模拟学生新增的过程 * @description: StudentController * @author: 庄霸.liziye * @create: 2022-02-16 11:19 **/@RestController@RequestMapping("/student")public class StudentController {    @GetMapping("/add")    public String add(Student student){        String name = student.getName();        if(name == null || name.trim().length() == 0){            return "学生姓名不能为空！";        }else if (name.trim().length() > 10){            return "学生姓名长度超过限制！";        }        return "添加成功";    }}

接下来我们测试一下校验有没有生效~

我们可以看到校验完全没问题，满足了对学生姓名的限制需求。这时又来了一个新的需求：要求年龄字段也是非空字段且范围在1-100之间，那么我们就得对代码再改造一下

import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/** * 模拟学生新增的过程 * @description: StudentController * @author: 庄霸.liziye * @create: 2022-02-16 11:19 **/@RestController@RequestMapping("/student")public class StudentController {    @GetMapping("/add")    public String add(Student student){        String name = student.getName();        if(name == null || name.trim().length() == 0){            return "学生姓名不能为空！";        }else if (name.trim().length() > 10){            return "学生姓名长度超过限制！";        }        Integer age = student.getAge();        if(age == null){            return "学生年龄不能为空！";        }else if (age < 1 || age > 100){            return "学生年龄有误，请重新核对！";        }        return "添加成功";    }}

我们依然用 if-else 来进行字段校验，也可以完美的实现需求。如果此时需要校验的字段有10个、20个该怎么办呢？Student 类中只有两个字段，对这两个字段进行校验的时候就已经写了十多行代码了，如果字段再多一些的话，那岂不是要写大几十行甚至一百多行代码，那这个方法就会显得很臃肿了，也就没什么可读性可言了。

可能有小伙伴会说：我们可以把 if-else 校验单独写一个校验方法，这样不就让代码变得整洁了嘛~ 这种方式确实可以让代码变得简洁一些，而且可以提升代码的可读性，但是却没有降低编码量，依然需要写大量的 if-else 语句，属于“换汤不换药”。

下面就要请出今天的主角了，看看如何使用 @Valid 注解实现字段校验( •̀ ω •́ )y ~

使用 @Valid 注解实现字段校验

在使用 @Valid 注解之前，我们依然是要先引入依赖（如果是 Spring Boot 项目的话，就不需要专门引入依赖了，spring-boot-starter-web 已经帮我们引入好了）

<dependency>    <groupId>javax.validation</groupId>    <artifactId>validation-api</artifactId>    <version>1.1.0.Final</version></dependency> <dependency>	<groupId>org.hibernate.validator</groupId>	<artifactId>hibernate-validator</artifactId></dependency>

接下来我们对学生类和 Cotroller 进行一点小小的改造

package com.example.shiro.controller;import org.hibernate.validator.constraints.Length;import org.hibernate.validator.constraints.Range;import javax.validation.constraints.NotNull;/** * 学生类 * @description: Student * @author: 庄霸.liziye * @create: 2022-02-16 11:12 **/public class Student {    /**     * 学生姓名     */    @NotNull(message = "Valid校验：请输入学生姓名！")    @Length(message = "名称不能超过个 {max} 字符", max = 10)    private String name;    /**     * 学生年龄     */    @NotNull(message = "Valid校验：请输入学生年龄")    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)    private Integer age;    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public int getAge() {        return age;    }    public void setAge(int age) {        this.age = age;    }}

import org.springframework.validation.BindingResult;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import javax.validation.Valid;/** * 模拟学生新增的过程 * @description: StudentController * @author: 庄霸.liziye * @create: 2022-02-16 11:19 **/@RestController@RequestMapping("/student")public class StudentController {    @GetMapping("/add")    public String add(@Valid Student student, BindingResult bindingResult){        if(bindingResult.hasErrors()){            return bindingResult.getAllErrors().get(0).getDefaultMessage();        }        return "添加成功";    }}

我们可以看到，在 Cotroller 中我们增加了两部分内容，分别是 @Valid 和 BindingResult ，我们这里做一个简单的解释：

给学生对象前增加上 @Valid 注解，就表示了我们需要对这个对象中的属性进行验证，验证的内容就是在学生类中增加的注解中的内容。BindingResult 可以理解为 @Valid 注解的“老搭档”，BindingResult 作用就是在实体类校验信息后存储校验结果。

下面我们再试试校验有没有生效

我们可以看到，字段校验的结果和我们预期的一模一样，而且还让代码的可读性提高了一大截，是不是非常nice

最后再给大家总结一下实体类中常用的校验注解：

@Null：被注释的元素必须为null@NotNull：被注释的元素不能为null@AssertTrue：该字段只能为true@AssertFalse：该字段的值只能为false@Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值@Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值@DecimalMin(“value”)：被注释的元素必须是一个数字，验证小数的最小值@DecimalMax(“value”)：被注释的元素必须是一个数字，验证小数的最大值@Size(max,min)：查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等@Past：被注释的元素必须是一个过去的日期@Future：被注释的元素必须是一个将来的日期@Pattern(regexp = “[abc]”)：被注释的元素必须符合指定的正则表达式。@Email：被注释的元素必须是电子邮件地址@Length(max=5,min=1,message=“长度在1~5”)：检查所属的字段的长度是否在min和max之间，只能用于字符串@NotEmpty：被注释的字符串必须非空@Range：被注释的元素必须在合适的范围内@NotBlank：不能为空，检查时会将空格忽略@NotEmpty：不能为空，这里的空是指空字符串小结

本人经验有限，有些地方可能讲的没有特别到位，如果您在阅读的时候想到了什么问题，欢迎在评论区留言，我们后续再一一探讨‍