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;

/**
 * 自定義的校驗(yàn)注解
 * 規(guī)則：
 * 1.如果字符串為空串或者為null，則不進(jìn)行正則校驗(yàn)
 * 2.如果字符串不為空串，則必須進(jìn)行正則校驗(yàn)
 * @author xc
 * @date 2018年1月19日上午11:38:02
 */
@Documented
// 指定該注解可以使用的地方
@Target(value= {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
// 指定實(shí)際進(jìn)行校驗(yàn)的校驗(yàn)器，該校驗(yàn)器是自己寫的且必須實(shí)現(xiàn)ConstraintValidator接口
@Constraint(validatedBy=KlPatternValidator.class)
public @interface KlPattern {
  /*
   * 用于驗(yàn)證的注解下列這三個(gè)方法必須要，這是Hibernate Validation框架要求的，否則程序再在調(diào)用的時(shí)候會(huì)報(bào)錯(cuò)
   * default用于對(duì)屬性給定默認(rèn)值
   * 如果不給定默認(rèn)值，則在使用注解的時(shí)候必須給屬性指定屬性值，否則報(bào)錯(cuò)
   * 給定默認(rèn)值時(shí)，在使用注解的時(shí)候可以不用指定屬性值
   */
  String message() default "不符合正則！";

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

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

  // 沒加default給定默認(rèn)值，使用注解的時(shí)候該屬性必須賦值，否則報(bào)錯(cuò)
  String regex();
  // value屬性，加上了default "mercy" 使得該屬性在使用注解的時(shí)候可以不用輸入也不會(huì)報(bào)錯(cuò)
  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注解實(shí)際調(diào)用的驗(yàn)證器
 * 在KlPatternValidator中完成校驗(yàn)邏輯
 * 
 * @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();
  }

  /**
   * 實(shí)際驗(yàn)證邏輯
   * 返回值為true表示驗(yàn)證通過，
   * 返回值為false表示驗(yàn)證未通過
   */
  @Override
  public boolean isValid(String s, ConstraintValidatorContext ctx) {

    // 當(dāng)前前端傳過來的請(qǐng)求參數(shù)是空串，或者沒傳的時(shí)候，不進(jìn)行后續(xù)正則校驗(yàn)
    if ("".equals(s) || s == null) {
      return true;
    }

    // 進(jìn)行正則校驗(yàn)
    if(s.matches(regex)) {
      return true;
    }

    return false;
  }
}