怎么自定義hibernate validation注解

這篇文章主要介紹怎么自定義hibernate validation注解，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

Bean Validation 中內(nèi)置的 constraint

@Null 被注釋的元素必須為 null
@NotNull 被注釋的元素必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Min(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值
@Max(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值
@Size(max=, min=) 被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction) 被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)
@Past 被注釋的元素必須是一個(gè)過(guò)去的日期
@Future 被注釋的元素必須是一個(gè)將來(lái)的日期
@Pattern(regex=,flag=) 被注釋的元素必須符合指定的正則表達(dá)式

Hibernate Validator 附加的 constraint
@NotBlank(message =) 驗(yàn)證字符串非null，且長(zhǎng)度必須大于0
@Email 被注釋的元素必須是電子郵箱地址
@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty 被注釋的字符串的必須非空
@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內(nèi)

效果和優(yōu)點(diǎn)

先看最后效果：

public class UserEntity {
 @Password 
 private String password;
 @Email
 private String email;
}

上面使用了兩個(gè)自定義的注解來(lái)驗(yàn)證password和email，這樣做的好處是：一處定義，處處使用，要修改驗(yàn)證規(guī)則時(shí)，也只要修改注解就可以了。而如果自定義，使用hibernate提供的標(biāo)簽的話：

@Pattern(regexp="...")
private String email;

如果寫(xiě)了很多個(gè)類(lèi)之后，突然要修改驗(yàn)證規(guī)則regexp，此時(shí)工作量將要大得多。

實(shí)現(xiàn)

首先，引入hibernate validation依賴，添加：

 <!-- hibernate validator -->
 <!-- hibernate 驗(yàn)證框架 -->
 <dependency>
 <groupId>org.hibernate</groupId>
 <artifactId>hibernate-validator</artifactId>
 <version>5.2.2.Final</version>
 </dependency>

hibernate validation是JSR的參考實(shí)現(xiàn)，所以，用它做bean驗(yàn)證。

自定義一個(gè)驗(yàn)證注解分為三步：

• 創(chuàng)建注解（Create a constraint annotation）

• 創(chuàng)建驗(yàn)證類(lèi)（Implement a validator）

• 定義默認(rèn)錯(cuò)誤信息（Define a default error message）

第一步，創(chuàng)建注解：

@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();
 }
}

通過(guò)@interface關(guān)鍵字來(lái)創(chuàng)建注解，而每一個(gè)方法就是注解的一個(gè)參數(shù)。比如上面的代碼，就可以這樣使用@Email(regexp="...",message="...") 。其它可以不用去管，直接復(fù)制就可以了，要注意的是@Constraint(validatedBy = { EmailValidator.class })，這里指定注解的驗(yàn)證類(lèi)，根據(jù)實(shí)際替換類(lèi)名。

第二步，創(chuàng)建驗(yàn)證類(lèi)：

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;
 }
}

這里只要實(shí)現(xiàn)ConstraintValidator<Email, String>接口就創(chuàng)建了一個(gè)驗(yàn)證器。initialize方法得到注解的regexp值，在isValid方法中進(jìn)行驗(yàn)證，符合正則表達(dá)式就返回true，否則返回false。

需要注意的是，當(dāng)value為空，也就是驗(yàn)證的對(duì)象沒(méi)有初始化的時(shí)候，要編寫(xiě)相應(yīng)的驗(yàn)證規(guī)則，不然會(huì)報(bào)錯(cuò)的。在上面代碼中編寫(xiě)的是：

if(value==null){return true;}

也即是，當(dāng)驗(yàn)證對(duì)象為空時(shí)，返回成功。

第三步是編寫(xiě)默認(rèn)錯(cuò)誤信息。其實(shí)這一步在第一步已經(jīng)做了，通過(guò)default，所以這步不用做。

以上是“怎么自定義hibernate validation注解”這篇文章的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對(duì)大家有幫助，更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！