springboot后端开发-自定义参数校验器

devtools/2024/12/22 23:34:26/

背景

在使用springboot进行后端开发的时候,经常会遇到数据校验的问题, 有时候可能默认的校验器不足以满足自己的需求, 这个时候就需要开发一个自己的校验器

在 Spring Boot 中自定义参数校验器通常涉及以下几个步骤:

1. 定义注解

首先需要定义一个自定义的注解,该注解将用于标记需要校验的字段。

java">import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;@Documented
// 实现真正校验逻辑的验证器
@Constraint(validatedBy = NotAllEmptyValidator.class)
// 注解放置于类上方
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotAllEmpty {String message() default "不允许所有参数为空";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};String[] fields default {};
}

在这个例子中,我们定义了一个名为 NotAllEmpty 的注解,并指定了它使用 NotAllEmptyValidator 类进行验证。同时定义了默认的错误消息。

2. 创建校验器

接下来需要创建一个实现 ConstraintValidator 接口的类来实现具体的校验逻辑。

java">import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Collection;public class NotAllEmptyValidator implements ConstraintValidator<NotAllEmpty, Object> {@Overridepublic void initialize(NotAllEmpty constraintAnnotation) {// 可以在这里初始化一些配置项}@Overridepublic boolean isValid(Object value, ConstraintValidatorContext context) {// 加入自己的验证逻辑return false;}
}

这个 NotAllEmptyValidator 类实现了 ConstraintValidator<NotAllEmpty, Object> 接口,其中 isValid 方法负责检查传入的集合是否为空。

3. 使用自定义注解

最后可以在需要校验的实体类或方法上使用这个自定义注解。

java">import javax.validation.constraints.NotNull;
import java.util.List;@NotAllEmpty(fields={"name", "age"})
public class MyEntity {private String name;private Integer age;// Getter and Setter
}

或者在控制器的方法参数上使用:

java">import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {@PostMapping("/save")public String save(@RequestBody @NotAllEmpty MyEntity reqBody) {// ...}
}

4. 配置 Bean Validation

确保 Spring Boot 应用已经启用了 Bean Validation,这通常是通过添加 spring-boot-starter-validation 依赖自动完成的。

如果使用 Maven,可以添加如下依赖:

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

如果使用 Gradle,则添加:

implementation 'org.springframework.boot:spring-boot-starter-validation'

以上就是如何在 Spring Boot 中创建和使用自定义参数校验器的基本流程。你可以根据自己的需求调整注解和校验器的具体实现细节。

5. 参考文档

Spring MVC Custom Validation
jboss相关章节


http://www.ppmy.cn/devtools/102340.html

相关文章

STM32嵌套向量中断控制器—NVIC

NVIC简介&#xff1a; NVIC&#xff0c;即Nested Vectored Interrupt Controller&#xff08;嵌套向量中断控制器&#xff09;&#xff0c;是STM32中的中断控制器。它负责管理和协调处理器的中断请求&#xff0c;是STM32中处理异步事件的重要机制。 NVIC提供了灵活、高效、可扩…

【Unity输入】Unity输入方式总结

在Unity中&#xff0c;常见的输入方式包括以下几种&#xff1a; 1. 键盘输入 Input.GetKey(): 用于检测特定键是否被按下。例如&#xff0c;用Input.GetKey(KeyCode.W)检测玩家是否按下“W”键来控制角色移动。Input.GetKeyDown(): 用于检测某个键在当前帧是否被按下。Input.…

深度学习100问3-什么是共现矩阵及其作用

一、看词和词的关系 共现矩阵就像一个表格&#xff0c;能让我们清楚地看到不同的词在一些文本里出现的关联情况。要是两个词经常一起出现&#xff0c;那在这个矩阵里对应的地方数字就会比较大&#xff0c;说明这两个词关系很紧密。比如在科技文章里&#xff0c;“人工智能”和“…

202. 快乐数【 力扣(LeetCode) 】

一、题目描述 编写一个算法来判断一个数 n 是不是快乐数。 「快乐数」 定义为&#xff1a; 对于一个正整数&#xff0c;每一次将该数替换为它每个位置上的数字的平方和。然后重复这个过程直到这个数变为 1&#xff0c;也可能是 无限循环 但始终变不到 1。如果这个过程 结果为…

IOS半越狱工具nathanlr越狱教程

简介 nathanlr 是一款半越狱工具&#xff0c;不是完整越狱。 半越狱只能使用一些系统范围的插件。 无法做到完整越狱 Dopamine 越狱一样插件兼容性。 nathanlr支持 iOS 16.5.1 – 16.6.1 系统。 支持 A12 及以上设备。 肯定有人问&#xff0c;为什么仅仅支持这些系统&#xff…

重构多重children数据 减少数据

为了将给定的数据结构从使用 key 和 title 转换为使用 value 和 label&#xff0c;并且确保子节点&#xff08;如果有的话&#xff09;也遵循相同的结构&#xff0c;你可以使用JavaScript的map方法来遍历数组并重构每个对象。这里是如何做的&#xff1a; const originalData …

读书学习笔记 # Datawhale X 李宏毅苹果书 AI夏令营

文章目录 &#x1f6a9;学习目标&#x1f6a9;学习内容&#x1f6a9; Task1.1&#x1f3af;为什么优化会失败&#x1f4cc;因非信息梯度导致的失败 &#x1f3af;局部极小值与鞍点&#x1f3af;临界点及其种类&#x1f3af;如何判断临界值种类&#x1f4cc;更简便的方法来判断 …

Kubernetes集群外如何访问Pod?

Kubernetes集群外如何访问Pod? 1、如何使用?2、注意事项💖The Begin💖点点关注,收藏不迷路💖 在Kubernetes中,要让集群外的流量访问Pod,可以使用NodePort类型的Service。 NodePort为Service分配一个在所有节点上监听的端口,外部流量通过访问任意节点的这个端口即可…