如何配置Envers排除@Scheduled定时任务的数据库审计记录？

核心思路是让Envers能够识别当前操作是否来自定时任务线程，如果是就跳过审计流程。下面分享几种可行的实现方案，你可以根据项目实际情况选择：

方案1：线程上下文标记+自定义审计监听器 #

这是最通用的方案，通过ThreadLocal标记线程身份，再在Envers的监听器里判断是否跳过审计。

1. 创建线程上下文标记工具类
   用来设置、获取和清除当前线程是否为定时任务的标记：

public class TaskContextHolder {
    private static final ThreadLocal<Boolean> IS_SCHEDULED_TASK = new ThreadLocal<>();

    public static void setIsScheduledTask(boolean isTask) {
        IS_SCHEDULED_TASK.set(isTask);
    }

    public static boolean isScheduledTask() {
        Boolean flag = IS_SCHEDULED_TASK.get();
        return flag != null && flag;
    }

    public static void clear() {
        IS_SCHEDULED_TASK.remove();
    }
}

2. 给定时任务线程打标记
   通过自定义TaskDecorator，在定时任务执行前后设置和清除标记，避免线程池复用导致标记残留：

@Configuration
@EnableScheduling
public class SchedulingConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setTaskScheduler(taskScheduler());
    }

    @Bean
    public TaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setTaskDecorator(runnable -> () -> {
            try {
                TaskContextHolder.setIsScheduledTask(true);
                runnable.run();
            } finally {
                TaskContextHolder.clear();
            }
        });
        scheduler.setPoolSize(5);
        scheduler.setThreadNamePrefix("scheduled-task-");
        return scheduler;
    }
}

3. 自定义Envers审计监听器
   继承默认的EnversAuditEventListener，重写审计方法，判断线程标记后决定是否执行审计：

public class SkipScheduledTaskAuditListener extends EnversAuditEventListener {
    @Override
    public void onPostInsert(PostInsertEvent event) {
        if (!TaskContextHolder.isScheduledTask()) {
            super.onPostInsert(event);
        }
    }

    @Override
    public void onPostUpdate(PostUpdateEvent event) {
        if (!TaskContextHolder.isScheduledTask()) {
            super.onPostUpdate(event);
        }
    }

    @Override
    public void onPostDelete(PostDeleteEvent event) {
        if (!TaskContextHolder.isScheduledTask()) {
            super.onPostDelete(event);
        }
    }

    // 若需要处理集合变更审计，可重写onPostCollectionUpdate等对应方法
}

最后注册这个自定义监听器，替换默认的Envers监听器：

@Configuration
public class EnversConfig {
    @Bean
    public AuditEventListener auditEventListener() {
        return new SkipScheduledTaskAuditListener();
    }
}

方案2：自定义AuditStrategy（进阶版） #

Envers的AuditStrategy负责决策是否生成审计记录，我们可以通过自定义策略来跳过定时任务操作：

1. 实现自定义审计策略
   继承DefaultAuditStrategy，在核心方法里判断线程标记：

public class SkipScheduledTaskAuditStrategy extends DefaultAuditStrategy {
    @Override
    public void perform(
            Session session,
            String entityName,
            AuditConfiguration auditCfg,
            Serializable id,
            Object data,
            Object revision) {
        if (!TaskContextHolder.isScheduledTask()) {
            super.perform(session, entityName, auditCfg, id, data, revision);
        }
    }

    // 按需重写performCollectionChange等其他方法
}

2. 配置Envers使用自定义策略
   在Spring Boot的application.yml里添加配置：

spring:
  jpa:
    properties:
      org.hibernate.envers.audit_strategy: com.yourpackage.SkipScheduledTaskAuditStrategy

或者在persistence.xml中配置：

<persistence-unit name="yourPersistenceUnit">
    <!-- 其他配置 -->
    <properties>
        <property name="org.hibernate.envers.audit_strategy" value="com.yourpackage.SkipScheduledTaskAuditStrategy"/>
    </properties>
</persistence-unit>

⚠️ 注意：此方案仍需配合方案1中的TaskContextHolder和定时任务标记逻辑使用。

方案3：利用Spring Security上下文（适用于已集成Security的项目） #

如果你的项目已经用了Spring Security，用户操作会携带SecurityContext，而定时任务线程默认没有上下文，可直接通过这个特征判断：

public class SkipScheduledTaskAuditListener extends EnversAuditEventListener {
    @Override
    public void onPostInsert(PostInsertEvent event) {
        // 仅当存在有效用户认证上下文时，才执行审计
        Authentication auth = SecurityContextHolder.getContext().getAuthentication();
        if (auth != null && !(auth instanceof AnonymousAuthenticationToken)) {
            super.onPostInsert(event);
        }
    }

    // 同样重写onPostUpdate、onPostDelete等方法
}

这种方案无需额外的线程标记，适合已经基于Spring Security做用户权限管理的项目。

关键注意事项 #

• 务必确保线程标记在任务执行完毕后被清除，否则线程池复用会导致后续非任务操作被误判。
• 如果定时任务使用@Async异步执行，也要用TaskDecorator给异步线程打上标记，逻辑和定时任务调度器一致。

内容的提问来源于stack exchange，提问作者José Lisboa