效果和優點

先看最後效果：

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驗證。

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

• 建立註解（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._%+-][email protected][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，所以這步不用做。

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

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