Spring Batch StaxEventItemReader 如何处理XSD校验无效行并跳过
实现方案
默认Jaxb2Marshaller开启XSD校验后,遇到校验错误会直接抛出异常打断流程。可以通过三层改造实现「校验失败打日志、跳过无效记录、不终止整体作业」的目标,同时保证非单条记录级别的严重错误(比如XML整体格式损坏)还是能正常终止作业,避免静默失败。
核心实现逻辑
- 改造Marshaller的校验错误处理逻辑,将单条记录的校验错误封装为自定义异常
- 在Step层面开启容错能力,仅对单条记录级别的校验错误执行跳过,不拦截XML级别的严重错误
- 通过Skip监听器捕获跳过的无效记录,输出结构化日志
具体代码实现
1. 定义单条记录校验异常
专门用来标记单条XML片段的校验失败,和XML整体格式错误做区分:
public class InvalidXmlRecordException extends RuntimeException { // 原始XML片段上下文 private final String rawFragment; // 具体校验错误信息 private final String validationError; public InvalidXmlRecordException(String rawFragment, String validationError) { super(String.format("无效XML记录,片段标识:%s,错误原因:%s", rawFragment, validationError)); this.rawFragment = rawFragment; this.validationError = validationError; } // 省略getter方法 }
2. 自定义Marshaller的校验事件处理器
替换默认的「遇到校验错误直接终止unmarshall」的逻辑,收集单条记录的校验错误,抛出自定义异常:
@Bean public Jaxb2Marshaller jaxb2Marshaller() throws Exception { Jaxb2Marshaller jaxb2Marshaller = new Jaxb2Marshaller(); jaxb2Marshaller.setClassesToBeBound(BookDto.class); jaxb2Marshaller.setSchema(new ClassPathResource("book.xsd")); // 自定义校验事件处理,替换默认抛出逻辑 jaxb2Marshaller.setValidationEventHandler(event -> { // 仅拦截错误级别的校验问题,警告级别直接放行 if (event.getSeverity() != ValidationEvent.WARNING) { String errorDetail = String.format( "解析行号:%d,列号:%d,错误描述:%s", event.getLocator().getLineNumber(), event.getLocator().getColumnNumber(), event.getMessage() ); // 抛出自定义异常,后续会被Spring Batch容错机制捕获 throw new InvalidXmlRecordException("当前解析的book节点", errorDetail); } return true; }); jaxb2Marshaller.afterPropertiesSet(); return jaxb2Marshaller; }
3. 调整Step的容错与监听器配置
开启Step的容错能力,区分单条记录错误与XML整体错误,仅对单条校验失败的场景执行跳过:
@Bean public Step xmlProcessStep(Jaxb2Marshaller jaxb2Marshaller) throws Exception { return new StepBuilderFactory(jobRepository, transactionManager) .get("xmlProcessStep") .reader(xmlReader(jaxb2Marshaller)) .writer(yourBusinessWriter()) // 替换为你实际的业务Writer // 开启容错模式 .faultTolerant() // 拦截unmarshall阶段抛出的异常,再做细分判断 .skip(UnmarshallingFailureException.class) // 最大可跳过记录数,可根据XML实际规模调整 .skipLimit(1000) // 配置Skip监听器,处理跳过逻辑 .listener(new SkipListener<BookDto, BookDto>() { private static final Logger log = LoggerFactory.getLogger(XmlSkipListener.class); @Override public void onSkipInRead(Throwable t) { // 遍历异常链,判断是否为单条记录校验失败的异常 boolean isSingleRecordError = false; Throwable cause = t.getCause(); while (cause != null) { if (cause instanceof InvalidXmlRecordException) { isSingleRecordError = true; break; } cause = cause.getCause(); } if (isSingleRecordError) { // 单条校验失败,输出warn日志,执行跳过 log.warn("跳过无效XML记录,详情: {}", cause.getMessage()); } else { // 非单条错误(比如XML整体格式损坏、标签未闭合等),重新抛出异常终止作业 throw new RuntimeException("XML文件存在严重格式错误,作业终止", t); } } @Override public void onSkipInWrite(BookDto item, Throwable t) {} @Override public void onSkipInProcess(BookDto item, Throwable t) {} }) .build(); }
调整原有的Reader配置,将自定义的Marshaller注入:
@Bean @JobScope public StaxEventItemReader<?> xmlReader(Jaxb2Marshaller jaxb2Marshaller) throws Exception { return new StaxEventItemReaderBuilder<BookDto>() .name("xmlReader") .resource(new ClassPathResource("books.xml")) .addFragmentRootElements("book") .unmarshaller(jaxb2Marshaller) .build(); }
注意事项
不要直接将所有
SAXParseException、UnmarshallingFailureException都设置为可跳过异常,这类异常如果是XML整体文件的格式问题,静默跳过会导致作业无有效处理数据却返回成功。仅通过自定义异常链判断的方式,才能精准跳过单条记录的校验错误,拦截严重的文件级错误。如果需要在日志中输出无效记录的完整XML片段,可以自定义StaxEventItemReader,在解析每个fragment时将对应的XML内容缓存到ThreadLocal中,构建自定义异常时取出填充,不需要修改核心的跳过逻辑。
效果验证
使用提供的示例XML测试时:
- 第一条id为
bk101的book记录,会因为author长度超出限制、price字段包含非数字字符触发校验错误,被监听器捕获输出日志,不会进入后续业务流程 - 第二条id为
bk102的符合XSD规则的记录,会正常被读取、处理,整个作业不会因为无效记录中断运行
内容的提问来源于stack exchange,提问作者enkor
相关产品推荐
相关产品推荐

