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 序列化控制逻辑内聚于此。所有业务实体继承该类后,自动获得审计能力与响应屏蔽能力:

百宝箱
百宝箱

百宝箱是支付宝推出的一站式AI原生应用开发平台,无需任何代码基础,只需三步即可完成AI应用的创建与发布。

下载
@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")) ?: ""
}

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

@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)——新增实体只需继承,无需修改序列化逻辑。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1133

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

381

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2152

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

380

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1683

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

585

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

440

2024.04.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共23课时 | 4.3万人学习

C# 教程
C# 教程

共94课时 | 11.2万人学习

Java 教程
Java 教程

共578课时 | 81万人学习

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

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