使用JSR-303進行后台數據校驗

一、在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標注。現在假設我們需要定義一個表示金額的限制類型，那么我們可以這樣定義：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

import com.xxx.xxx.constraint.impl.MoneyValidator;

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=MoneyValidator.class)
public @interface Money {

    String message() default"不是金額形式";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

 

       我們可以看到在上面代碼中我們定義了一個Money注解，而且該注解上標注了@Constraint注解，使用@Constraint注解標注表明我們定義了一個用於限制的注解。@Constraint注解的validatedBy屬性用於指定我們定義的當前限制類型需要被哪個ConstraintValidator進行校驗。在上面代碼中我們指定了Money限制類型的校驗類是MoneyValidator。另外需要注意的是我們在定義自己的限制類型的注解時有三個屬性是必須定義的，如上面代碼所示的message、groups和payload屬性。

       在定義了限制類型Money之后，接下來就是定義我們的限制類型校驗類MoneyValidator了。限制類型校驗類必須實現接口javax.validation.ConstraintValidator，並實現它的initialize和isValid方法。我們先來看一下MoneyValidator的代碼示例：

import java.util.regex.Pattern;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import com.xxx.xxx.constraint.Money;

public class MoneyValidator implements ConstraintValidator<Money, Double> {

    private String moneyReg = "^\\d+(\\.\\d{1,2})?$";//表示金額的正則表達式
    private Pattern moneyPattern = Pattern.compile(moneyReg);

    public void initialize(Money money) {
       // TODO Auto-generated method stub

    }

    public boolean isValid(Double value, ConstraintValidatorContext arg1) {
       // TODO Auto-generated method stub
       if (value == null)
           return true;
       return moneyPattern.matcher(value.toString()).matches();
    }

}

 

       從上面代碼中我們可以看到ConstraintValidator是使用了泛型的。它一共需要指定兩種類型，第一個類型是對應的initialize方法的參數類型，第二個類型是對應的isValid方法的第一個參數類型。從上面的兩個方法我們可以看出isValid方法是用於進行校驗的