使用JSR-303进行后台数据校验

Posted 2020-10-18 @jason

一、在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会在校验不通过时直接抛出异常。

二、硬编码的实现方式

手动校验实现方式：

 1 import java.util.Iterator;
 2 import java.util.Set;
 3 
 4 import javax.validation.ConstraintViolation;
 5 import javax.validation.Validation;
 6 
 7 import org.apache.commons.lang3.StringUtils;
 8 
 9 /**
10  * JSR303的校验帮助类
11  * @author yangzhilong
12  *
13  */
14 public class Jsr303Util {
15 
16     /**
17      * 如果返回null则表示没有错误
18      * @param obj
19      * @return
20      */
21     public static String check(Object obj) {
22         if (null == obj) {
23             return "入参vo不能为空";
24         }
25         Set<ConstraintViolation<Object>> validResult = Validation.buildDefaultValidatorFactory().getValidator().validate(obj);
26         if (null != validResult && validResult.size() > 0) {
27             StringBuilder sb = new StringBuilder();
28             for (Iterator<ConstraintViolation<Object>> iterator = validResult.iterator(); iterator.hasNext();) {
29                 ConstraintViolation<Object> constraintViolation = (ConstraintViolation<Object>) iterator.next();
30                 if(StringUtils.isNotBlank(constraintViolation.getMessage())) {
31                     sb.append(constraintViolation.getMessage()).append("、");
32                 } else {
33                     sb.append(constraintViolation.getPropertyPath().toString()).append("不合法、");
34                 }
35             }
36             if (sb.lastIndexOf("、") == sb.length() - 1) {
37                 sb.delete(sb.length() - 1, sb.length());
38             }
39             return sb.toString();
40         }
41         return null;
42     }
43 
44 }

 

 三、JSR303定义的校验类型

空检查

@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=) Validates that the annotated string is between min and max included.

 

日期检查

@Past           验证 Date 和 Calendar 对象是否在当前时间之前  

@Future     验证 Date 和 Calendar 对象是否在当前时间之后  

@Pattern    验证 String 对象是否符合正则表达式的规则

 

数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null

@Min            验证 Number 和 String 对象是否大等于指定的值  

@Max            验证 Number 和 String 对象是否小等于指定的值  

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

@Digits     验证 Number 和 String 的构成是否合法  

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。

 

@Range(min=, max=) 检查数字是否介于min和max之间.

@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;

 

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)

@CreditCardNumber信用卡验证

@Email  验证是否是邮件地址，如果为null,不进行验证，算通过验证。

@ScriptAssert(lang= ,script=, alias=)

@URL(protocol=,host=, port=,regexp=, flags=)

四。自定义限制类型

       除了JSR-303原生支持的限制类型之外我们还可以定义自己的限制类型。定义自己的限制类型首先我们得定义一个该种限制类型的注解，而且该注解需要使用@Constraint标注。现在假设我们需要定义一个表示金额的限制类型，那么我们可以这样定义：

Java代码  

1.    
2. import java.lang.annotation.ElementType;  
3. import java.lang.annotation.Retention;  
4. import java.lang.annotation.RetentionPolicy;  
5. import java.lang.annotation.Target;  
6.    
7. import javax.validation.Constraint;  
8. import javax.validation.Payload;  
9.    
10. import com.xxx.xxx.constraint.impl.MoneyValidator;  
11.    
12. @Target({ElementType.FIELD, ElementType.METHOD})  
13. @Retention(RetentionPolicy.RUNTIME)  
14. @Constraint(validatedBy=MoneyValidator.class)  
15. public @interface Money {  
16.      
17.     String message() default"不是金额形式";  
18.      
19.     Class<?>[] groups() default {};  
20.      
21.     Class<? extends Payload>[] payload() default {};  
22.    
23. }  

 

       我们可以看到在上面代码中我们定义了一个Money注解，而且该注解上标注了@Constraint注解，使用@Constraint注解标注表明我们定义了一个用于限制的注解。@Constraint注解的validatedBy属性用于指定我们定义的当前限制类型需要被哪个ConstraintValidator进行校验。在上面代码中我们指定了Money限制类型的校验类是MoneyValidator。另外需要注意的是我们在定义自己的限制类型的注解时有三个属性是必须定义的，如上面代码所示的message、groups和payload属性。

       在定义了限制类型Money之后，接下来就是定义我们的限制类型校验类MoneyValidator了。限制类型校验类必须实现接口javax.validation.ConstraintValidator，并实现它的initialize和isValid方法。我们先来看一下MoneyValidator的代码示例：

Java代码  

1.    
2. import java.util.regex.Pattern;  
3.    
4. import javax.validation.ConstraintValidator;  
5. import javax.validation.ConstraintValidatorContext;  
6.    
7. import com.xxx.xxx.constraint.Money;  
8.    
9. public class MoneyValidator implements ConstraintValidator<Money, Double> {  
10.    
11.     private String moneyReg = "^\\d+(\\.\\d{1,2})?$";//表示金额的正则表达式  
12.     private Pattern moneyPattern = Pattern.compile(moneyReg);  
13.      
14.     public void initialize(Money money) {  
15.        // TODO Auto-generated method stub  
16.         
17.     }  
18.    
19.     public boolean isValid(Double value, ConstraintValidatorContext arg1) {  
20.        // TODO Auto-generated method stub  
21.        if (value == null)  
22.            return true;  
23.        return moneyPattern.matcher(value.toString()).matches();  
24.     }  
25.    
26. }  

 

       从上面代码中我们可以看到ConstraintValidator是使用了泛型的。它一共需要指定两种类型，第一个类型是对应的initialize方法的参数类型，第二个类型是对应的isValid方法的第一个参数类型。从上面的两个方法我们可以看出isValid方法是用于进行校验的