Hibernate Validation自定义注解校验

1. 情景：需要对String类型的属性比如description进行验证，验证规则是当description为空时不进行正则校验，description不为空时进行正则校验。上述需求Hibernate Validation没有可用于上述需求的注解，故自定义一个注解并自定义校验规则。

2. 自定义注解进行校验的步骤

   • 写一个校验注解，在注解中指定校验器类，校验注解与校验器一般一一对应。
   • 写一个校验器类并在校验器类中写校验逻辑，校验器必须实现ConstraintValidator<?, ?>接口，第一个参数是对应的注解，第二个参数是要校验的属性的类型
3. 代码示例
   校验注解

package com.kunlun.validation.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

import com.kunlun.validation.validator.KlPatternValidator;

/**
 * 自定义的校验注解
 * 规则：
 *  1.如果字符串为空串或者为null，则不进行正则校验
 *  2.如果字符串不为空串，则必须进行正则校验
 * @author xc
 * @date 2018年1月19日上午11:38:02
 */
@Documented
// 指定该注解可以使用的地方
@Target(value= {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
// 指定实际进行校验的校验器，该校验器是自己写的且必须实现ConstraintValidator接口
@Constraint(validatedBy=KlPatternValidator.class)
public @interface KlPattern {
    /*
     * 用于验证的注解下列这三个方法必须要，这是Hibernate Validation框架要求的，否则程序再在调用的时候会报错
     * default用于对属性给定默认值
     *  如果不给定默认值，则在使用注解的时候必须给属性指定属性值，否则报错
     *  给定默认值时，在使用注解的时候可以不用指定属性值
     */
    String message() default "不符合正则！";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    // 没加default给定默认值，使用注解的时候该属性必须赋值，否则报错
    String regex();
    // value属性，加上了default "mercy" 使得该属性在使用注解的时候可以不用输入也不会报错
    String value() default "mercy";
}

与上面校验注解对应的校验器类

package com.kunlun.validation.validator;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import com.kunlun.validation.annotation.KlPattern;

/**
 * KlPatternValidator是KlPattern注解实际调用的验证器
 * 在KlPatternValidator中完成校验逻辑
 * 
 * @author xc
 * @date 2018年1月19日上午11:44:38
 */
public class KlPatternValidator implements ConstraintValidator<KlPattern, String> {

    private String regex;

    /**
     * 通过initialize()可以获取注解里的属性值
     */
    @Override
    public void initialize(KlPattern constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
        regex = constraintAnnotation.regex();
    }

    /**
     * 实际验证逻辑
     *  返回值为true表示验证通过，
     *  返回值为false表示验证未通过
     */
    @Override
    public boolean isValid(String s, ConstraintValidatorContext ctx) {

        // 当前前端传过来的请求参数是空串，或者没传的时候，不进行后续正则校验
        if ("".equals(s) || s == null) {
            return true;
        }

        // 进行正则校验
        if(s.matches(regex)) {
            return true;
        }

        return false;
    }

}