效果和優點

---

先看最后效果：

public class UserEntity {@Password private String password;@Emailprivate 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驗證。

自定義一個驗證注解分為三步：

• 創建注解（Create a constraint annotation）
• 創建驗證類（Implement a validator）

• 定義默認錯誤信息（Define a default error message）

  第一步，創建注解：

@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;@Overridepublic void initialize(Email constraintAnnotation) {this.regexp = constraintAnnotation.regexp();}@Overridepublic 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，所以這步不用做。

---

1、hibernate validation的文檔說得更詳細：
Creating a simple constraint.html

2、這篇博客及其下一篇講得也挺好：
深入理解Java：注解（Annotation）自定義注解入門

3、常見錯誤：
HV000030: No validator could be found for type
原因一般是沒有設置@Constraint(validatedBy = { EmailValidator.class })

HV000028: Unexpected exception during isValid call
原因一般是沒有設置

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

4、JSR文獻：
JSR 303: Bean Validation

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的自定义hibernate validation注解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。