审计

基础知识

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，审计基础设施需要某种方式感知当前的主体（principal）。为此，我们提供了 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);
  }
}