SpringBoot2 | 第二十六篇（二）：自定义验证

上一篇中介绍了数据有效性校验的重要性，也简单介绍了如何用轻松的方式搞定数据有效性校验，但是当系统自带的注解无法满足我们的要求时候应该咋办呢？这就是本章将给各位介绍的自定义 Validator 注解

[TOC]

为何要自定义

javax.validation 包与 hibernate-validator 包中存在的注解几乎可以满足大部分的要求，又拥有基于正则表达式的@Pattern，为什么还需要自己去定义呢？

原因如下

正则效率不高
正则可读性不好
正则门槛较高，很多开发者并不会编写正则表达式

环境/版本一览：

开发工具：Intellij IDEA 2018.2.2
springboot： 2.1.0.RELEASE
jdk：1.8.0_171
maven：3.3.9

1、pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2、application.yml

server:
  port: 8088

3、annotation

这里定义了一个 @DateTime 注解，在该注解上标注了 @Constraint 注解，它的作用就是指定一个具体的校验器类

关键字段（强制性）

message： 验证失败提示的消息内容
groups： 为约束指定验证组（非常不错的一个功能，下一章介绍）
payload： 不太清楚

package com.fatal.annotation;

import com.fatal.validator.DateTimeValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解：校验 Date 类型的格式
 * 最后两个属性时必须要的。否则会报错
 * @author: Fatal
 * @date: 2018/11/28 0028 11:40
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD, ElementType.PARAMETER}) // 属性和参数上可以使用
@Constraint(validatedBy = DateTimeValidator.class) // 指定该注解的校验器
public @interface DateTime {

    /**
     * 错误消息  - 关键字段
     *
     * @return 默认错误消息
     */
    String message() default "格式错误";

    /**
     * 格式
     *
     * @return 验证的日期格式
     */
    String format() default "yyyy-MM-dd";

    /**
     * 允许我们为约束指定验证组 - 关键字段（TODO 下一章中会介绍）
     *
     * @return 分组
     */
    Class<?>[] groups() default {};

    /**
     * payload - 关键字段
     *
     * @return 暂时不清楚, 知道的欢迎留言交流
     */
    Class<? extends Payload>[] payload() default {};

}

4、entity

package com.fatal.entity;

import com.fatal.annotation.DateTime;
import lombok.Data;

/**
 * Student 实体
 * @author: Fatal
 * @date: 2018/11/28 0028 11:48
 */
@Data
public class Student {

    private String name;

    private Integer age;

    @DateTime(format = "yyyy-MM-dd HH:mm", message = "您输入的格式错误，正确的格式为：{format}")
    private String birthday;

}

5、validator

定义校验器类 DateTimeValidator 实现 ConstraintValidator 接口，实现接口后需要实现它里面的 initialize： 与 isValid： 方法。

方法介绍

initialize： 主要用于初始化，它可以获得当前注解的所有属性
isValid： 进行约束验证的主体方法，其中 value 就是验证参数的具体实例，context 代表约束执行的上下文环境。

这里的验证方式虽然简单，但职责明确；为空验证可以使用 @NotBlank、@NotNull、@NotEmpty 等注解来进行控制，而不是在一个注解中做各种各样的规则判断，应该职责分离

package com.fatal.validator;

import com.fatal.annotation.DateTime;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.text.ParseException;
import java.text.SimpleDateFormat;

/**
 * 自定义 @DateTime 验证器
 * ConstraintValidator<A, T>
 *     A: 要绑定校验器的注解
 *     T: 校验的类型
 * @author: Fatal
 * @date: 2018/11/28 0028 11:43
 */
public class DateTimeValidator implements ConstraintValidator<DateTime, String> {

    private DateTime dateTime;

    @Override
    public void initialize(DateTime dateTime) {
        this.dateTime = dateTime;
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 如果 value 为空则不进行格式验证，为空验证可以使用 @NotBlank @NotNull @NotEmpty 等注解来进行控制，职责分离
        if (value == null) {
            return true;
        }
        String format = dateTime.format();
        // 拦截长度不一致的
        if (value.length() != format.length()) {
            return false;
        }
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(format);
        try {
            simpleDateFormat.parse(value);
        } catch (ParseException e) {
            return false;
        }
        return true;
    }
}

6、controlller

package com.fatal.controller;

import com.fatal.entity.Student;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author: Fatal
 * @date: 2018/11/28 0028 11:38
 */
@RestController
public class ValidatorController {

    @GetMapping("/")
    public String validate(@Validated Student student, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            return bindingResult.getFieldError().getDefaultMessage();
        }

        return "success";
    }

}