Spring Batch构建REST/SOAP ItemReader：RestTemplate替代方案选型

背景 #

现有基于Spring Batch的产品需要新增SOAP和REST WebService读取器支持，此前使用的reficio Soap库已停用10年，不仅长期存在问题，还不兼容Java 17，官方明确建议改用Spring WebServices库。

最初计划基于RestTemplate或SOAP客户端实现ItemReader，但发现RestTemplate已被弃用，官方推荐的替代组件WebClient属于响应式框架。而Spring Batch官方明确指出：Reactive Streams面向无限数据流设计，Spring Batch则针对有限固定数据集的批处理场景，二者本质不匹配；且Spring Batch的块处理模型需要等待整个块处理完成后才读取下一块，与响应式范式天然不兼容。

方案分析与推荐 #

1. 采用阻塞调用的WebClient（REST场景优先） #

这是当前最平衡的折中方案：

• 既规避了RestTemplate的技术债务，又适配Spring Batch的阻塞式块处理模型
• 通过WebClient的block()方法实现同步调用，保持ItemReader的阻塞特性，完全契合Spring Batch核心模型
• 核心实现示例：

public class RestWebServiceItemReader<T> implements ItemReader<T> {
    private final WebClient webClient;
    private int currentPage = 0;
    private final int pageSize = 100;
    private List<T> currentItems = new ArrayList<>();

    @Override
    public T read() throws Exception {
        if (currentItems.isEmpty()) {
            // 分页调用REST接口，阻塞获取结果
            currentItems = webClient.get()
                    .uri(uriBuilder -> uriBuilder.path("/batch/data")
                            .queryParam("page", currentPage)
                            .queryParam("size", pageSize)
                            .build())
                    .retrieve()
                    .bodyToFlux(T.class)
                    .collectList()
                    .block();

            if (currentItems == null || currentItems.isEmpty()) {
                return null; // 数据读取完毕
            }
            currentPage++;
        }
        // 返回当前块的下一个元素
        return currentItems.remove(0);
    }
}

• 注意：需自行处理分页迭代、元素缓存和终止逻辑，严格遵循Spring Batch ItemReader契约（返回null表示读取完成）

2. 使用Spring WebServices的WebServiceClient（SOAP场景优先） #

对于SOAP接口，Spring官方维护的Spring WebServices库提供了成熟的阻塞式客户端：

• 完全兼容Java 17，属于官方推荐组件，无技术债务风险
• 基于WebServiceTemplate构建阻塞式SOAP调用，与Spring Batch的阻塞模型天然适配
• 核心实现示例：

public class SoapWebServiceItemReader<T> implements ItemReader<T> {
    private final WebServiceTemplate webServiceTemplate;
    private int currentOffset = 0;
    private final int fetchSize = 100;
    private List<T> currentItems = new ArrayList<>();

    @Override
    public T read() throws Exception {
        if (currentItems.isEmpty()) {
            // 构建带分页参数的SOAP请求
            BatchDataRequest request = new BatchDataRequest();
            request.setOffset(currentOffset);
            request.setFetchSize(fetchSize);

            // 阻塞调用SOAP接口
            BatchDataResponse response = (BatchDataResponse) webServiceTemplate.marshalSendAndReceive(request);
            currentItems = response.getBatchItems();

            if (currentItems == null || currentItems.isEmpty()) {
                return null;
            }
            currentOffset += fetchSize;
        }
        return currentItems.remove(0);
    }
}

• 优势：官方支持、稳定可靠，完美适配SOAP场景的阻塞式批处理需求

3. 其他可选方案 #

• 自定义阻塞式HTTP客户端：如使用Apache HttpClient或OkHttp实现REST调用，灵活性高，但需自行处理序列化/反序列化、错误重试、连接池管理等逻辑，开发维护成本较高
• 第三方扩展组件：部分开源扩展提供了现成的REST/SOAP ItemReader，但需优先选择官方或活跃维护的组件，避免引入新的兼容性问题

总结 #

• REST场景：优先选择阻塞调用的WebClient，兼顾技术栈先进性与Spring Batch兼容性
• SOAP场景：优先选择Spring WebServices的WebServiceClient，遵循官方推荐，保障长期稳定性

内容的提问来源于stack exchange，提问作者pojo-guy