0

0

Spring Boot 中统一忽略 JPA 审计字段的优雅方案

心靈之曲

心靈之曲

发布时间:2025-12-31 14:20:38

|

209人浏览过

|

来源于php中文网

原创

Spring Boot 中统一忽略 JPA 审计字段的优雅方案

通过抽象基类 + `@jsonignore` 统一屏蔽 `createdby`、`createddate` 等审计字段,避免在每个实体中重复添加注解,实现零侵入、可复用的 api 响应净化。

在 Spring Boot 项目中启用 JPA Auditing(如 @CreatedBy、@CreatedDate)后,审计字段会自动写入数据库,但默认也会被 Jackson 序列化到 REST API 响应中——这往往不符合前端需求,既暴露了内部结构,又增加了无效数据传输。若为数十个实体逐一添加 @JsonIgnore 或 @JsonIgnoreProperties,不仅冗余,还违背 DRY 原则。

推荐方案:基于 @MappedSuperclass 的统一审计基类

定义一个抽象父类(如 AuditableEntity),集中声明所有审计字段,并直接应用 @JsonIgnore,让所有业务实体继承它。这样只需一处配置,全局生效:

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

    @Column(updatable = false)
    @CreatedDate
    @JsonIgnore
    var createdAt: LocalDateTime? = null

    @Column(updatable = false)
    @CreatedBy
    @JsonIgnore
    var createdBy: String? = null

    @Column
    @LastModifiedDate
    @JsonIgnore
    var updatedAt: LocalDateTime? = null

    @Column
    @LastModifiedBy
    @JsonIgnore
    var updatedBy: String? = null

    // 可选:提供格式化后的只读属性(不参与持久化)
    val createdAtStr: String
        get() = createdAt?.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) ?: ""

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

使用方式(子实体无需额外注解):

HTTPie AI
HTTPie AI

AI API开发工具

下载
@Entity
data class User(
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    var id: Long? = null,

    var username: String = "",
    var email: String = ""
) : AuditableEntity() // 自动继承审计字段及 @JsonIgnore

⚠️ 注意事项

  • 确保已启用 JPA Auditing:在主配置类上添加 @EnableJpaAuditing;
  • @JsonIgnore 作用于字段而非 getter,因此需确保 Jackson 使用字段访问策略(Spring Boot 2.6+ 默认开启 spring.jackson.visibility.field=ANY;若自定义了 visibility,需确认兼容);
  • 若需在特定接口中临时启用审计字段(如管理后台),可用 @JsonInclude(JsonInclude.Include.NON_NULL) 配合 DTO 手动映射,避免污染通用响应;
  • 时间类型建议统一使用 LocalDateTime(推荐)或 Instant,避免 Date 的时区歧义与序列化兼容性问题。

该方案真正实现了“一次定义、处处生效”,兼顾可维护性与性能,是中大型 Spring Boot 项目处理审计字段响应过滤的最佳实践。

相关专题

更多
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 应用的流行工具。

8

2025.12.22

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

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

101

2025.12.24

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

小游戏4399大全
小游戏4399大全

4399小游戏免费秒玩大全来了!无需下载、即点即玩,涵盖动作、冒险、益智、射击、体育、双人等全品类热门小游戏。经典如《黄金矿工》《森林冰火人》《狂扁小朋友》一应俱全,每日更新最新H5游戏,支持电脑与手机跨端畅玩。访问4399小游戏中心,重温童年回忆,畅享轻松娱乐时光!官方入口安全绿色,无插件、无广告干扰,打开即玩,快乐秒达!

30

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号