@Valid 注解用法详解

忘是亡心i 2023-06-21 15:29 88阅读 0赞

@Valid 注解通常用于对象属性字段的规则检测，具体啥意思，下面让我娓娓道来：

下面我们以新增一个员工为功能切入点，以常规写法为背景，慢慢烘托出 @Valid 注解用法详解。

那么，首先，我们会有一个员工对象 Employee，如下 ：

/**
     * 员工对象
     * 
     * @author sunnyzyq
     * @since 2019/12/13
     */
    public class Employee {
    
        /** 姓名 */
        public String name;
    
        /** 年龄 */
        public Integer 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;
        }
    
    }

然后 Cotroller 中会有一个对应都新增方法 add()，如下：

@Controller
    public class TestController {
    
        @RequestMapping("/add")
        @ResponseBody
        public String add(Employee employee) {
            // TODO 保存到数据库
            return "新增员工成功";
        }
    
    }

现在要求：员工的名称不能为空，且长度不能超过10个字符，那么我们以前的做法大致如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70][]

写完，我们启动项目测试下：

（1）名称为空情况

![20191213151330417.png][]

（2）正常情况

![20191213151746490.png][]

（3）超过长度情况

![20191213151829944.png][]

可以看到，和我们料想中的一样，毫无问题。

除了名称外，我们规定年龄也是必填项，且范围在1到100岁，那么此时，我们需要增加对应判定代码如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 1][]

那么问题来了，现在员工对象 Employee 就 2 个字段，我们就写了 10 多行的代码验证，要是有20个字段，岂不是要写 100 多行代码？通常来说，当一个方法中的无效业务代码量过多时，往往代码设计有问题，当然这不是我们所想看到都结果。

那么如何解决呢？首先大家应该会想到将对应的验证过程抽成一个验证方法，如下：

这样来看，我们的业务方法就清爽多了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 2][]

但这种方式只是抽了一个方法，有一种换汤不换药的感觉，虽然业务方法看起来清爽了很多，但书写代码量并没有下降，反而还多出了一个方法，这也不是我们理想中的样子。

此时，我们引出 Spring 中的 @valid 注解，这些问题就可以迎刃而解了，具体如下：

首先，我们在 Maven 配置中引入 @valid 的依赖：

如果你是 springboot 项目，那么可以不用引入了，已经引入了，他就存在于最核心的 web 开发包里面。

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.0.5.RELEASE</version>
    </dependency>

如果你不是 springboot 项目，那么引入下面依赖即可：

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

那么针对上面情景，我们可以对我们的代码进行优化了。

首先我们在 Employee 类的属性上打上如下注解：

package com.zyq.beans;
    
    import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.NotNull;
    
    import org.hibernate.validator.constraints.Length;
    import org.hibernate.validator.constraints.Range;
    
    /**
     * 员工对象
     * 
     * @author sunnyzyq
     * @since 2019/12/13
     */
    public class Employee {
    
        /** 姓名 */
        @NotBlank(message = "请输入名称")
        @Length(message = "名称不能超过个 {max} 字符", max = 10)
        public String name;
    
        /** 年龄 */
        @NotNull(message = "请输入年龄")
        @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)
        public Integer 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;
        }
    
    }

然后再 Controller 对应方法上，对这个员工标上 @Valid 注解，表示我们对这个对象属性需要进行验证，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 3][]

既然验证，那么就肯定会有验证结果，所以我们需要用一个东西来存放验证结果，做法也很简单，在参数直接添加一个BindingResult，具体如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 4][]

对应获取验证结果的代码如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 5][]

OK ! 万事俱备 ！我们进行测试下：

（1）名称为空

![20191213163015815.png][]

（2）名称正常，年龄为空

![20191213163048322.png][]

（3）名称超出范围，年龄正常

![20191213163212940.png][]

（4）名称正常，年龄超出范围

![20191213163320448.png][]

可以看到，代码不但简洁了很多，结果和预期的也一模一样！很棒吧！！

**常用注解：**

**除了刚刚都注解，最后再附加2个常用注解，我就直接贴图了，基本上这6个注解可以解决99%的字段，其他注解我就不贴图了，如果不满足，自己问百度。**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 6][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191213151533181.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[20191213151330417.png]: https://img-blog.csdnimg.cn/20191213151330417.png
[20191213151746490.png]: https://img-blog.csdnimg.cn/20191213151746490.png
[20191213151829944.png]: https://img-blog.csdnimg.cn/20191213151829944.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191213152326142.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191213153338912.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191213162003927.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20191213162507228.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/2019121316284259.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70
[20191213163015815.png]: https://img-blog.csdnimg.cn/20191213163015815.png
[20191213163048322.png]: https://img-blog.csdnimg.cn/20191213163048322.png
[20191213163212940.png]: https://img-blog.csdnimg.cn/20191213163212940.png
[20191213163320448.png]: https://img-blog.csdnimg.cn/20191213163320448.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20191213164008691.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx,size_16,color_FFFFFF,t_70