springboot~jpa审计字段的自动填充

在使用 Spring Data JPA 中的 @CreatedDate 注解时，如果希望自动填充创建时间字段，通常需要结合 @EntityListeners(AuditingEntityListener.class) 注解一起使用。这是因为 @CreatedDate 等审计注解通常与审计事件监听器（AuditingEntityListener）一起工作，用于处理实体的审计信息。
审计字段-自动填充

当您界说一个实体类（比方 EntityBase）并希望使用 @CreatedDate 注解来自动设置创建时间时，可以按照以下步骤操作：

• 在实体类中添加 @CreatedDate 注解，实体可抽象成一个类，如EntityBase,AuditBase等：
  

1. @Getter
2. @Setter
3. @MappedSuperclass
4. @EntityListeners(AuditingEntityListener.class)
5. public abstract class EntityBase {
7.         /**
8.          * 创建人
9.          */
10.         @Column(name = "created_by")
11.         @CreatedBy
12.         private String createdBy;
14.         /**
15.          * 修改人
16.          */
17.         @Column(name = "updated_by")
18.         @LastModifiedBy
19.         private String updatedBy;
21.         /**
22.          * 创建时间
23.          */
24.         @Column(name = "created_time")
25.         @CreatedDate
26.         private java.time.LocalDateTime createdTime;
28.         /**
29.          * 更新时间
30.          */
31.         @Column(name = "update_time")
32.         @LastModifiedDate
33.         private java.time.LocalDateTime updateTime;
35. }

复制代码

• 确保审计事件监听器生效：
  确保 AuditingEntityListener 能够精确监听实体类的审计事件，并在保存实体对象时自动填充相应的审计信息，包括创建时间等。
  
• 实现AuditorAware接口，返回当前登录的用户，以便填充create_by字段，同时开启审计功能@EnableJpaAuditing:
  

1. @EnableJpaAuditing
2. @Component
3. public class AuditorAwareImpl implements AuditorAware {
5.         @Override
6.         public Optional getCurrentAuditor() {
7.                 return Optional.of("lind");
8.         }
10. }

复制代码

通过以上步骤，您可以在订阅 EntityBase 实体类时使用 @CreatedDate 注解，并结合 @EntityListeners(AuditingEntityListener.class) 注解来自动填充创建时间字段，从而实现审计功能。
AuditorAware获取请求头信息

要在实现 AuditorAware 接口的 getCurrentAuditor() 方法中获取当前请求头（HTTP Header）中的变量，您可以借助 Spring 提供的 RequestContextHolder 和 ServletRequestAttributes 来访问当前请求的上下文信息。具体步骤如下：

• 获取当前请求的 HttpServletRequest 对象：
  
  
  
  • 首先，您需要从 RequestContextHolder.getRequestAttributes() 获取当前请求的 ServletRequestAttributes 对象。
    
  • 然后通过 ServletRequestAttributes 对象获取当前的 HttpServletRequest 对象。
    
  
  
• 从 HttpServletRequest 中获取请求头信息：
  
  
  
  • 在 HttpServletRequest 对象中，您可以使用 getHeader() 方法来获取指定名称的请求头信息。
    
  
  

下面是一个示例代码，演示了如安在 AuditorAware 的 getCurrentAuditor() 方法中获取当前请求头中的变量：

1. import org.springframework.data.domain.AuditorAware;
2. import org.springframework.web.context.request.RequestContextHolder;
3. import org.springframework.web.context.request.ServletRequestAttributes;
5. import javax.servlet.http.HttpServletRequest;
6. import java.util.Optional;
8. @EnableJpaAuditing
9. @Component
10. public class CustomAuditorAware implements AuditorAware<String> {
12.     @Override
13.     public Optional<String> getCurrentAuditor() {
14.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
15.         if (attributes != null) {
16.             HttpServletRequest request = attributes.getRequest();
17.             String customHeaderValue = request.getHeader("Custom-Header");
18.             return Optional.ofNullable(customHeaderValue);
19.         }
20.         return Optional.empty();
21.     }
22. }

复制代码

如果是基于netty的WEB框架，需要使用下面代码获取请求头参数

1. @EnableJpaAuditing
2. @Component
3. public class AuditorAwareImpl implements AuditorAware<String> {
5.         @Override
6.         public Optional<String> getCurrentAuditor() {
7.                 Object request = RpcContext.getServiceContext().getRequest();
8.                 if (request != null) {
9.                         NettyRequestFacade requestFacade = (NettyRequestFacade) request;
10.                         if (requestFacade != null && requestFacade.getHeader("preferred_username") != null) {
11.                                 return Optional.of(requestFacade.getHeader("preferred_username"));
12.                         }
13.                 }
14.                 return Optional.of("none");
15.         }
17. }

复制代码

在上述代码中，我们通过 RequestContextHolder 获取当前请求的上下文信息，并从中提取出请求头中名为 Custom-Header 的自界说变量值。末了将该值作为审计职员信息返回。

请注意，在使用 RequestContextHolder 时，确保上下文中包含请求信息，否则可能会出现空指针非常。别的，这种方式适用于基于 Spring MVC 或 Spring WebFlux 的应用。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。