此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Commons 3.5.3！spring-doc.cadn.net.cn

审计

基本

Spring Data 提供复杂的支持，以透明地跟踪谁创建或更改了实体以及更改发生的时间。要从该功能中受益，您必须为实体类配备审核元数据，这些元数据可以使用注释或通过实现接口来定义。 此外，必须通过 Annotation 配置或 XML 配置启用审计，以注册所需的基础架构组件。 有关配置示例，请参阅特定于商店的部分。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定义属性的注释类型@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定义属性的注释类型@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