Spring Batch FlatFileItemWriter实现CSV导出及输出文件实时可见问题解决

核心问题1：自定义字段提取、过滤null值的逗号分隔输出 #

问题根源 #

原实现使用PassThroughLineAggregator作为行聚合器，该组件会直接将传入的对象调用toString()方法输出，因此会直接打印Fixing{...}格式的对象默认字符串，无法实现自定义字段提取的需求。

改动方案 #

替换默认的PassThroughLineAggregator，自定义行聚合逻辑：

• 按业务需要的字段顺序，逐个判断字段值是否为null
• 收集所有非null的字段值
• 使用逗号拼接所有有效字段值作为单条输出行

示例聚合逻辑：

LineAggregator<Fixing> customAggregator = fixing -> {
    List<String> validFieldValues = new ArrayList<>();
    if (fixing.getId() != null) {
        validFieldValues.add(fixing.getId());
    }
    if (fixing.getSource() != null) {
        validFieldValues.add(fixing.getSource());
    }
    if (fixing.getStartDate() != null) {
        validFieldValues.add(fixing.getStartDate().toString());
    }
    if (fixing.getEndDate() != null) {
        validFieldValues.add(fixing.getEndDate().toString());
    }
    return String.join(",", validFieldValues);
};

替换后即可实现过滤null字段、逗号分隔输出的效果，最终输出格式与预期一致。

核心问题2：文件输出延迟、需退出应用才能查看完整内容 #

问题根源 #

原实现的生命周期管理完全不符合Spring Batch的组件规范，核心问题包括：

• 重复在write方法内设置资源、初始化writer、打开文件流，导致流的打开/关闭逻辑混乱
• 错误使用@AfterWrite注解做关闭操作，该注解触发时机为每个chunk写入完成后，且不会主动触发文件缓冲区的强制刷盘动作
• 未将writer的流生命周期与Spring Batch的Stream接口绑定，导致文件流的flush、close操作仅在JVM退出时才会触发，必须退出应用才能看到完整文件内容

改动方案 #

严格遵循Spring Batch的ItemStream接口规范实现writer的全生命周期管理：

• 在bean初始化阶段一次性完成writer的资源配置、聚合器设置、参数校验，避免在write方法内重复初始化
• 实现open、update、close方法，由Spring Batch框架在作业启动、chunk持久化、作业完成的对应时机主动调用，确保文件流在作业完成时主动刷盘、关闭

修正后的完整实现参考：

public class MyItemWriter implements ItemWriter<Fixing>, ItemStream {
    private final FlatFileItemWriter<Fixing> writer;

    public MyItemWriter () {
        // 初始化阶段一次性完成全部writer配置
        this.writer = new FlatFileItemWriter<>();
        this.writer.setResource(new FileSystemResource("target/output-teste.txt"));
        // 绑定自定义行聚合逻辑
        this.writer.setLineAggregator(fixing -> {
            List<String> validFieldValues = new ArrayList<>();
            if (fixing.getId() != null) validFieldValues.add(fixing.getId());
            if (fixing.getSource() != null) validFieldValues.add(fixing.getSource());
            if (fixing.getStartDate() != null) validFieldValues.add(fixing.getStartDate().toString());
            if (fixing.getEndDate() != null) validFieldValues.add(fixing.getEndDate().toString());
            return String.join(",", validFieldValues);
        });
        // 初始化时一次性完成参数校验
        try {
            this.writer.afterPropertiesSet();
        } catch (Exception e) {
            throw new IllegalStateException("FlatFileItemWriter初始化失败", e);
        }
    }

    @Override
    public void open(ExecutionContext executionContext) {
        // 作业启动时由框架调用，打开文件流
        this.writer.open(executionContext);
    }

    @Override
    public void write(List<? extends Fixing> items) throws Exception {
        // 仅负责当前chunk的数据写入，不做重复初始化
        this.writer.write(items);
    }

    @Override
    public void update(ExecutionContext executionContext) {
        // chunk处理完成时由框架调用，持久化当前写入位置
        this.writer.update(executionContext);
    }

    @Override
    public void close() {
        // 作业完成时由框架调用，强制刷新缓冲区到磁盘、关闭文件流
        this.writer.close();
    }
}

改动完成后，所有条目处理写入流程结束时，框架会主动完成文件流的刷盘操作，无需关闭Spring Boot应用即可直接查看完整的输出文件。

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