spring jpa 审计功能自定义填充字段方式

首先，我们需要了解什么是 Spring Data JPA 审计功能。Spring Data JPA 审计功能是从 Spring Data JPA 1.5 版本开始引入的一个功能，它提供了一种简单方便的方式来自动填充实体类中的创建时间、修改时间、创建人、修改人等审计信息。在默认情况下，Spring Data JPA 审计功能会自动填充这些审计信息字段，但是有时候我们需要自定义这些字段的值。下面，我们就来详细讲解一下如何实现 Spring Data JPA 审计功能自定义填充字段的方式。

创建审计配置类

第一步，我们需要创建一个审计配置类，并在类上加上 @Configuration 和 @EnableJpaAuditing 注解。其中 @EnableJpaAuditing 注解用于启用 Spring Data JPA 审计功能。

@Configuration
@EnableJpaAuditing
public class AuditConfig {

}

定义审计信息实体类

第二步，我们需要定义一个审计信息实体类，用于存储审计信息。这个实体类需要继承 org.springframework.data.jpa.domain.AbstractAuditable 类。

@Entity
@Table(name = "audit_info")
public class AuditInfo extends AbstractAuditable<User, Long> {
    @Column(name = "event_type")
    private String eventType;

    // getter、setter 方法省略
}

在上面的代码中，我们将审计信息存储在一张名为 audit_info 的数据表中。审计信息的类型包括了创建时间、修改时间、创建人、修改人和自定义审计信息（如上面代码中的 eventType 字段）。

定义审计信息填充器

第三步，我们需要定义一个审计信息填充器，用于自定义审计信息。在审计信息填充器中，我们可以使用 Spring Security 或者 ThreadLocal 等方式获取当前用户信息，并填充相应的审计信息。

@Component
public class AuditInfoFiller implements AuditorAware<User> {
    @Override
    public User getCurrentAuditor() {
        // 从 Spring Security 中获取当前用户信息
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if (authentication != null && authentication.getPrincipal() instanceof User) {
            return (User) authentication.getPrincipal();
        }
        return null;
    }

    public AuditInfo fillAuditInfo(String eventType) {
        AuditInfo auditInfo = new AuditInfo();
        auditInfo.setEventType(eventType);
        auditInfo.setCreatedBy(getCurrentAuditor());
        auditInfo.setCreatedDate(new Date());
        auditInfo.setLastModifiedBy(getCurrentAuditor());
        auditInfo.setLastModifiedDate(new Date());
        return auditInfo;
    }
}

在上面的代码中，我们定义了一个 AuditInfoFiller 类，并实现了 AuditorAware<User> 接口，用于获取当前用户信息。在 fillAuditInfo 方法中，我们创建了一个 AuditInfo 实例，并构造了自定义的审计信息。

加入审计信息填充器到 JPA 配置

最后一步，我们需要将上面定义的审计信息填充器加入到 JPA 配置中。

@Configuration
@EnableJpaAuditing(auditorAwareRef = "auditInfoFiller")
public class AuditConfig {
    @Bean
    public AuditorAware<User> auditInfoFiller() {
        return new AuditInfoFiller();
    }
}

在上面的代码中，我们使用 auditorAwareRef 属性将 AuditInfoFiller 注入到 EnableJpaAuditing 中，这样就可以在执行数据库操作时，自动将审计信息填充到实体类中。

示例代码

这里提供两个示例代码，一个是通过 ThreadLocal 方式获取当前用户信息填充审计信息，另一个是通过 Spring Security 方式获取当前用户信息填充审计信息。

使用 ThreadLocal 方式获取当前用户信息填充审计信息

@Component
public class AuditInfoFiller implements AuditorAware<User> {
    private static final ThreadLocal<User> THREAD_LOCAL = new ThreadLocal<>();

    public void setCurrentUser(User user) {
        THREAD_LOCAL.set(user);
    }

    @Override
    public User getCurrentAuditor() {
        return THREAD_LOCAL.get();
    }

    public AuditInfo fillAuditInfo(String eventType) {
        AuditInfo auditInfo = new AuditInfo();
        auditInfo.setEventType(eventType);
        auditInfo.setCreatedBy(getCurrentAuditor());
        auditInfo.setCreatedDate(new Date());
        auditInfo.setLastModifiedBy(getCurrentAuditor());
        auditInfo.setLastModifiedDate(new Date());
        return auditInfo;
    }
}

在上面的代码中，我们使用了 ThreadLocal 来存储当前线程中的用户信息，并在 fillAuditInfo 方法中获取当前用户信息。

使用 Spring Security 方式获取当前用户信息填充审计信息

@Component
public class AuditInfoFiller implements AuditorAware<User> {
    @Override
    public User getCurrentAuditor() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if (authentication != null && authentication.getPrincipal() instanceof User) {
            return (User) authentication.getPrincipal();
        }
        return null;
    }

    public AuditInfo fillAuditInfo(String eventType) {
        AuditInfo auditInfo = new AuditInfo();
        auditInfo.setEventType(eventType);
        auditInfo.setCreatedBy(getCurrentAuditor());
        auditInfo.setCreatedDate(new Date());
        auditInfo.setLastModifiedBy(getCurrentAuditor());
        auditInfo.setLastModifiedDate(new Date());
        return auditInfo;
    }
}

在上面的代码中，我们使用了 Spring Security 来获取当前用户信息，并在 fillAuditInfo 方法中获取当前用户信息。需要注意的是，在使用 Spring Security 获取当前用户信息时，需要在 WebSecurityConfig 中配置 AuthenticationManager，并在 Spring Security 中注册用户认证信息。这里不再赘述。

阅读剩余 66%