|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Data JPA 3.4.0！ |
审计
基本
Spring Data 提供了复杂的支持，以透明方式跟踪创建或更改实体的人员以及更改发生的时间。要从该功能中受益，您必须为实体类配备审计元数据，这些元数据可以使用注释或通过实现接口来定义。 此外，必须通过 Annotation 配置或 XML 配置来启用审计，以注册所需的基础设施组件。 有关配置示例，请参阅特定于 store 的部分。
|
不需要仅跟踪创建和修改日期的应用程序会使其实体实现 |
基于注释的审计元数据
我们提供@CreatedBy和@LastModifiedBy捕获创建或修改实体的用户以及@CreatedDate和@LastModifiedDate来捕获更改发生的时间。
class Customer {
@CreatedBy
private User user;
@CreatedDate
private Instant createdDate;
// … further properties omitted
}如您所见，可以有选择地应用注释，具体取决于要捕获的信息。
注释（指示何时进行更改进行捕获）可用于 JDK8 日期和时间类型的属性。long,Long和旧版 JavaDate和Calendar.
审计元数据不一定需要位于根级别实体中，但可以添加到嵌入的实体中（取决于使用的实际存储），如下面的代码段所示。
class Customer {
private AuditMetadata auditingMetadata;
// … further properties omitted
}
class AuditMetadata {
@CreatedBy
private User user;
@CreatedDate
private Instant createdDate;
}AuditorAware
如果您使用@CreatedBy或@LastModifiedBy，则审计基础架构需要以某种方式了解当前主体。为此，我们提供了一个AuditorAware<T>SPI 接口，您必须实现该接口才能告诉基础架构与应用程序交互的当前用户或系统是谁。泛型类型T定义 Comments 属性的类型@CreatedBy或@LastModifiedBy必须如此。
以下示例显示了使用 Spring Security 的Authentication对象：
AuditorAware基于 Spring Securityclass 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找到，您也可以从任何地方查找它。
ReactiveAuditorAware
当使用反应式基础设施时，您可能希望利用上下文信息来提供@CreatedBy或@LastModifiedBy信息。
我们提供ReactiveAuditorAware<T>SPI 接口，您必须实现该接口才能告诉基础架构与应用程序交互的当前用户或系统是谁。泛型类型T定义 Comments 属性的类型@CreatedBy或@LastModifiedBy必须如此。
以下示例显示了使用反应式 Spring Security 的Authentication对象：
ReactiveAuditorAware基于 Spring Securityclass 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找到，您也可以从任何地方查找它。
还有一个方便的基类AbstractAuditable，您可以对其进行扩展以避免手动实现接口方法。这样做会增加域类与 Spring Data 的耦合，这可能是你想要避免的。通常，首选基于注释的审核元数据定义方式，因为它的侵入性更小且更灵活。
常规审计配置
Spring Data JPA 附带一个实体侦听器，可用于触发审计信息的捕获。首先，您必须注册AuditingEntityListener用于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注解，如下所示：
@Entity
@EntityListeners(AuditingEntityListener.class)
public class MyEntity {
}审计功能需要spring-aspects.jar以位于 Classpath 上。 |
跟orm.xml经过适当修改和spring-aspects.jar在 Classpath 上，激活审计功能是添加 Spring Data JPA 的问题auditingnamespace 元素添加到配置中，如下所示：
<jpa:auditing auditor-aware-ref="yourAuditorAwareBean" />从 Spring Data JPA 1.5 开始，您可以通过使用@EnableJpaAuditing注解。您仍必须修改orm.xml文件并具有spring-aspects.jar在 Classpath 上。以下示例演示如何使用@EnableJpaAuditing注解：
@Configuration
@EnableJpaAuditing
class Config {
@Bean
public AuditorAware<AuditableUser> auditorProvider() {
return new AuditorAwareImpl();
}
}如果公开了AuditorAware到ApplicationContext，审计基础架构会自动获取它并使用它来确定要在域类型上设置的当前用户。如果您在ApplicationContext中，您可以通过显式设置auditorAwareRef属性@EnableJpaAuditing.