springboot validator枚举值校验功能实现

springboot validator枚举值校验功能实现枚举值校验功能实现

主要介绍了springboot validator枚举值校验功能实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需

要的朋友可以参考下

这篇文章主要介绍了springboot validator枚举值校验功能实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋

友可以参考下

一、前言一、前言

在spring项目中，校验参数功能使用hibernate validator是一个不错的选择，我们的项目中也是使用它来进行校验的，省去了很多难看的校验逻辑，使代码的可

读性也大大增加，本章将带你使用hibernate validator自定义注解功能实现一个 枚举值校验的逻辑。

上面提到的一组常量值，我们第一反应应该是定义一个枚举类，尽量不要放在一个统一的constants类下，这样当系统一旦庞大起来，常量是很难维护和查找

的，所以前期代码也应该有一些规范性约束，这里我们约定一组常量值时使用枚举，并把该枚举类放在对应的类对象里（以上述所说的用户功能为例，我们应

该把GenerEnum、UserStatusEnum枚举放在User.java下，方便查找）

这里我们定义一个叫EnumValue.java的注解类，其下有两个主要参数一个是enumClass用于指定枚举类，enumMethod指定要校验的方法，下面我们看代码实

现。

四、代码实现四、代码实现

package com.zhuma.demo.annotation;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import javax.validation.ConstraintValidator;

import javax.validation.ConstraintValidatorContext;

import javax.validation.Payload;

import org.assertj.core.util.Strings;

/**

* @desc 校验枚举值有效性

*

* @author zhumaer

String message() default "{custom.value.invalid}";

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

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

Class<? extends Enum<?>> enumClass();

String enumMethod();

@Override

public void initialize(EnumValue enumValue) {

enumMethod = enumValue.enumMethod();

enumClass = enumValue.enumClass();

}

@Override

public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {

if (value == null) {

return Boolean.TRUE;

Class<?> valueClass = value.getClass();

try {

Method method = enumClass.getMethod(enumMethod, valueClass);

if (!Boolean.TYPE.equals(method.getReturnType()) && !Boolean.class.equals(method.getReturnType())) {

throw new RuntimeException(Strings.formatIfArgs("%s method return is not boolean type in the %s class", enumMethod, enumClass));