Spring Boot 中自定义注解实现可选 int 值的校验

正文:

在实际的应用开发中,我们经常需要对接口的输入进行校验,以确保数据的合法性。在Spring Boot项目中,通过使用Hibernate Validator等校验框架,可以轻松地实现各种校验需求。本文将介绍如何自定义一个注解@InIntValues,并通过对应的校验器InIntValuesValidator来实现对输入是否为指定可选int值的校验。

1. 创建自定义可选int值校验注解

首先,我们创建一个自定义注解@InIntValues,用于标记需要进行可选int值校验的字段或参数。以下是注解的定义:

java 复制代码
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * 可选int值范围校验注解
 */
@Documented
@Constraint(validatedBy = InIntValuesValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface InIntValues {
    // 默认错误提示信息
    String message() default "必须是指定的int值之一";

    // 可选的int值数组
    int[] values();

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

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

2. 创建可选int值校验器

接下来,我们需要实现可选int值校验的逻辑。为此,创建一个InIntValuesValidator类,实现ConstraintValidator<InIntValues, Integer>接口:

java 复制代码
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;

/**
 * 可选int值范围校验器
 */
public class InIntValuesValidator implements ConstraintValidator<InIntValues, Integer> {

    private int[] allowedValues;

    @Override
    public void initialize(InIntValues constraintAnnotation) {
        this.allowedValues = constraintAnnotation.values();
    }

    /**
     * 校验方法
     * @param value 待校验的整数
     * @param context 校验上下文
     * @return 校验结果,true表示通过,false表示不通过
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        // 如果值为null,由 @NotNull 校验
        if (value == null) {
            return true;
        }
        // 判断值是否在可选的int值数组中
        return Arrays.stream(allowedValues).anyMatch(val -> val == value);
    }
}

在这个校验器中,我们使用@InIntValues注解的values()属性来指定可选的int值数组。在isValid方法中,我们使用Java 8的Stream API来判断被验证的值是否在这个可选的int值数组中。

3. 在实体类或DTO中应用注解

现在,你可以在需要进行可选int值校验的字段上应用@InIntValues注解:

java 复制代码
public class YourRequestDTO {
    
    @NotBlank(message = "姓名不能为空")
    @Chinese
    private String name;

    @InIntValues(values = {1, 2, 3}, message = "必须是指定的int值之一")
    private Integer selectedValue;

    // 其他字段...
}

在这个例子中,selectedValue字段通过@InIntValues注解进行了可选int值校验。当请求中的selectedValue字段不是指定的可选int值之一时,将触发校验错误,并返回指定的错误提示信息。

通过这样的自定义注解和校验器,你可以在Spring Boot项目中轻松实现对字段值是否为指定可选int值的校验,提高系统的数据质量和安全性。

相关推荐
码事漫谈2 小时前
以后人人都可以成为导演
后端
Resean02232 小时前
Spring 源码分析(二)配置类的解析与扫描
java·后端·spring
一只爱撸猫的程序猿2 小时前
五周、两个开源仓库、九次拦截之后:AI 时代程序员缺的到底是什么
人工智能·后端·开源
小毛球.2 小时前
第 3 篇:IDEA 最新版下载与完整安装教程(Mac)
java·macos·intellij-idea·idea
北城笑笑3 小时前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
Misnearch3 小时前
ScheduledExecutorService
java·线程池
ServBay4 小时前
Local harness 将退役,VS Code 本地开发要不要搬到云端?
后端·ai编程·visual studio code
ashiho4 小时前
【LeetCode hot 100】3. 无重复字符的最长子串 (三种解法)
java·数据结构·后端·算法·leetcode·滑动窗口
T_Wizard5 小时前
AI 回复为什么要转圈 3 秒才「啪」一下全出来?把流式输出拆开看,顺便踩了 6 个坑
java·ai编程
CoderYanger5 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第二弹)
java·数据库·面试·职场和发展·java-ee·tomcat·mybatis