如何为生成的 ID 字段实现静态校验(禁止客户端传入)

千丽吖_3453

千丽吖_3453

2026-07-11

345人浏览

原创

通过自定义注解 + Hibernate Validator 实现 DTO 中只读 ID 字段的静态校验,确保 POST/PUT 请求中显式传入 id 时立即返回 400 错误,避免后续抛出 500 异常。

通过自定义注解 + hibernate validator 实现 dto 中只读 id 字段的静态校验,确保 post/put 请求中显式传入 `id` 时立即返回 400 错误,避免后续抛出 500 异常。

在 REST API 开发中,id 字段通常由服务端生成(如数据库自增、UUID 或 Snowflake),客户端不应也不允许提供该值。若客户端在 POST/PUT 请求中携带 id,理想行为是在数据绑定与校验阶段即拦截并返回 400 Bad Request,而非等到持久化时因 Detached Entity 等问题抛出 500 Internal Server Error。

直接使用 @Null 是最简洁、标准且零侵入的解决方案——它属于 Jakarta Bean Validation 规范,无需额外逻辑即可实现“禁止非 null 值”的静态校验:

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class SampleApiDto {

    @Null(message = "id must not be provided in request payload")
    private Long id; // 注意:使用包装类型 Long,而非基本类型 long(否则无法为 null)

    private String description;
    private String columnName;
    private String code;
}

✅ 关键要点说明:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
  • 必须将 private long id 改为 private Long id:基本类型 long 默认值为 0,无法为 null,导致 @Null 永远校验失败(或被忽略);而 Long 可为 null,且 JSON 反序列化时若字段缺失或为 null,将正确设为 null。
  • @Null 在 @Valid 触发时自动生效(如 Spring MVC 中控制器参数标注 @Valid):
    @PostMapping
    public ResponseEntity> create(@Valid @RequestBody SampleApiDto dto) { ... }
  • 校验失败时,Spring Boot 自动返回 400 Bad Request 及标准化错误体(含 message),符合 REST 最佳实践。

⚠️ 不推荐方案辨析:

  • @JsonIgnore(或 @JsonIgnoreProperties)仅影响 JSON 序列化/反序列化,不参与校验,且会彻底丢失 id 字段值,违背“ID 需在 DTO 中后续被数据层使用”的需求。
  • 单独创建 InputDTO(如 SampleCreateRequest)虽更严格分层,但需额外类与映射逻辑,在已有 DTO 广泛复用的大型项目中,增加维护成本;而 @Null 方案零侵入、零重构、语义清晰,是更优解。
  • 自定义注解(如 @ReadOnlyId)虽可行,但过度设计:@Null 已精确表达“该字段不允许客户端设置”的业务语义,无需重复造轮子。

? 进阶建议(可选):
若需区分 POST(禁止 id)与 PUT(允许 id,但仅限路径参数或特定场景),可结合 @GroupSequence 或 @Validated 分组校验,但对本例而言,统一禁止客户端传 id 是更安全、更易维护的设计。

综上,将 id 改为 Long 并添加 @Null 注解,是最轻量、最规范、最易落地的静态校验方案。

相关文章

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

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

下载

相关标签:

spring mvc spring boot

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

相关专题

更多
java
java

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

2023.06.15

10237

6

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

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

2023.07.05

7362

9

java自学难吗
java自学难吗

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

2023.07.31

6472

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习