SpringBoot自定义注解验证枚举的实现

 更新时间:2024年01月21日 09:20:24   作者:shier_chen  
本文主要介绍了SpringBoot自定义注解验证枚举的实现,数据校验,需要对枚举类型的数据传参,进行数据校验,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

业务场景:数据校验,需要对枚举类型的数据传参,进行数据校验,不能随便传参。

1、引入依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、创建注解类

package com.shier.valid;

import com.shier.validator.EnumValueValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @author cys
 */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {EnumValueValidator.class})
public @interface EnumValue {
    // 默认错误消息
    String message() default "必须为指定值";

    // 字符串类型
    String[] strValues() default {};

    // 整型
    int[] intValues() default {};

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

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

    // 忽略null, 为true时,参数传null不检验
    boolean ignoreNull() default false;

    ;


    // 指定多个时使用
    @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @interface List {
        EnumValue[] value();
    }
}

3、创建自定义检验器类

package com.shier.validator;

import com.shier.valid.EnumValue;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Objects;

/**
 * @author cys
 */
public class EnumValueValidator implements ConstraintValidator<EnumValue, Object> {

    private String[] strValues;

    private int[] intValues;

    private boolean ignoreNull;

    @Override
    public void initialize(EnumValue constraintAnnotation) {
        this.strValues = constraintAnnotation.strValues();
        this.intValues = constraintAnnotation.intValues();
        this.ignoreNull = constraintAnnotation.ignoreNull();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        if (Objects.isNull(value) && this.ignoreNull) {
            return true;
        }
        if (value instanceof String) {
            for (String s : strValues) {
                if (s.equals(value)) {
                    return true;
                }
            }
        } else if (value instanceof Integer) {
            for (Integer s : intValues) {
                if (s == value) {
                    return true;
                }
            }
        }
        return false;
    }
}

4、创建请求类

package com.shier.controller;


import com.fasterxml.jackson.annotation.JsonFormat;
import com.shier.valid.EnumValue;
import lombok.Data;

import java.time.LocalDateTime;
import java.util.Date;

/**
 * @author shier
 * @date 2023年01月12日
 */
@Data
public class OrderReq {

    private Long orderId;

    @EnumValue(intValues = {1,2,3,4}, message = "订单状态必须为指定值,1-新建 2-已支付 3-已完成 4-已取消",ignoreNull = true)
    private Integer orderStatus;

    /**
     * JsonFormat: 可以把日期类型转成指定格式输出
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

    private Date updateTime;
}

5、测试类

package com.shier.controller;

import com.shier.req.OrderReq;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;
import java.time.LocalDateTime;
import java.util.Date;

/**
 * @author shier
 * @date 2023年01月12日
 */
@RestController
public class TestController {

    @GetMapping("/test")
    public OrderReq test(@RequestBody @Valid OrderReq orderReq) {
        orderReq.setCreateTime(LocalDateTime.now());
        orderReq.setUpdateTime(new Date());
        return orderReq;
    }
}

6、启动测试

在这里插入图片描述

在这里插入图片描述

因为在OrderReq类中的orderStatus字段添加了注解规定值在1、2、3、4。如果传入其他值会提示异样, 这里因为没有统一异常处理, 才会没有提示自定义的信息

到此这篇关于SpringBoot自定义注解验证枚举的实现的文章就介绍到这了,更多相关SpringBoot自定义注解验证枚举内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring AOP基本概念

    Spring AOP基本概念

    这篇文章主要为大家详细介绍了spring基础概念AOP与动态代理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能给你带来帮助
    2021-07-07
  • Java多线程下解决资源竞争的7种方法详解

    Java多线程下解决资源竞争的7种方法详解

    这篇文章主要介绍了Java多线程下解决资源竞争的7种方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • java实现扑克牌分发功能

    java实现扑克牌分发功能

    这篇文章主要为大家详细介绍了java实现扑克牌分发,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • Maven dependencyManagement元素标签的具体使用

    Maven dependencyManagement元素标签的具体使用

    在Maven中dependencyManagement的作用其实相当于一个对所依赖jar包进行版本管理的管理器,本文主要介绍了Maven dependencyManagement元素标签的具体使用,感兴趣的可以了解一下
    2024-03-03
  • Java实现上传网络图片到七牛云存储详解

    Java实现上传网络图片到七牛云存储详解

    这篇文章主要为大家详细介绍了Java如何实现上传网络图片到七牛云存储,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起学习一下
    2022-12-12
  • Springboot集成CSRF防攻击过程

    Springboot集成CSRF防攻击过程

    本文介绍了Springboot集成CSRF防攻击的方法,通过设置域名或路径白名单来过滤未知链接,从而达到防护目的,主要涉及两个类:CSRFFilterConfigUtils防护配置工具类和CsrfFilter防护过滤类
    2025-11-11
  • Java实现List去重的五种方法详解

    Java实现List去重的五种方法详解

    这篇文章主要为大家详细介绍了Java中List去重的5种方法,文中的示例代码讲解详细,具有一定的学习和参考价值,需要的小伙伴可以了解一下
    2022-10-10
  • SpringBoot集成Redis实现订单超时管理的详细步骤

    SpringBoot集成Redis实现订单超时管理的详细步骤

    文章描述了如何使用Redis来处理超时支付订单,包括引入依赖、配置连接、定义实体类、实现服务和监听器等步骤,文章讨论了优化方案、注意事项以及Redis的性能和可靠性问题,感兴趣的朋友跟随小编一起看看吧
    2026-03-03
  • Java数据结构之有向图的拓扑排序详解

    Java数据结构之有向图的拓扑排序详解

    这篇文章主要为大家详细介绍了Java数据结构中有向图的拓扑排序,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以了解一下
    2022-11-11
  • MybatisPlus的LambdaQueryWrapper用法详解

    MybatisPlus的LambdaQueryWrapper用法详解

    LambdaQueryWrapper<Tag> 是 MyBatis-Plus 框架中的一个功能强大的查询构造器,它用于构建 SQL 查询条件,具有一定的参考价值,感兴趣的可以了解一下
    2024-10-10

最新评论