浅谈自定义校验注解ConstraintValidator

一、前言

系统执行业务逻辑之前，会对输入数据进行校验，检测数据是否有效合法的。所以我们可能会写大量的if else等判断逻辑，特别是在不同方法出现相同的数据时，校验的逻辑代码会反复出现，导致代码冗余，阅读性和可维护性极差。

jsr-303是java为bean数据合法性校验提供的标准框架，它定义了一整套校验注解，可以标注在成员变量，属性方法等之上。

hibernate-validator就提供了这套标准的实现，我们在用springboot开发web应用时，会引入spring-boot-starter-web依赖，它默认会引入spring-boot-starter-validation依赖，而spring-boot-starter-validation中就引用了hibernate-validator依赖。

但是，在比较高版本的spring-boot-starter-web中，默认不再引用spring-boot-starter-validation，自然也就不会默认引入到hibernate-validator依赖，需要我们手动添加依赖。

<dependency>

<groupid>org.hibernate.validator</groupid>

<artifactid>hibernate-validator</artifactid>

<version>6.1.7.final</version>

</dependency>

hibernate-validator中有很多非常简单好用的校验注解，例如notnull，@notempty，@min，@max，@email，@positiveorzero等等。这些注解能解决我们大部分的数据校验问题。如下所示：

package com.nobody.dto;

import lombok.data;

import javax.validation.constraints.*;

@data

public class userdto {

@notblank(message = "姓名不能为空")

private string name;

@min(value = 18, message = "年龄不能小于18")

private int age;

@notempty(message = "邮箱不能为空")

@email(message = "邮箱格式不正确")

private string email;

}

二、自定义参数校验器

但是，hibernate-validator中的这些注解不一定能满足我们全部的需求，我们想校验的逻辑比这复杂。所以，我们可以自定义自己的参数校验器。

首先引入依赖是必不可少的。

<dependency>

<groupid>org.hibernate.validator</groupid>

<artifactid>hibernate-validator</artifactid>

<version>6.1.7.final</version>

</dependency>

最近不是基金很火吗，一大批的韭菜疯狂地涌入买基金的浪潮中。我就以用户开户为例，首先要校验此用户是不是成年人（即不能小于18岁），以及名字是不是以"新韭菜"开头的，符合条件的才允许开户。

定义一个注解，用于校验用户的姓名是不是以“新韭菜”开头的。

package com.nobody.annotation;

import com.nobody.validator.isleekvalidator;

import javax.validation.constraint;

import javax.validation.payload;

import java.lang.annotation.*;

@retention(retentionpolicy.runtime)

@target(elementtype.field)

@documented

@constraint(validatedby = isleekvalidator.class) // 指定我们自定义的校验类

public @interface isleek {

/**

* 是否强制校验

*

* @return 是否强制校验的boolean值

*/

boolean required() default true;

/**

* 校验不通过时的报错信息

*

* @return 校验不通过时的报错信息

*/

string message() default "此用户不是韭零后，无法开户！";

/**

* 将validator进行分类，不同的类group中会执行不同的validator操作

*

* @return validator的分类类型

*/

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

/**

* 主要是针对bean，很少使用

*

* @return 负载

*/

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

}

定义校验类，实现constraintvalidator接口，接口使用了泛型，需要指定两个参数，第一个是自定义注解，第二个是需要校验的数据类型。重写2个方法，initialize方法主要做一些初始化操作，它的参数是我们使用到的注解，可以获取到运行时的注解信息。isvalid方法就是要实现的校验逻辑，被注解的对象会传入此方法中。