springboot自定义参数校验规则

上一篇讲了Springboot中参数校验优雅实践，本篇讲解如果自定义参数校验规则。在日常开发中Bean Validation 中内置的注解已经可以满足我们大部分需求，但是在处理一些特殊的校验规则时需要我们自定义注解实现。下面以日期格式校验规则为例，如何在springboot 中自定义注解实现参数的校验：

首先定义一个注解类：

package com.validator.demo.api.valid;

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 org.apache.commons.lang3.StringUtils;

@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = { ValidDateValidator.class })
public @interface ValidDate {
    String pattern() default "yyyy-MM-dd";

    String message() default StringUtils.EMPTY;

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

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

@Target —— 表示这个注解可以作用在什么地方

1. ElementType.TYPE：接口、类、枚举、注解
2. ElementType.FIELD：字段、枚举的常量
3. ElementType.METHOD：方法
4. ElementType.PARAMETER：方法参数
5. ElementType.CONSTRUCTOR：构造函数
6. ElementType.LOCAL_VARIABLE：局部变量
7. ElementType.ANNOTATION_TYPE：注解
8. ElementType.PACKAGE：包

   
@Retention作用是定义被它所注解的注解保留多久

1. source：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；被编译器忽略
2. class：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期
3. runtime：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在

使用@Documented标注了，在生成javadoc的时候就会把@Documented注解给显示出来@Documented注解只是用来做标识，没什么实际作用

@Constraint —— 表示我们判断逻辑的具体实现类是什么。

在定义一个具体的校验逻辑实现类：

package com.validator.demo.api.valid;

import java.text.ParseException;

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

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DateUtils;

public class ValidDateValidator implements ConstraintValidator<ValidDate, String> {

    private String pattern = StringUtils.EMPTY;

    @Override
    public void initialize(ValidDate constraintAnnotation) {
        pattern = constraintAnnotation.pattern();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (StringUtils.isBlank(value)) {
            return true;
        }
        try {
            DateUtils.parseDateStrictly(value, pattern);
        } catch (ParseException e) {
            return false;
        }
        return true;
    }

}

在实体类中添加相应的注解

调用接口返回如下：