JSR 303 - Bean Validation後端數據效驗

1、JSR-303簡介
JSR-303 是 JAVA EE 6 中的一項子規範,叫作 Bean Validation,官方參考實現是Hibernate Validator。java

此實現與 Hibernate ORM 沒有任何關係。 JSR 303 用於對 Java Bean 中的字段的值進行驗證。
Spring MVC 3.x 之中也大力支持 JSR-303,能夠在控制器中對錶單提交的數據方便地驗證。
注:可使用註解的方式進行驗證git

2、準備校驗時使用的JAR
validation-api-1.0.0.GA.jar:JDK的接口;
hibernate-validator-4.2.0.Final.jar是對上述接口的實現;
log4j、slf4j、slf4j-log4j正則表達式

3、JSR 303 基本的校驗規則
空檢查
@Null 驗證對象是否爲null
@NotNull 驗證對象是否不爲null, 沒法查檢長度爲0的字符串
@NotBlank 檢查約束字符串是否是Null還有被Trim的長度是否大於0,只對字符串,且會去掉先後空格.
@NotEmpty 檢查約束元素是否爲NULL或者是EMPTY.api

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 對象是否符合正則表達式的規則,被註釋的元素符合制定的正則表達式,regexp:正則表達式 flags: 指定 Pattern.Flag 的數組,表示正則表達式的相關選項。測試

數值檢查
建議使用在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=) 被指定的元素必須在合適的範圍內
@Range(min=10000,max=50000,message=」range.bean.wage」)
@Valid 遞歸的對關聯對象進行校驗, 若是關聯對象是個集合或者數組,那麼對其中的元素進行遞歸校驗,若是是一個map,則對其中的值部分進行校驗.(是否進行遞歸驗證)
@CreditCardNumber信用卡驗證
@Email 驗證是不是郵件地址,若是爲null,不進行驗證,算經過驗證。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)ui

4、案例分析
在使用的時候直接對JavaBean進行註解既能夠實現對屬性的驗證this

public class Order {
// 必須不爲 null, 大小是 10
@NotNull
@Size(min = 10, max = 10)
private String orderId;
// 必須不爲空
@NotEmpty
private String customer;
// 必須是一個電子信箱地址
@Email
private String email;
// 必須不爲空
@NotEmpty
private String address;
// 必須不爲 null, 必須是下面四個字符串'created', 'paid', 'shipped', 'closed'其中之一
// @Status 是一個定製化的 contraint
@NotNull
@Status
private String status;
// 必須不爲 null
@NotNull
private Date createDate;
// 嵌套驗證
@Valid
private Product product;.net

// getter 和setter方法
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
又例:

@NotNull(message = "adultTax不能爲空")
private Integer adultTax;

@NotNull(message = "adultTaxType不能爲空")
@Min(value = 0, message = "adultTaxType 的最小值爲0")
@Max(value = 1, message = "adultTaxType 的最大值爲1")
private Integer adultTaxType;

@NotNull(message = "reason信息不能夠爲空")
@Pattern(regexp = "[1-7]{1}", message = "reason的類型值爲1-7中的一個類型")
private String reason;//訂單取消緣由
1
2
3
4
5
6
7
8
9
10
11
5、下邊是一個完整的例子:
public class ValidateTestClass{

@NotNull(message = "reason信息不能夠爲空")
@Pattern(regexp = "[1-7]{1}", message = "reason的類型值爲1-7中的一個類型")
private String reason;//訂單取消緣由

//get、set方法、有參構造方法、無參構造方法、toString方法省略

/**
* 驗證參數:就是驗證上述註解的完整方法
* @return
*/
public void validateParams() {
//調用JSR303驗證工具,校驗參數
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<ValidateTestClass>> violations = validator.validate(this);
Iterator<ConstraintViolation<ValidateTestClass>> iter = violations.iterator();
if (iter.hasNext()) {
String errMessage = iter.next().getMessage();
throw new ValidationException(errMessage);
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
咱們能夠寫一個測試類進行驗證:

public class ValidateTestClassValidateTest{

@Test
public void validateParam(){
ValidateTestClass validateTestClass = new ValidateTestClass();
validateTestClass .setReason(12);

validateTestClass .validateParams(); //調用驗證的方法
}
}
1
2
3
4
5
6
7
8
9
10
ok!這樣就能夠進行測試。

而且咱們在使用的時候必定要注意,對於某一種驗證規則是適用於一種數據類型的,簡單說來,正則則表達式的驗證對象能夠爲String類型的,可是不能夠爲Integer類型的數據,那麼當咱們使用正則表達式進行驗證的時候就會出現錯誤。
相似於:

javax.validation.UnexpectedTypeException: HV000030: No validator could be found for type: java.lang.Integer.at org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorManager.verifyResolveWasUnique(ConstraintValidatorManager.java:218)12意思就是你這個驗證的註解不該該對該類型進行註解。

相關文章
相關標籤/搜索