使用Spring Data实现数据审计：@CreatedDate, @CreatedBy, @LastModifiedDate, @LastModifiedBy

2024 年 02 月 05 日

101 次浏览

2393字数

在构建现代应用时，数据审计是一个核心需求，用以追踪实体的创建和修改历史。Spring Data提供了一套简洁的注解，使得在Java应用中实现数据审计变得简单而直接。通过使用 @CreatedDate, @CreatedBy, @LastModifiedDate, @LastModifiedBy等注解，开发者能够自动追踪实体的生命周期事件，比如何时被创建或修改，以及由谁创建或修改。这不仅增加了数据的透明度，还极大地简化了数据管理过程。本文将详细解释如何在Spring Data项目中利用这些注解来实现数据审计。

开启JPA审计

首先，要启用JPA审计，需要在Spring配置类中添加 @EnableJpaAuditing注解。这个注解会激活审计功能，允许你在实体类中使用审计相关的注解。

@Configuration
@EnableJpaAuditing(auditorAwareRef = "auditorProvider")
public class AuditConfig {
    @Bean
    public AuditorAware<String> auditorProvider() {
        return () -> Optional.ofNullable("当前用户");
        // 实际应用中，这里应该返回当前登录用户
    }
}

使用审计注解

在实体类中，可以使用以下注解来自动填充相应字段：

@CreatedDate: 记录实体被创建的时间。
@CreatedBy: 记录创建实体的用户。
@LastModifiedDate: 记录实体最后一次被修改的时间。
@LastModifiedBy: 记录最后修改实体的用户。

为了让这些注解生效，实体类需要继承 Auditable类或直接使用字段注解。以下是一个简单的例子：

@Entity
public class MyEntity extends Auditable<String> {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    // 其他实体属性

}

Auditable类可能看起来像这样：

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class Auditable<U> {

    @CreatedBy
    protected U createdBy;

    @CreatedDate
    @Temporal(TemporalType.TIMESTAMP)
    protected Date createdDate;

    @LastModifiedBy
    protected U lastModifiedBy;

    @LastModifiedDate
    @Temporal(TemporalType.TIMESTAMP)
    protected Date lastModifiedDate;

    // getter和setter
}

这个设置允许你在实体被保存或更新时，自动地将创建时间、修改时间、创建者、以及修改者的信息填充到相应的字段中。这极大地简化了审计信息的管理，让开发者能够更加专注于业务逻辑的实现。