跳到主要内容

审计

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，你也可以从任何地方查找它。