项目开发中会经常使用到各种枚举值,枚举值一般都是固定的,不会随意改变其中的值。

比如性别分为男女,确定之后一般都不会轻易改变,这时候使用枚举值就非常地方便。很多

时候,在页面中传入的参数就是枚举值中的一个,比如性别,或者是星期,月份,以及自定义

的各种类型等等。如果是手动校验就非常麻烦,假如有50个枚举值,不可能每一个枚举值都

进行手动校验,那这时候如何更好的校验呢?答案很简单,使用自定义的校验注解即可。

先上代码,然后在慢慢地讲解。自定义的校验注解如下:

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR,ElementType.PARAMETER})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Constraint(validatedBy = {EnumValidateValidator.class})

public @interface EnumValidate {

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

String enumMethod() default "isValid";

String message() default "必须传入枚举类型的class";

boolean nullAble() default false;

//分组

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

// 负载

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

// 指定多个时使用

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR,ElementType.PARAMETER})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface List {

EnumValidate [] value();

}

}

自定义校验注解验证器如下:

public class EnumValidateValidator implements ConstraintValidator<EnumValidate, Object> {

private Class<? extends Enum<?>> enumClass;

private String enumMethod;

private boolean nullAble;

@Override

public void initialize(EnumValidate constraintAnnotation) {

enumClass = constraintAnnotation.enumClass();

enumMethod = constraintAnnotation.enumMethod();

nullAble = constraintAnnotation.nullAble();

}

@Override

public boolean isValid(Object value, ConstraintValidatorContext context) {

if (value == null) {

return nullAble;

}

try {

Object[] enumConstants = enumClass.getEnumConstants();

Method method = enumClass.getMethod(enumMethod, value.getClass());

Object result = method.invoke(enumConstants[0], value);

System.out.println("invoke--->" + result);

return (Boolean)result;

} catch (Exception ex) {

ex.printStackTrace();

throw new RuntimeException("枚举类型验证错误");

}

}

}

自定义的测试枚举如下:

public enum  TestEnum {

TYPE_ONE("ONE", "成功"),

TYPE_TWO("TYPE_TWO", "失败"),

;

/*

* 编码

*/

private String code;

/*

* 信息

*/

private String msg;

public String getCode() {

return code;

}

TestEnum(String code, String msg) {

this.code = code;

this.msg = msg;

}

/* @Description: 枚举里面的自定义校验方法

* @author: yilang

* @date: 2022/12/6 20:53

* @param: value

* @return: boolean

*/

public boolean isValid(String value) {

for(TestEnum testEnum : TestEnum.values()) {

if (testEnum.getCode().equals(value)) {

return true;

}

}

return false;

}

}

测试入参如下:

@Data

public class ParamTest {

/*

* 名称

*/

@NotNull(message = "名称不能为null")

private String name;

/*

* 简介

*/

@Length(max = 10, message = "简介长度最大为10")

private String abs;

@EnumValidate(enumClass = TestEnum.class, nullAble = false, message = "传入的枚举类型参数错误")

private String enumTest;

}

Controller中的测试方法如下:

@Slf4j

@RestController

@RequestMapping("/happy/yilang")

public class TestControlelr {

@PostMapping("/enum")

public String enumTest(@Valid @RequestBody ParamTest paramTest){

return "枚举类型统计";

}

}

自定义注解中主要有几个自定参数,

// 限定传入的class为枚举类型

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

// 指定传入的需要调用的枚举类的检验方法

String enumMethod() default "isValid";

// 错误提示信息

String message() default "必须传入枚举类型的class";

// 待校验的参数是否允许为null

boolean nullAble() default false;

//分组-自定义注解最好加上

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

// 负载-自定义注解必加参数,否则报错

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

自定义注解校验器EnumValidateValidator 需要实现接口ConstraintValidator,然后重写里面的校验方法。

// 返回枚举类的元素 enumClass是通过注解拿到的,然后初始化的时候赋值给成员变量

Object[] enumConstants = enumClass.getEnumConstants();

// 获取需要执行的方法 enumMethod是通过注解拿到的,然后初始化的时候赋值给成员变量

//  value.getClass() 可以获取到原始传入数据的类型

Method method = enumClass.getMethod(enumMethod, value.getClass());

// 使用反射的方式执行方法,传入枚举变量和参数 程序底层会调用注解中获取到的需要执行的校验方法,默认为isValid,可以任意修改

Object result = method.invoke(enumConstants[0],  value);

// 自定义枚举类中isValid 方法返回的值是一个Object类型,可以转换为布尔类型

return (Boolean)result;

自定义枚举类中, isValid是自定义方法,名称可以随便取。 TestEnum.values()是每一个枚举类中都自带的方法,可以获取当前枚举的所有值。

public boolean isValid(String value) {

for(TestEnum testEnum : TestEnum.values()) {

if (testEnum.getCode().equals(value)) {

return true;

}

}

return false;

}

Controller中的方法和参数中使用注解的方式都很常规,不在赘述。

测试结果如下,通过校验的测试

未通过校验的测试

参考文章:

https://blog.csdn.net/h2604396739/article/details/83825148

