讲师中心 微信公众号
AI工具推荐 视频效率加速

如何统一忽略 Spring Boot API 响应中的审计字段

陌静君_8443

陌静君_8443

发布时间:2025-12-31 15:48:40

|

947人浏览过

|

来源于php中文网

原创

如何统一忽略 Spring Boot API 响应中的审计字段

本文介绍一种无需在每个实体类中重复添加 @jsonignore 的通用方案:通过抽象基类集中管理审计字段并自动屏蔽其序列化,兼顾可维护性与代码简洁性。

在 Spring Boot 项目中,启用 JPA 审计(如 @CreatedBy、@CreatedDate)后,审计字段会自动填充数据库,但常因安全或接口规范要求,禁止将其暴露在 REST API 响应中。若为每个实体手动添加 @JsonIgnore 或 @JsonIgnoreProperties,不仅冗余,还易遗漏、难维护——尤其当实体数量庞大时。

推荐采用 “统一抽象基类 + 注解驱动” 的方式实现全局屏蔽:

JS X Monitor
JS X Monitor

X.com (Twitter) 账号监控自动化:定时抓取指定账号最新推文,发现新内容即时推送通知。

下载

✅ 核心思路

定义一个 @MappedSuperclass 抽象类(如 AuditedEntity),集中声明所有审计字段,并统一应用 @JsonIgnore;其余业务实体继承该类,即可自动继承审计能力与序列化屏蔽逻辑,零配置、零重复。

✅ 示例实现(Kotlin)

@MappedSuperclass
@EntityListeners(AuditingEntityListener::class)
abstract class AuditedEntity : Serializable {
    companion object {
        private const val serialVersionUID = 8723456789012345678L
    }

    @Column(name = "created_at", updatable = false)
    @CreationTimestamp
    @JsonIgnore
    var createdAt: LocalDateTime? = null

    @Column(name = "created_by", updatable = false, length = 64)
    @CreatedBy
    @JsonIgnore
    var createdBy: String? = null

    @Column(name = "updated_at")
    @UpdateTimestamp
    @JsonIgnore
    var updatedAt: LocalDateTime? = null

    @Column(name = "updated_by", length = 64)
    @LastModifiedBy
    @JsonIgnore
    var updatedBy: String? = null

    // 可选:提供格式化时间字符串(已自动忽略,仅用于内部逻辑)
    val createdAtFormatted: String
        get() = createdAt?.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) ?: ""

    val updatedAtFormatted: String
        get() = updatedAt?.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) ?: ""
}

✅ 业务实体只需继承即可

@Entity
@Table(name = "users")
data class User(
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    var id: Long? = null,

    @Column(name = "username", nullable = false, unique = true)
    var username: String = "",

    @Column(name = "email")
    var email: String? = null
) : AuditedEntity() // ← 自动拥有审计字段 & 自动 JSON 屏蔽

⚠️ 注意事项

  • 确保已启用 JPA 审计:在主启动类添加 @EnableJpaAuditing;
  • @JsonIgnore 作用于字段级,需配合 Jackson 序列化器(Spring Boot 默认已集成);
  • 若需在特定接口中临时启用审计字段(如后台管理 API),可使用 @JsonInclude(JsonInclude.Include.NON_NULL) 配合 DTO 手动映射,避免污染领域模型;
  • 时间类型建议统一使用 LocalDateTime(推荐)或 Instant,避免 Date 的时区歧义;
  • 如需兼容 Lombok,可在基类上添加 @Data(注意 @EqualsAndHashCode 可能需排除审计字段)。

该方案将横切关注点(审计 + 序列化控制)收敛到单一抽象层,大幅提升代码一致性与可维护性,是大型项目中处理通用元数据字段的推荐实践。

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

371

2026.02.12

Java Kotlin协程与异步编程实战
Java Kotlin协程与异步编程实战

本专题围绕 Kotlin 协程与异步编程展开,讲解挂起函数、协程作用域、异步任务调度及并发控制方法。通过实际项目案例,帮助开发者提升后端服务性能,实现高效异步任务处理与稳定性保障。

179

2026.04.13

Kotlin Android开发教程大全
Kotlin Android开发教程大全

系统讲解 Google 官方推荐的 Android 开发首选语言 Kotlin 的核心知识与工程实践,涵盖 Kotlin 简洁语法(空安全/数据类/扩展函数/解构声明/作用域函数)与 Java 互操作、集合操作与函数式编程、协程(Coroutines)异步编程(suspend/launch/async/Flow)、Jetpack Compose 声明式 UI 开发(状态管理/组合函数/导航/动画)、MVVM / MVI 架构设计与 Vi

268

2026.06.03

spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2671

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

497

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

651

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

5146

2025.08.19

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn