跳到主要内容

审计

DeepSeek V3 中英对照 Auditing

基础​

Spring Data 提供了复杂的支持，以透明地跟踪谁创建或更改了实体以及更改发生的时间。要利用此功能，您必须为实体类配备审计元数据，这些元数据可以通过使用注解或实现接口来定义。此外，必须通过注解配置或 XML 配置启用审计，以注册所需的基础设施组件。请参阅特定存储部分的配置示例。

备注

仅跟踪创建和修改日期的应用程序不需要让其实体实现 AuditorAware。

基于注解的审计元数据​

我们提供了 @CreatedBy 和 @LastModifiedBy 来捕获创建或修改实体的用户，以及 @CreatedDate 和 @LastModifiedDate 来捕获更改发生的时间。

class Customer {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

  // … further properties omitted
}
java

如你所见，注解可以根据你想要捕获的信息进行选择性应用。这些用于指示在更改时捕获的注解可以应用于 JDK8 日期和时间类型、long、Long 以及旧的 Java Date 和 Calendar 类型的属性。

审计元数据并不一定需要存在于根级实体中，而是可以添加到嵌入式实体中（取决于实际使用的存储），如下面的代码片段所示。

class Customer {

  private AuditMetadata auditingMetadata;

  // … further properties omitted
}

class AuditMetadata {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

}
java

基于接口的审计元数据​

如果你不想使用注解来定义审计元数据，你可以让你的领域类实现 Auditable 接口。该接口公开了所有审计属性的 setter 方法。

AuditorAware​

如果你使用了 @CreatedBy 或 @LastModifiedBy，审计基础结构需要以某种方式获知当前的主体。为此，我们提供了一个 AuditorAware<T> SPI 接口，你需要实现该接口来告诉基础结构当前与应用程序交互的用户或系统是谁。泛型类型 T 定义了使用 @CreatedBy 或 @LastModifiedBy 注解的属性必须具有的类型。

以下示例展示了使用 Spring Security 的 Authentication 对象实现的接口：

class SpringSecurityAuditorAware implements AuditorAware<User> {

  @Override
  public Optional<User> getCurrentAuditor() {

    return Optional.ofNullable(SecurityContextHolder.getContext())
            .map(SecurityContext::getAuthentication)
            .filter(Authentication::isAuthenticated)
            .map(Authentication::getPrincipal)
            .map(User.class::cast);
  }
}
java

该实现访问了由 Spring Security 提供的 Authentication 对象，并查找了你在 UserDetailsService 实现中创建的自定义 UserDetails 实例。我们假设你通过 UserDetails 实现暴露了领域用户，但基于找到的 Authentication，你也可以从任何地方查找它。

ReactiveAuditorAware​

在使用响应式基础设施时，您可能希望利用上下文信息来提供 @CreatedBy 或 @LastModifiedBy 信息。我们提供了一个 ReactiveAuditorAware<T> SPI 接口，您需要实现该接口以告知基础设施当前与应用程序交互的用户或系统是谁。泛型类型 T 定义了使用 @CreatedBy 或 @LastModifiedBy 注解的属性必须是什么类型。

以下示例展示了使用响应式 Spring Security 的 Authentication 对象实现的接口：

class SpringSecurityAuditorAware implements ReactiveAuditorAware<User> {

  @Override
  public Mono<User> getCurrentAuditor() {

    return ReactiveSecurityContextHolder.getContext()
                .map(SecurityContext::getAuthentication)
                .filter(Authentication::isAuthenticated)
                .map(Authentication::getPrincipal)
                .map(User.class::cast);
  }
}
java

该实现访问了由 Spring Security 提供的 Authentication 对象，并查找你在 UserDetailsService 实现中创建的自定义 UserDetails 实例。我们在这里假设你通过 UserDetails 实现暴露了领域用户，但基于找到的 Authentication，你也可以从任何地方查找该用户。

还有一个方便的基类 AbstractAuditable，你可以继承它以避免手动实现接口方法。这样做会增加你的领域类与 Spring Data 的耦合，这可能是你想要避免的。通常，基于注解的方式定义审计元数据更受欢迎，因为它侵入性更小且更灵活。

通用审计配置​

Spring Data JPA 自带一个实体监听器，可以用于触发审计信息的捕获。首先，您必须在 orm.xml 文件中注册 AuditingEntityListener，以便它可以在持久化上下文中用于所有实体，如下例所示：

示例 1. 审核配置 orm.xml

<persistence-unit-metadata>
  <persistence-unit-defaults>
    <entity-listeners>
      <entity-listener class="….data.jpa.domain.support.AuditingEntityListener" />
    </entity-listeners>
  </persistence-unit-defaults>
</persistence-unit-metadata>
xml

你也可以通过在实体上使用 @EntityListeners 注解来为每个实体启用 AuditingEntityListener，如下所示：

@Entity
@EntityListeners(AuditingEntityListener.class)
public class MyEntity {

}
java
备注

审计功能需要 spring-aspects.jar 位于类路径中。

在 orm.xml 适当修改并且 spring-aspects.jar 位于类路径上的情况下，激活审计功能只需在配置中添加 Spring Data JPA 的 auditing 命名空间元素，如下所示：

示例 2. 使用 XML 配置激活审计功能

<jpa:auditing auditor-aware-ref="yourAuditorAwareBean" />
xml

自 Spring Data JPA 1.5 起，你可以通过使用 @EnableJpaAuditing 注解来启用审计功能。你仍然需要修改 orm.xml 文件，并在 classpath 中包含 spring-aspects.jar。以下示例展示了如何使用 @EnableJpaAuditing 注解：

示例 3. 使用 Java 配置激活审计功能

@Configuration
@EnableJpaAuditing
class Config {

  @Bean
  public AuditorAware<AuditableUser> auditorProvider() {
    return new AuditorAwareImpl();
  }
}
java

如果你将一个类型为 AuditorAware 的 bean 暴露给 ApplicationContext，审计基础设施会自动获取它，并使用它来确定要在域类型上设置的当前用户。如果你在 ApplicationContext 中注册了多个实现，你可以通过显式设置 @EnableJpaAuditing 的 auditorAwareRef 属性来选择要使用的实现。