Spring Batch中以对象作为响应返回的最优标准方式是什么？

在同步执行Spring Batch作业的场景下，要将ItemWriter执行完毕后生成的对象作为响应返回，最优且符合框架规范的方式是利用Spring Batch原生的ExecutionContext结合监听器传递数据，完全不需要自定义共享结构。

实现步骤 #

1. 在ItemWriter中通过StepExecution传递结果 #

让你的ItemWriter实现StepExecutionListener接口，通过该接口获取当前Step的执行上下文，在ItemWriter完成写入逻辑后，将生成的结果对象存入ExecutionContext：

@Component
public class CustomItemWriter implements ItemWriter<YourItemType>, StepExecutionListener {

    private StepExecution stepExecution;
    private YourResultObject resultObject;

    @Override
    public void write(List<? extends YourItemType> items) throws Exception {
        // 执行业务写入逻辑
        // ...
        
        // 写入完成后创建并初始化结果对象
        resultObject = new YourResultObject();
        resultObject.setProcessedCount(items.size());
        resultObject.setStatus("SUCCESS");
    }

    @Override
    public void beforeStep(StepExecution stepExecution) {
        // 保存当前Step的执行上下文引用
        this.stepExecution = stepExecution;
    }

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        // 将结果对象存入ExecutionContext
        stepExecution.getExecutionContext().put("jobExecutionResult", resultObject);
        return ExitStatus.COMPLETED;
    }
}

2. 在RestController中获取结果并返回 #

同步执行作业时，JobLauncher.run()会阻塞直到作业完成，此时可以从返回的JobExecution中获取对应Step的ExecutionContext，取出结果对象作为响应体返回：

@RestController
@RequestMapping("/batch")
public class BatchJobController {

    @Autowired
    private JobLauncher jobLauncher;
    @Autowired
    private Job yourBatchJob;

    @PostMapping("/execute")
    public ResponseEntity<YourResultObject> executeJob() throws Exception {
        // 构建唯一的作业参数（避免重复执行同一作业实例）
        JobParameters jobParams = new JobParametersBuilder()
                .addLong("executeTime", System.currentTimeMillis())
                .toJobParameters();

        // 同步执行作业
        JobExecution jobExecution = jobLauncher.run(yourBatchJob, jobParams);

        // 获取目标Step的执行上下文（根据Step名称精准匹配，避免多Step场景出错）
        StepExecution targetStepExecution = jobExecution.getStepExecutions().stream()
                .filter(stepExec -> "yourStepName".equals(stepExec.getStepName()))
                .findFirst()
                .orElseThrow(() -> new IllegalStateException("未找到目标Step的执行记录"));

        // 从ExecutionContext中取出结果对象
        YourResultObject result = (YourResultObject) targetStepExecution.getExecutionContext().get("jobExecutionResult");
        return ResponseEntity.ok(result);
    }
}

关键说明 #

• ExecutionContext是官方标准：它是Spring Batch专门设计用于在作业、步骤、组件间传递数据的容器，自带线程安全保障，且与作业仓库的持久化逻辑兼容，完全符合框架设计规范。
• 序列化要求：存入ExecutionContext的结果对象必须实现Serializable接口，因为Spring Batch会将ExecutionContext持久化到作业仓库（如数据库），否则会抛出序列化异常。
• 精准匹配Step：如果作业包含多个Step，一定要通过Step名称过滤获取对应的StepExecution，避免取错其他Step的上下文数据。

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