使用JSR-303进行校验

待我称王封你为后i 2021-09-04 06:54 477阅读 0赞

## 一、JSR303定义的校验类型 ##

<table> 
 <thead> 
  <tr> 
   <th>空检查</th> 
   <th>&nbsp;</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Null</td> 
   <td>验证对象是否为null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>验证对象是否不为null, 无法查检长度为0的字符串</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td>检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>检查约束元素是否为NULL或者是EMPTY.</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>Booelan检查</th> 
   <th>&nbsp;</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>验证 Boolean 对象是否为 true</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>验证 Boolean 对象是否为 false</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>长度检查</th> 
   <th>&nbsp;</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Size(min=, max=)</td> 
   <td>验证对象（Array,Collection,Map,String）长度是否在给定的范围之内</td> 
  </tr> 
  <tr> 
   <td>@Length(min=, max=)</td> 
   <td>Validates that the annotated string is between min and max included.</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>日期检查</th> 
   <th>&nbsp;</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Past</td> 
   <td>验证 Date 和 Calendar 对象是否在当前时间之前</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>验证 Date 和 Calendar 对象是否在当前时间之后</td> 
  </tr> 
  <tr> 
   <td>@Pattern</td> 
   <td>验证 String 对象是否符合正则表达式的规则</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>数值检查</th> 
   <th>建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Min</td> 
   <td>验证 Number 和 String 对象是否大等于指定的值</td> 
  </tr> 
  <tr> 
   <td>@Max</td> 
   <td>验证 Number 和 String 对象是否小等于指定的值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax</td> 
   <td>被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin</td> 
   <td>被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度</td> 
  </tr> 
  <tr> 
   <td>@Digits</td> 
   <td>验证 Number 和 String 的构成是否合法</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer=,fraction=)</td> 
   <td>验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>@Range(min=, max=)</th> 
   <th>检查数字是否介于min和max之间.</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Range(min=10000,max=50000,message=“range.bean.wage”)</td> 
   <td>private BigDecimal wage;</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>@Valid</th> 
   <th>递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@CreditCardNumber</td> 
   <td>信用卡验证</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>验证是否是邮件地址，如果为null,不进行验证，算通过验证。</td> 
  </tr> 
  <tr> 
   <td>@ScriptAssert(lang= ,script=, alias=)</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>@URL(protocol=,host=, port=,regexp=, flags=)</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

## 二、在SringMVC中使用 ##

使用注解

### 1、准备校验时使用的JAR ###

validation-api-1.0.0.GA.jar：JDK的接口；

hibernate-validator-4.2.0.Final.jar是对上述接口的实现；

log4j、slf4j、slf4j-log4j

### 2、编写需要校验的bean ###

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

### 3、校验方法 ###

@RequestMapping("/login")
    public String testValid(@Valid User user, BindingResult result){
        if (result.hasErrors()){
            List<ObjectError> errorList = result.getAllErrors();
            for(ObjectError error : errorList){
                System.out.println(error.getDefaultMessage());
            }
        }
        return "test";
    }

备注：这里一个@Valid的参数后必须紧挨着一个BindingResult 参数，否则spring会在校验不通过时直接抛出异常

前台可以使用spring的标签库也可以自己自定义处理

### 4、spring标签库的用法 ###

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>   
      
    <html>   
    <head>   
    <title>Reservation Form</title>   
    <style>   
    .error {   
        color: #ff0000;   
        font-weight: bold;   
    }   
    </style>   
    </head>   
      
    <body>   
        <form:form method="post" modelAttribute="vm">   
            <form:errors path="*" cssClass="error" />   
            <table>   
                <tr>   
                    <td>Name</td>   
                    <td><form:input path="userName" />   
                    </td>   
                    <td><form:errors path="userName" cssClass="error" />   
                    </td>   
                </tr>   
                <tr>   
                    <td>email</td>   
                    <td><form:input path="email" />   
                    </td>   
                    <td><form:errors path="email" cssClass="error" />   
                    </td>   
                </tr>   
           
                <tr>   
                    <td colspan="3"><input type="submit" />   
                    </td>   
                </tr>   
            </table>   
        </form:form>   
    </body>   
    </html>

### 5、开启spring的Valid功能 ###

<mvc:annotation-driven />

## 三、自定义校验类型 ##

### 1、需要验证的实体 Bean ###

public class LoginVo {
        
        @NotNull
        @IsMobile //自定义的注解
        private String mobile;
        
        @NotNull
        @Length(min=32)
        private String password;
        
        //省略 get set 方法
    }

### 2、自定义 IsMobile 注解类 ###

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
    import static java.lang.annotation.ElementType.CONSTRUCTOR;
    import static java.lang.annotation.ElementType.FIELD;
    import static java.lang.annotation.ElementType.METHOD;
    import static java.lang.annotation.ElementType.PARAMETER;
    import static java.lang.annotation.RetentionPolicy.RUNTIME;
    import java.lang.annotation.Documented;
    import java.lang.annotation.Retention;
    import java.lang.annotation.Target;
    import javax.validation.Constraint;
    import javax.validation.Payload;
     
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @Constraint(validatedBy = {IsMobileValidator.class })
    public @interface  IsMobile {
        
      //允许为空的属性
        boolean required() default true;
     
        //如果校验不通过返回的提示信息
        String message() default "手机号码格式错误";
     
        Class<?>[] groups() default { };
     
        Class<? extends Payload>[] payload() default { };
    }

### 3、校验器 ###

import  javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import org.apache.commons.lang3.StringUtils;
    import com.imooc.miaosha.util.ValidatorUtil;
     
    //IsMobile：自定义的注解
    //String：注解参数类型
    public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
     
      //默认值_false，用于接收注解上自定义的 required
        private boolean required = false;
        
      //1、初始化方法：通过该方法我们可以拿到我们的注解
        public void initialize(IsMobile constraintAnnotation) {
     
            //constraintAnnotation.required() 接收我们自定义的属性，是否为空
            required = constraintAnnotation.required();
        }
     
      //2、逻辑处理
        public boolean isValid(String value, ConstraintValidatorContext context) {
     
            //2.1、如果允许为空的话，直接返回结果
            if(required) {
                return ValidatorUtil.isMobile(value);
            }else {
            //2.2、不允许为空
                //2.2.1、验证是否为空
                if(StringUtils.isEmpty(value)) {
                    return true;
                }else {
                    return ValidatorUtil.isMobile(value);
                }
            }
        }
     
    }

### 4、总结 ###

自定义注解需要去手动实现两个文件：自定义注解类+ 注解校验器类

自定义注解类：message() + groups() + payload() 必须；

注解校验器类：继承 ConstraintValidator 类<注解类，注解参数类型> + 两个方法（initialize：初始化操作、isValid：逻辑处理）

往期精彩内容：

[超详细的springBoot学习笔记][springBoot]

[Java多线程基础知识总结（绝对经典）][Java]

[Java面试题总结（附答案）][Java 1]

[Vue基础知识总结（绝对经典）][Vue]

[常见数据结构与算法整理总结][Link 1]

[springBoot]: https://blog.csdn.net/guorui_java/article/details/104137262
[Java]: https://blog.csdn.net/guorui_java/article/details/107599455
[Java 1]: https://blog.csdn.net/guorui_java/article/details/107803283
[Vue]: https://blog.csdn.net/guorui_java/article/details/106917601
[Link 1]: https://blog.csdn.net/guorui_java/article/details/106217472