审计

基础

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