审计

基础

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 的属性。

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

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

class Customer {

  private AuditMetadata auditingMetadata;

  // … further properties omitted
}

class AuditMetadata {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

}

基于接口的审计元数据

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

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