Spring Batch：如何配置FlatFileItemReader读取含#注释的行

嘿，我之前在使用Spring Batch的FlatFileItemReader时也碰到过这个问题——默认情况下它会自动跳过以#开头的注释行，但如果我们需要读取这些行的话，有几个实用的解决办法，我给你梳理一下：

方法一：直接修改默认的注释标记配置 #

FlatFileItemReader默认通过setCommentMarker()方法设置注释标记，默认值就是#。要让它不再跳过这类行，最简单的方式就是把这个标记改成一个不会出现在你的文件内容里的字符，或者直接设置为null：

FlatFileItemReader<YourItem> reader = new FlatFileItemReader<>();
// 取消注释标记，这样所有行都会被读取
reader.setCommentMarker(null);

// 或者替换成其他字符（比如$），只有以$开头的行才会被跳过
// reader.setCommentMarker("$");

// 其他必要配置
reader.setResource(new ClassPathResource("your-target-file.txt"));
reader.setLineMapper(yourLineMapper);

方法二：自定义LineMapper区分处理注释行 #

如果你既想保留对其他注释标记的支持，又要把#开头的行当作有效记录读取（比如把它们标记为特殊的Item），可以自定义LineMapper来实现：

首先写一个自定义的LineMapper类：

public class CommentAwareLineMapper implements LineMapper<YourItem> {
    private DefaultLineMapper<YourItem> defaultLineMapper;

    public CommentAwareLineMapper() {
        defaultLineMapper = new DefaultLineMapper<>();
        // 这里可以保留默认的注释标记配置（如果需要的话）
    }

    @Override
    public YourItem mapLine(String line, int lineNumber) throws Exception {
        if (line.startsWith("#")) {
            // 针对注释行创建特殊的Item实例
            YourItem commentItem = new YourItem();
            commentItem.setRawContent(line);
            commentItem.setIsComment(true);
            return commentItem;
        } else {
            // 正常行使用默认的映射逻辑
            return defaultLineMapper.mapLine(line, lineNumber);
        }
    }

    // 提供setter方法来配置默认LineMapper的Tokenizer和Mapper
    public void setLineTokenizer(LineTokenizer tokenizer) {
        defaultLineMapper.setLineTokenizer(tokenizer);
    }

    public void setFieldSetMapper(FieldSetMapper<YourItem> fieldSetMapper) {
        defaultLineMapper.setFieldSetMapper(fieldSetMapper);
    }
}

然后在配置Reader时使用这个自定义的LineMapper：

FlatFileItemReader<YourItem> reader = new FlatFileItemReader<>();
reader.setResource(new ClassPathResource("your-target-file.txt"));

CommentAwareLineMapper lineMapper = new CommentAwareLineMapper();
// 设置你需要的行解析器
lineMapper.setLineTokenizer(new DelimitedLineTokenizer());
// 设置字段到Item的映射器
lineMapper.setFieldSetMapper(new BeanWrapperFieldSetMapper<>() {{
    setTargetType(YourItem.class);
}});

reader.setLineMapper(lineMapper);

方法三：自定义RecordSeparatorPolicy（复杂场景适用） #

如果你的文件注释规则更复杂（比如不是整行以#开头，而是行内包含#），可以自定义RecordSeparatorPolicy来控制哪些行被当作有效记录。不过这个场景下前两种方法通常已经足够解决问题了。

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