Spring Boot 中参数校验规范怎么在团队制定

胖萱小哥_1935

胖萱小哥_1935

2026-11-03

723人浏览

原创

Spring Boot参数校验规范强调可执行的一致性约定,明确“谁来校验、在哪校验、怎么写、怎么错、怎么改”五要素;强制HTTP接口入参后端校验,统一注解使用与错误提示,配套全局异常处理与文档同步机制,并支持分组校验和豁免流程。

spring boot 中参数校验规范怎么在团队制定

团队制定 Spring Boot 参数校验规范,核心不是堆砌技术细节,而是建立可执行、易理解、能落地的一致性约定。重点在于统一“谁来校验、在哪校验、怎么写、怎么错、怎么改”这五个问题。

明确校验边界与责任分工

避免“校验该不该做”的争论,直接定义强制规则:

  • 所有对外暴露的 HTTP 接口(@RestController),必须对入参进行后端校验;前端校验仅作为体验优化,不作为安全依赖
  • 校验逻辑只放在 Controller 层或 DTO 层,禁止在 Service 或 Mapper 层重复写 if-else 校验
  • DTO 类是唯一允许添加校验注解的位置,实体类(Entity)、VO、Query 对象也按此标准执行
  • 路径参数(@PathVariable)、查询参数(@RequestParam)、请求体(@RequestBody)全部纳入校验范围,不因参数形式不同而降低要求

统一注解使用标准

减少随意性,让代码一眼可读:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
  • 非空判断优先用 @NotBlank(String)和 @NotNull(数字/对象),不用 @NotEmpty(语义模糊,易误用)
  • 长度/数量限制统一用 @Size(覆盖 String、List、Map),不用组合多个 @Min/@Max
  • 密码、手机号、邮箱等格式校验,必须用 @Pattern 或 @Email,禁用自定义正则字符串硬编码在 message 中
  • 每个注解必须带 中文 message,且句式统一:“{字段名} {规则说明}”,例如 “用户名不能为空”“订单ID必须大于0”

强制配套机制落地

光有注解不够,必须闭环:

  • Controller 类顶部统一加 @Validated,确保路径/查询参数校验生效
  • 所有 @RequestBody 参数必须加 @Valid,不加则 CI 构建失败(可通过 Checkstyle 或自定义 Maven 插件拦截)
  • 全局异常处理器必须捕获 MethodArgumentNotValidException 和 BindException,返回标准错误结构:code=400、message=具体字段错误、data={“field”:“username”,“reason”:“用户名不能为空”}
  • 新增或修改 DTO 时,必须同步更新对应接口的 OpenAPI 文档(如 Swagger 注解或 OpenAPI 3.0 YAML),校验规则需在文档中可查

支持演进与例外管理

留出合理弹性,防止规范僵化:

  • 复杂跨字段校验(如“结束时间不能早于开始时间”)用 @Validated + 分组接口,定义 CreateCheck / UpdateCheck 等分组,并在 Controller 方法中显式指定
  • 高频调用接口若实测校验成为瓶颈,可申请豁免部分非关键字段,但需在代码中标注 @SuppressWarnings("unused-validation") 并附 Jira 链接说明原因
  • 团队共享一个 validation-starter 模块,封装通用注解(如 @ChineseMobile、@StrongPassword)、默认消息模板、以及适配公司日志体系的异常上报逻辑

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11817

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8902

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7632

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1264

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1008

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1496

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3089

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20351

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1355

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习