Bean Validation 中內置的constraint
@Null 被註釋的元素必須為null
@NotNull 被註釋的元素必須不為null
@AssertTrue 被註釋的元素必須為true
@AssertFalse 被註釋的元素必須為false
@Min(value) 被註釋的元素必須是一個數字,其值必須大於等於指定的最小值
@Max(value) 被註釋的元素必須是一個數字,其值必須小於等於指定的最大值
@DecimalMin(value) 被註釋的元素必須是一個數字,其值必須大於等於指定的最小值
@DecimalMax(value) 被註釋的元素必須是一個數字,其值必須小於等於指定的最大值
@Size(max=, min=) 被註釋的元素的大小必須在指定的範圍內
@Digits (integer, fraction) 被註釋的元素必須是一個數字,其值必須在可接受的範圍內
@Past 被註釋的元素必須是一個過去的日期
@Future 被註釋的元素必須是一個將來的日期
@Pattern(regex=,flag=) 被註釋的元素必須符合指定的正則表達式
Hibernate Validator 附加的constraint
@NotBlank(message =) 驗證字符串非null,且長度必須大於0
@Email 被註釋的元素必須是電子郵箱地址
@Length(min=,max=) 被註釋的字符串的大小必須在指定的範圍內
@NotEmpty 被註釋的字符串的必須非空
@Range(min=,max=,message=) 被註釋的元素必須在合適的範圍內
效果和優點
先看最後效果:
public class UserEntity { @Password private String password; @Email private String email;}上面使用了兩個自定義的註解來驗證password和email,這樣做的好處是:一處定義,處處使用,要修改驗證規則時,也只要修改註解就可以了。而如果自定義,使用hibernate提供的標籤的話:
@Pattern(regexp="...")private String email;
如果寫了很多個類之後,突然要修改驗證規則regexp,此時工作量將要大得多。
實現
首先,引入hibernate validation依賴,添加:
<!-- hibernate validator --> <!-- hibernate 驗證框架--> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.2.2.Final</version> </dependency>
hibernate validation是JSR的參考實現,所以,用它做bean驗證。
自定義一個驗證註解分為三步:
第一步,創建註解:
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })@Retention(RUNTIME)@Documented@Constraint(validatedBy = { EmailValidator.class })public @interface Email { String message() default "這不是有效的電子郵件格式"; /** * @return the regular expression to match */ String regexp() default "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9]+//.[a-zA-Z]{2,4}"; Class<?>[] groups() default { }; Class<? extends Payload>[] payload() default { }; /** * Defines several {@link Size} annotations on the same element. * * @see Size */ @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER }) @Retention(RUNTIME) @Documented @interface List { Email[] value(); }}通過@interface關鍵字來創建註解,而每一個方法就是註解的一個參數。比如上面的代碼,就可以這樣使用@Email(regexp="...",message="...") 。其它可以不用去管,直接複製就可以了,要注意的是@Constraint(validatedBy = { EmailValidator.class }) ,這裡指定註解的驗證類,根據實際替換類名。
第二步,創建驗證類:
public class EmailValidator implements ConstraintValidator<Email, String>{ private String regexp; @Override public void initialize(Email constraintAnnotation) { this.regexp = constraintAnnotation.regexp(); } @Override public boolean isValid(String value, ConstraintValidatorContext context) { if(value==null){return true;} if( value.matches(regexp)){ return true; } return false; }}這裡只要實現ConstraintValidator<Email, String>接口就創建了一個驗證器。 initialize方法得到註解的regexp值,在isValid方法中進行驗證,符合正則表達式就返回true,否則返回false。
需要注意的是,當value為空,也就是驗證的對像沒有初始化的時候,要編寫相應的驗證規則,不然會報錯的。在上面代碼中編寫的是:
if(value==null){return true;}也即是,當驗證對象為空時,返回成功。
第三步是編寫默認錯誤信息。其實這一步在第一步已經做了,通過default,所以這步不用做。
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對武林網的支持。