0

0

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

花韻仙語

花韻仙語

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

|

907人浏览过

|

来源于php中文网

原创

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

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

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

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

✅ 核心思路

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

Red Panda AI
Red Panda AI

AI文本生成图像

下载

✅ 示例实现(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 可能需排除审计字段)。

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

相关专题

更多
spring框架介绍
spring框架介绍

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

98

2025.08.06

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

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

135

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应用程序等。

384

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

61

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

11

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

101

2025.12.24

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

989

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

50

2025.10.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共101课时 | 8.1万人学习

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

共39课时 | 3.1万人学习

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

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号