审计

基本

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

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

基于注释的审计元数据

我们提供 and capture 创建或修改实体的用户，以及 和 capture 更改发生的时间。@CreatedBy@LastModifiedBy@CreatedDate@LastModifiedDatespring-doc.cn

已审核的实体
class Customer {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

  // … further properties omitted
}

如您所见，可以有选择地应用注释，具体取决于要捕获的信息。 这些注释（指示在进行更改时进行捕获）可用于 JDK8 日期和时间类型、 、 以及旧版 Java 和 的属性。longLongDateCalendarspring-doc.cn

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

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

  private AuditMetadata auditingMetadata;

  // … further properties omitted
}

class AuditMetadata {

  @CreatedBy
  private User user;

  @CreatedDate
  private Instant createdDate;

}

基于接口的审计元数据

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

AuditorAware

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

下面的示例展示了使用 Spring Security 对象的接口的实现：Authenticationspring-doc.cn

基于 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 提供的对象，并查找您在实现中创建的自定义实例。我们在这里假设你正在通过实现公开域用户，但根据找到的结果，你也可以从任何地方查找它。AuthenticationUserDetailsUserDetailsServiceUserDetailsAuthenticationspring-doc.cn

ReactiveAuditorAware

使用反应式基础设施时，您可能希望利用上下文信息来提供信息。 我们提供了一个 SPI 接口，您必须实现该接口才能告诉基础设施与应用程序交互的当前用户或系统是谁。泛型类型定义 property 的 Comments 类型或必须是什么类型。@CreatedBy@LastModifiedByReactiveAuditorAware<T>T@CreatedBy@LastModifiedByspring-doc.cn

以下示例显示了使用反应式 Spring Security 对象的接口的实现：Authenticationspring-doc.cn

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

该实现访问 Spring Security 提供的对象，并查找您在实现中创建的自定义实例。我们在这里假设你正在通过实现公开域用户，但根据找到的结果，你也可以从任何地方查找它。AuthenticationUserDetailsUserDetailsServiceUserDetailsAuthenticationspring-doc.cn

还有一个方便的基类 ，您可以扩展它以避免手动实现接口方法。这样做会增加域类与 Spring Data 的耦合，这可能是你想要避免的。通常，首选基于注释的审核元数据定义方式，因为它的侵入性更小且更灵活。AbstractAuditablespring-doc.cn

常规审计配置

Spring Data JPA 附带一个实体侦听器，可用于触发审计信息的捕获。首先，您必须在文件内注册 to used for persistence contexts 中的所有实体，如以下示例所示：AuditingEntityListenerorm.xmlspring-doc.cn

示例 1.审计配置orm.xml
<persistence-unit-metadata>
  <persistence-unit-defaults>
    <entity-listeners>
      <entity-listener class="….data.jpa.domain.support.AuditingEntityListener" />
    </entity-listeners>
  </persistence-unit-defaults>
</persistence-unit-metadata>

您还可以使用注释按实体启用 ，如下所示：AuditingEntityListener@EntityListenersspring-doc.cn

@Entity
@EntityListeners(AuditingEntityListener.class)
public class MyEntity {

}
审计功能需要位于 Classpath 上。spring-aspects.jar

经过适当修改并在 Classpath 上，激活审计功能是将 Spring Data JPA 命名空间元素添加到配置中的问题，如下所示：orm.xmlspring-aspects.jarauditingspring-doc.cn

示例 2.使用 XML 配置激活审计
<jpa:auditing auditor-aware-ref="yourAuditorAwareBean" />

从 Spring Data JPA 1.5 开始，您可以通过使用 Comments 注释配置类来启用审计。您仍必须修改文件 and on classpath。以下示例演示如何使用注释：@EnableJpaAuditingorm.xmlspring-aspects.jar@EnableJpaAuditingspring-doc.cn

例 3.使用 Java 配置激活审计
@Configuration
@EnableJpaAuditing
class Config {

  @Bean
  public AuditorAware<AuditableUser> auditorProvider() {
    return new AuditorAwareImpl();
  }
}

如果向 公开 类型的 bean，则审计基础结构会自动获取该 bean 并使用它来确定要在域类型上设置的当前用户。如果在 中注册了多个实现，则可以通过显式设置 的属性来选择要使用的实现。AuditorAwareApplicationContextApplicationContextauditorAwareRef@EnableJpaAuditingspring-doc.cn