审计

基础知识

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