SpringMVC--使用hibernate validator数据校验

水深无声 2021-08-13 23:09 456阅读 0赞

### JSR 303 ###

Spring3开始支持JSR 303 验证框架，JSR303是Java为Bean数据合法性校验所提供的标准框架。JSR 303 支持XML和注解风格的验证，通过在Bean属性上标注类似于@NotNull等的标准注解指定校验规则，并通过标准的验证接口对Bean进行验证。

**JSR 303注解约束**

<table> 
 <thead> 
  <tr> 
   <th align="left">约束</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">@Null</td> 
   <td align="left">被注解的元素必须为Null</td> 
  </tr> 
  <tr> 
   <td align="left">@NotNull</td> 
   <td align="left">被注解的元素必须不为Null</td> 
  </tr> 
  <tr> 
   <td align="left">@AssertTrue</td> 
   <td align="left">被注解的元素必须为true</td> 
  </tr> 
  <tr> 
   <td align="left">@AssertFalse</td> 
   <td align="left">被注解的元素必须为false</td> 
  </tr> 
  <tr> 
   <td align="left">@Min(value)</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须大于等于最小值</td> 
  </tr> 
  <tr> 
   <td align="left">@Max(value)</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须小于等于最大值</td> 
  </tr> 
  <tr> 
   <td align="left">@DecimalMin(value)</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须大于等于最小值</td> 
  </tr> 
  <tr> 
   <td align="left">@DecimalMax(value)</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须小于等于最大值</td> 
  </tr> 
  <tr> 
   <td align="left">@Size(max,min)</td> 
   <td align="left">被注解的元素的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td align="left">@Digits(integer,fraction)</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须在可接受范围内</td> 
  </tr> 
  <tr> 
   <td align="left">@Past</td> 
   <td align="left">被注解的元素必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td align="left">@Future</td> 
   <td align="left">被注解的元素必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td align="left">@Pattern(value)</td> 
   <td align="left">被注解的元素必须符合指定的正则表达式</td> 
  </tr> 
 </tbody> 
</table>

**Hibernate Validator扩展的注解**

<table> 
 <thead> 
  <tr> 
   <th align="left">约束</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">@NotBlank</td> 
   <td align="left">检查被注解的元素是不是Null，以及被去掉前后空格的长度是否大于0</td> 
  </tr> 
  <tr> 
   <td align="left">@Email</td> 
   <td align="left">被注解的元素必须是电子邮件格式</td> 
  </tr> 
  <tr> 
   <td align="left">@URL</td> 
   <td align="left">被注解的元素必须是合法的URL地址</td> 
  </tr> 
  <tr> 
   <td align="left">@length</td> 
   <td align="left">被注解的字符串的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td align="left">@NotEmpty</td> 
   <td align="left">检查被注解的字符串必须非空</td> 
  </tr> 
  <tr> 
   <td align="left">@Range</td> 
   <td align="left">被注解的元素必须在合适的范围内</td> 
  </tr> 
 </tbody> 
</table>

### 实例 ###

**引入依赖**  
pom.xml

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

**创建实体类**

package pers.zhang.entity;
    
    import org.hibernate.validator.constraints.Email;
    import org.hibernate.validator.constraints.NotEmpty;
    import org.hibernate.validator.constraints.Range;
    
    import javax.validation.constraints.Size;
    
    /** * @author zhang * @date 2019/11/27 - 9:55 */
    public class Person { 
    
        @NotEmpty
        @Size(min = 6, max = 20)
        private String name;
    
        @Range(min = 18, max = 45)
        private int age;
    
        @Email
        @NotEmpty
        private String email;
    
        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;
        }
    
        public String getEmail() { 
            return email;
        }
    
        public void setEmail(String email) { 
            this.email = email;
        }
    }

**Controller**

package pers.zhang.cotroller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.FieldError;
    import org.springframework.web.bind.annotation.RequestMapping;
    import pers.zhang.entity.Person;
    
    import javax.validation.Valid;
    
    /** * @author zhang * @date 2019/11/27 - 9:56 */
    @Controller
    public class PersonController { 
    
    	/* @Valid注解告诉SpringMVC，Person类的对象person在绑定表单数据后需要进行JSR 303 验证，绑定的结果保存到BindingResult类型的对象result中，通过判断result就可以知道 绑定过程是否出现错误，如果出现错误则输出。 */
        @RequestMapping("/testValidate")
        public String testValidate(@Valid Person person, BindingResult result){ 
            if(result.getErrorCount() > 0){ 
                for(FieldError error : result.getFieldErrors()){ 
                    System.out.println(error.getField() + ":" + error.getDefaultMessage());
                }
            }
            return  "success";
        }
    }

**表单**

**测试**  
![在这里插入图片描述][20191127124232160.png]

name:不能为空
    age:需要在18和45之间
    name:个数必须在6和20之间
    email:不是一个合法的电子邮件地址

[20191127124232160.png]: /images/20210813/db55d53c9b3742298039d262f7552025.png