审计

基础

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

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

基于注解的审计元数据

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

一个被审计的实体

class Customer {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

  // … further properties omitted
}

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

提供时间实例的是 org.springframework.data.auditing.DateTimeProvider。默认情况下，这是 CurrentDateTimeProvider。可以通过启用审计时的 dateTimeProviderRef 属性来更改此设置，或者通过在 ApplicationContext 中存在专用的 AuditingHandler 或 DateTimeProvider bean 来更改。

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

嵌入式实体中的审计元数据

class Customer {

  private AuditMetadata auditingMetadata;

  // … further properties omitted
}

class AuditMetadata {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

}

基于接口的审计元数据

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

`AuditorAware`

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

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

基于 Spring Security 的 AuditorAware 实现

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);
  }
}

该实现访问 Spring Security 提供的 Authentication 对象，并查找您在 UserDetailsService 实现中创建的自定义 UserDetails 实例。我们在此假设您通过 UserDetails 实现公开领域用户，但根据找到的 Authentication，您也可以从任何地方查找它。

`ReactiveAuditorAware`

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

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

基于 Spring Security 的 ReactiveAuditorAware 实现

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);
  }
}

还有一个方便的基类 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>

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

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

}

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

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

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

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

从 Spring Data JPA 1.5 开始，你可以通过使用 @EnableJpaAuditing 注解来启用审计。你仍然需要修改 orm.xml 文件并将 spring-aspects.jar 放在类路径中。以下示例展示了如何使用 @EnableJpaAuditing 注解

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

@Configuration
@EnableJpaAuditing
class Config {

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

如果你向 ApplicationContext 公开一个 AuditorAware 类型的 Bean，审计基础设施会自动将其拾取并用于确定要设置在领域类型上的当前用户。如果你在 ApplicationContext 中注册了多个实现，可以通过显式设置 @EnableJpaAuditing 的 auditorAwareRef 属性来选择要使用的实现。