审计

基本

Spring Data 提供复杂的支持,透明跟踪谁创建或更改实体及其变更时间。为了享受该功能,你必须为实体类配备审计元数据,这些元数据可以通过注释定义或实现接口来定义。 此外,审计还必须通过注释配置或XML配置来注册所需的基础设施组件。 请参阅商店专属部分的配置示例。spring-doc.cadn.net.cn

仅跟踪创建和修改日期的应用程序不要求其实体实现审计员.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 日期和时间的属性,,以及遗留的Java日期日历.spring-doc.cadn.net.cn

给时间实例由org.springframework.data.auditing.DateTimeProvider. 默认情况下,这是当前日期时间提供者. 这可以通过dateTimeProviderRef启用审计时的属性,或专用的审计处理者日期时间提供者豆子出现在应用上下文.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;

}

基于接口的审计元数据

如果你不想用注释来定义审计元数据,可以让你的领域类实现可审计接口。它揭示了所有审计属性的设置方法。spring-doc.cadn.net.cn

审计员

如果你用其中一种@CreatedBy@LastModifiedBy审计基础设施需要以某种方式了解当前的原则。为此,我们提供审计员<T>你必须实现 SPI 接口,告诉基础设施当前与应用交互的用户或系统是谁。通用类型T定义了注释属性的类型@CreatedBy@LastModifiedBy必须是。spring-doc.cadn.net.cn

以下示例展示了使用 Spring Security 的接口实现认证对象:spring-doc.cadn.net.cn

实现审计员基于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);
  }
}

该实现访问认证Spring Security 提供的对象,并查找自定义用户详情你在你的中创造了实例用户详情服务实现。我们假设你通过用户详情但实现,基于认证找到了,你也可以在任何地方查找。spring-doc.cadn.net.cn

ReactiveAuditorAware

使用响应式基础设施时,你可能需要利用上下文信息来提供@CreatedBy@LastModifiedBy信息。 我们提供ReactiveAuditorAware<T>你必须实现 SPI 接口,告诉基础设施当前与应用交互的用户或系统是谁。通用类型T定义了注释属性的类型@CreatedBy@LastModifiedBy必须是。spring-doc.cadn.net.cn

以下示例展示了使用响应式 Spring Security 的接口实现认证对象: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);
  }
}

该实现访问认证Spring Security 提供的对象,并查找自定义用户详情你在你的中创造了实例用户详情服务实现。我们假设你通过用户详情但实现,基于认证找到了,你也可以在任何地方查找。spring-doc.cadn.net.cn

还有一个便利基类,AbstractAuditable你可以扩展这些方法,避免手动实现接口方法。这样做会增加你的域类与 Spring Data 的耦合,这可能是你想避免的。通常,基于注释的方式定义审计元数据更受青睐,因为它侵入性更低且更具灵活性。spring-doc.cadn.net.cn

通用审计配置

Spring Data JPA 自带实体监听器,可用于触发审计信息的捕获。首先,您必须注册AuditingEntityListener用于你在 S 内部的持久化上下文中的所有实体orm.xml文件,如下例所示:spring-doc.cadn.net.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在每个实体基础上,通过使用@EntityListeners注释如下:spring-doc.cadn.net.cn

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

}
审计功能要求spring-aspects.jar走上阶级道路。

orm.xml经过适当修改和spring-aspects.jar在类路径上,激活审计功能只需添加 Spring Data JPA审计命名空间元素,具体如下:spring-doc.cadn.net.cn

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

从Spring Data JPA 1.5开始,你可以通过在配置类中添加注释来启用审计@EnableJpaAuditing注解。你仍然必须修改orm.xml归档并拥有spring-aspects.jar在阶级路径上。以下示例展示了如何使用@EnableJpaAuditing注解:spring-doc.cadn.net.cn

例子3。通过 Java 配置激活审计
@Configuration
@EnableJpaAuditing
class Config {

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

如果你暴露出一颗类型的豆子审计员前往应用上下文审计基础设施会自动接收并利用它确定当前用户需要设置的域名类型。如果你在应用上下文你可以通过显式设置 来选择要使用的auditorAwareRef属性@EnableJpaAuditing.spring-doc.cadn.net.cn