0

0

Spring Boot 中统一忽略审计字段的优雅实践

花韻仙語

花韻仙語

发布时间:2025-12-31 13:52:18

|

452人浏览过

|

来源于php中文网

原创

Spring Boot 中统一忽略审计字段的优雅实践

本文介绍如何在 spring boot 项目中通过抽象基类 + `@jsonignore` 实现审计字段(如 createdby、createddate)的全局序列化屏蔽,避免在每个实体类中重复添加注解,提升代码复用性与可维护性。

在构建 RESTful API 时,JPA 审计功能(如 @CreatedBy、@CreatedDate)极大简化了元数据管理,但这些字段通常不应暴露在 API 响应中——既涉及数据安全(如用户 ID 泄露),也违背接口契约的简洁性原则。若为数十个实体逐一添加 @JsonIgnore 或 @JsonIgnoreProperties,不仅冗余,还易遗漏、难维护。

一个高效且符合 DRY 原则的解决方案是:定义统一的审计基类,集中声明并屏蔽审计字段

✅ 推荐实现:@MappedSuperclass + @JsonIgnore 全局控制

使用 @MappedSuperclass 定义抽象父类,将所有公共审计字段及其 Jackson 序列化控制逻辑内聚于此。所有业务实体继承该类后,自动获得审计能力与响应屏蔽能力:

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

    @Column(name = "created_at", updatable = false)
    @CreationTimestamp
    @JsonIgnore // ← 关键:统一屏蔽,不参与 JSON 序列化
    var createdAt: LocalDateTime? = null

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

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

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

    // 可选:提供友好格式化的时间字符串(仅用于读取,不映射数据库)
    val createdAtStr: String
        get() = createdAt?.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm")) ?: ""

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

随后,您的业务实体只需简单继承即可:

HTTPie AI
HTTPie AI

AI API开发工具

下载
@Entity
@Table(name = "users")
class User : AuditableEntity() {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    var id: Long? = null

    @Column(name = "username", nullable = false)
    var username: String? = null

    @Column(name = "email")
    var email: String? = null
}

效果验证:调用 GET /api/users/1 时,响应 JSON 中将完全不包含 createdAt、createdBy 等字段,无需任何额外配置。

⚠️ 注意事项与增强建议

  • 确保启用 JPA Auditing:在主配置类或启动类上添加 @EnableJpaAuditing,并配置 AuditorAware Bean;
  • 时间类型推荐 LocalDateTime:相比 Date,它更符合现代 Java 时间 API,且与数据库 TIMESTAMP 映射更自然(需确认 JDBC 驱动支持);
  • 如需部分场景暴露审计信息(如管理后台),可结合 @JsonView 或自定义序列化器实现条件化输出,而非全局屏蔽;
  • 避免在基类中使用 @JsonIgnoreProperties:它作用于整个类,粒度粗且无法与 @JsonIgnore 共存;@JsonIgnore 字段级控制更精准、可继承、易调试;
  • 数据库字段命名建议统一加前缀/后缀(如 _at, _by),便于 SQL 审计追踪,也利于团队规范。

通过这一设计,您不仅消除了重复注解,更将审计生命周期管理(存储)与表现层关注点(序列化)清晰分离,真正践行了关注点分离(SoC)与开闭原则(OCP)——新增实体只需继承,无需修改序列化逻辑。

相关专题

更多
java
java

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

804

2023.06.15

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

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

723

2023.07.05

java自学难吗
java自学难吗

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

727

2023.07.31

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

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

395

2023.08.01

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

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

398

2023.08.02

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

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

445

2023.08.02

java有什么用
java有什么用

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

428

2023.08.02

java在线网站
java在线网站

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

16861

2023.08.03

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

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

30

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 39.8万人学习

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

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