如何在实现ItemWriteListener的类中获取Job名称或Step名称

要在写入错误日志中包含Job和Step名称，核心是获取Spring Batch的StepExecution对象——它包含了当前执行的Job和Step的元数据。具体实现步骤如下：

实现方案 #

1. 让你的WriterListener同时实现StepExecutionListener接口，通过该接口的beforeStep方法获取并保存当前的StepExecution实例
2. 在onWriteError方法中，从保存的StepExecution中提取Job名称和Step名称，加入日志输出
3. 若Step为多线程执行，使用ThreadLocal存储StepExecution避免并发冲突

修改后的完整代码 #

import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.annotation.BeforeStep;
import org.springframework.batch.core.listener.ItemWriteListener;
import org.springframework.batch.core.listener.StepExecutionListener;
import org.springframework.core.log.PlatformLogger;
import org.springframework.core.log.LogAccessor;

import java.util.List;
import java.util.Arrays;

public class WriterListener implements ItemWriteListener<Object>, StepExecutionListener {

    private static final LogAccessor logger = new LogAccessor(PlatformLogger.getLogger(WriterListener.class));
    // 多线程场景下用ThreadLocal保证线程安全
    private final ThreadLocal<StepExecution> stepExecutionHolder = new ThreadLocal<>();

    @Override
    @BeforeStep
    public void beforeStep(StepExecution stepExecution) {
        stepExecutionHolder.set(stepExecution);
    }

    @Override
    public void beforeWrite(List<?> list) {
        // 保留原有逻辑
    }

    @Override
    public void afterWrite(List<?> list) {
        // 保留原有逻辑
    }

    @Override
    public void onWriteError(Exception e, List<?> list) {
        StepExecution stepExecution = stepExecutionHolder.get();
        if (stepExecution != null) {
            String jobName = stepExecution.getJobExecution().getJobInstance().getJobName();
            String stepName = stepExecution.getStepName();
            logger.error(e, "Job [{}] - Step [{}] 写入数据时发生异常，数据内容：{}", 
                        jobName, stepName, Arrays.toString(list.toArray()));
        } else {
            // 降级处理：获取不到StepExecution时输出原有日志
            logger.error(e, "写入数据时发生异常，数据内容：{}", Arrays.toString(list.toArray()));
        }
    }

    @Override
    public void afterStep(StepExecution stepExecution) {
        // 清理ThreadLocal，避免内存泄漏
        stepExecutionHolder.remove();
    }
}

关键说明 #

• 通过@BeforeStep注解标记beforeStep方法，Spring Batch会在Step执行前自动注入当前的StepExecution对象
• ThreadLocal的使用是为了适配多线程Step场景（比如配置了taskExecutor的Step），防止不同线程的StepExecution互相覆盖
• 在afterStep中清理ThreadLocal，避免长期持有对象导致内存泄漏
• 日志优先使用带异常参数的重载方法，确保异常栈能被完整记录

内容的提问来源于stack exchange，提问作者Dharmendra kannaujiya