Java自定义注解校验枚举值类型参数的更多相关文章

  1. Java自定义注解源码+原理解释(使用Java自定义注解校验bean传入参数合法性)

    Java自定义注解源码+原理解释(使用Java自定义注解校验bean传入参数合法性) 前言:由于前段时间忙于写接口,在接口中需要做很多的参数校验,本着简洁.高效的原则,便写了这个小工具供自己使用(内容 ...

  2. Java 自定义注解 校验指定字段对应数据库内容重复

    一.前言 在项目中,某些情景下我们需要验证编码是否重复,账号是否重复,身份证号是否重复等... 而像验证这类代码如下: 那么有没有办法可以解决这类似的重复代码量呢? 我们可以通过自定义注解校验的方式去 ...

  3. java自定义注解实现前后台参数校验

    2016.07.26 qq:992591601,欢迎交流 首先介绍些基本概念: Annotations(also known as metadata)provide a formalized way ...

  4. java自定义注解知识实例及SSH框架下,拦截器中无法获得java注解属性值的问题

    一.java自定义注解相关知识 注解这东西是java语言本身就带有的功能特点,于struts,hibernate,spring这三个框架无关.使用得当特别方便.基于注解的xml文件配置方式也受到人们的 ...

  5. Java自定义注解和运行时靠反射获取注解

    转载:http://blog.csdn.net/bao19901210/article/details/17201173/ java自定义注解 Java注解是附加在代码中的一些元信息,用于一些工具在编 ...

  6. java自定义注解类

    一.前言 今天阅读帆哥代码的时候,看到了之前没有见过的新东西, 比如java自定义注解类,如何获取注解,如何反射内部类,this$0是什么意思? 于是乎,学习并整理了一下. 二.代码示例 import ...

  7. java自定义注解注解方法、类、属性等等【转】

    http://anole1982.iteye.com/blog/1450421 http://www.open-open.com/doc/view/51fe76de67214563b20b385320 ...

  8. JAVA自定义注解 ------ Annotation

    日常开发工作中,合理的使用注解,可以简化代码编写以及使代码结构更加简单,下面记录下,JAVA自定义注解的开发过程. 定义注解声明类. 编写注解处理器(主要起作用部分). 使用注解. 相关知识点介绍, ...

  9. Java自定义注解的实现

    Java自定义注解的实现,总共三步(eg.@RandomlyThrowsException): 1.首先编写一个自定义注解@RandomlyThrowsException package com.gi ...

  10. java 自定义注解以及获得注解的值

    1.自定义注解 import java.lang.annotation.*; @Documented @Target(ElementType.FIELD) @Inherited @Retention( ...

随机推荐

  1. C# - 将HTML网页、HTML字符串转换为PDF

    将HTML转换为PDF可实现格式保留.可靠打印.文档归档等多种用途,满足不同领域和情境下的需求.本文将通过以下两个示例,演示如何使用第三方库Spire.PDF for .NET和QT插件在C# 中将H ...

  2. 在Windows下编译Saba

      今天写一篇环境配置的博客,感觉这种博客比较好写   Saba是一个用于加载MMD(MikuMikuDance)模型.动作文件的C++库.下面我们在Windows下编译这个库.为了在Windows下 ...

  3. 我自创的 Response泛型 返回类,全自动 推断,非常方便使用。

    package com.diandaxia.common.utils; import java.util.Date; /** * by liyuxin 2019.12.16 更新 * 统一返回格式 * ...

  4. TPopupMenu 替换 自身自动的 热键

    有时候自动生成的热键 并不是 很理想 这个时候 需要 用自己认为好的 方法如下图,加个(&热键)

  5. Teams基础功能与会议介绍

    目录 Teams基本功能介绍 活动 聊天 如何查找联系人 如何开启语音或视频通话 如何共享自己的屏幕 如何新建群聊 发送文件的多种方式 快速安排一个会议 重要与紧急的消息 文件 分享的文件 OneDr ...

  6. NC53079 Forsaken喜欢数论

    题目链接 题目 题目描述 ​ Forsaken有一个有趣的数论函数.对于任意一个数 \(x\) , \(f(x)\) 会返回 \(x\) 的最小质因子.如果这个数没有最小质因子,那么就返回0. ​ 现 ...

  7. 【Unity3D】地形Terrain

    1 前言 ​ Terrain 是 Unity3D 提供的用于绘制地形的游戏对象,可以在其上绘制山地.江海.池塘.草树等. ​ 用户可以通过[GameObject → 3D Object → Terra ...

  8. 【Android】使用Exoplayer播放视频

    1 前言 ​ ExoPlayer 是 google 开源的应用级媒体播放器,github源码 → https://github.com/google/ExoPlayer.相较于 MediaPlayer ...

  9. SpringBoot+Shiro+LayUI权限管理系统项目-6.实现角色管理

    1.说明 只讲解关键部分,详细看源码,文章下方捐赠或QQ联系捐赠获取. 2.功能展示 3.业务模型 @Data @EqualsAndHashCode(callSuper = false) @Acces ...

  10. Java并发编程实例--16.使用ReentrantLock实现线程同步

    Java提供另一机制去同步代码块.它比synchronized关键字更强大且易用. 它是基于Lock接口和其实现类例如:ReentrantLock. 这一机制对比synchronized关键字的优势在 ...