审计

基本

Spring Data 提供了复杂的支持，以透明方式跟踪创建或更改实体的人员以及更改发生的时间。要从该功能中受益，您必须为实体类配备审计元数据，这些元数据可以使用注释或通过实现接口来定义。 此外，必须通过 Annotation 配置或 XML 配置来启用审计，以注册所需的基础设施组件。 有关配置示例，请参阅特定于 store 的部分。spring-doc.cadn.net.cn

不需要仅跟踪创建和修改日期的应用程序会使其实体实现AuditorAware.spring-doc.cadn.net.cn

基于注释的审计元数据

我们提供@CreatedBy和@LastModifiedBy捕获创建或修改实体的用户以及@CreatedDate和@LastModifiedDate捕获更改发生的时间。spring-doc.cadn.net.cn

已审核的实体
class Customer {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

  // … further properties omitted
}

如您所见，可以有选择地应用注释，具体取决于要捕获的信息。 注释（指示何时进行更改进行捕获）可用于 JDK8 日期和时间类型的属性。long,Long和旧版 JavaDate和Calendar.spring-doc.cadn.net.cn

审计元数据不一定需要位于根级别实体中，但可以添加到嵌入的实体中（取决于使用的实际存储），如下面的代码段所示。spring-doc.cadn.net.cn

审核嵌入实体中的元数据
class Customer {

  private AuditMetadata auditingMetadata;

  // … further properties omitted
}

class AuditMetadata {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

}

基于接口的审计元数据

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

AuditorAware

如果您使用@CreatedBy或@LastModifiedBy，则审计基础架构需要以某种方式了解当前主体。为此，我们提供了一个AuditorAware<T>SPI 接口，您必须实现该接口才能告诉基础架构与应用程序交互的当前用户或系统是谁。泛型类型T定义 Comments 属性的类型@CreatedBy或@LastModifiedBy必须如此。spring-doc.cadn.net.cn

以下示例显示了使用 Spring Security 的Authentication对象：spring-doc.cadn.net.cn

实现AuditorAware基于 Spring Security
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);
  }
}

该实现访问Authentication对象，并查找自定义的UserDetails实例中创建的实例UserDetailsService实现。我们在这里假设您通过UserDetails实现，但基于Authentication找到，您也可以从任何地方查找它。spring-doc.cadn.net.cn

ReactiveAuditorAware

当使用反应式基础设施时，您可能希望利用上下文信息来提供@CreatedBy或@LastModifiedBy信息。 我们提供ReactiveAuditorAware<T>SPI 接口，您必须实现该接口才能告诉基础架构与应用程序交互的当前用户或系统是谁。泛型类型T定义 Comments 属性的类型@CreatedBy或@LastModifiedBy必须如此。spring-doc.cadn.net.cn

以下示例显示了使用反应式 Spring Security 的Authentication对象：spring-doc.cadn.net.cn

实现ReactiveAuditorAware基于 Spring Security
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);
  }
}

该实现访问Authentication对象，并查找自定义的UserDetails实例中创建的实例UserDetailsService实现。我们在这里假设您通过UserDetails实现，但基于Authentication找到，您也可以从任何地方查找它。spring-doc.cadn.net.cn