SpringBoot中SOAP Endpoint异步实现失效问题求助

核心原因 #

Spring的@Async注解默认通过动态代理实现，但SOAP端点（@Endpoint标注的类）的初始化和调用流程由Spring WS框架直接处理，普通的异步代理逻辑无法拦截端点方法的调用，导致@Async注解失效。

可行解决方案 #

方案1：自定义异步端点拦截器（推荐） #

通过实现EndpointInterceptor，手动将业务逻辑提交到异步任务执行器，绕过Spring WS的同步调用流程。

1. 实现异步拦截器

@Component
public class AsyncEndpointInterceptor implements EndpointInterceptor {

    private final TaskExecutor taskExecutor;

    public AsyncEndpointInterceptor(TaskExecutor taskExecutor) {
        this.taskExecutor = taskExecutor;
    }

    @Override
    public boolean handleRequest(MessageContext messageContext, Object endpoint) throws Exception {
        // 提取SOAP请求 payload
        Source requestPayload = messageContext.getRequestPayload();
        
        // 获取目标端点方法的参数（根据实际业务调整）
        MyRequest request = (MyRequest) ((DomPoxMessage) messageContext.getRequest()).getPayloadSource();

        // 异步执行核心业务逻辑
        taskExecutor.execute(() -> {
            try {
                // 调用原端点的业务方法（需把核心逻辑抽成单独的方法）
                MyResponse response = ((MyEndpoint) endpoint).processRequest(request);
                
                // 构造并设置响应
                messageContext.setResponsePayload(new DomSource(responseToDocument(response)));
            } catch (Exception e) {
                // 处理异常
                messageContext.setResponsePayload(new DomSource(errorToDocument(e)));
            }
        });

        // 返回false，阻止Spring WS继续同步处理请求
        return false;
    }

    // 辅助方法：将响应对象转为Document（根据实际业务实现）
    private Document responseToDocument(MyResponse response) throws Exception {
        // 实现对象到XML Document的转换逻辑
    }

    private Document errorToDocument(Exception e) throws Exception {
        // 实现异常到错误响应XML Document的转换逻辑
    }

    // 其他接口方法默认返回true即可
    @Override
    public boolean handleResponse(MessageContext messageContext, Object endpoint) throws Exception {
        return true;
    }

    @Override
    public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception {
        return true;
    }

    @Override
    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) throws Exception {
        // 清理逻辑
    }
}

2. 注册拦截器到SOAP配置

@Configuration
@EnableWs
public class SoapConfig extends WsConfigurerAdapter {

    private final AsyncEndpointInterceptor asyncInterceptor;

    public SoapConfig(AsyncEndpointInterceptor asyncInterceptor) {
        this.asyncInterceptor = asyncInterceptor;
    }

    @Override
    public void addInterceptors(List<EndpointInterceptor> interceptors) {
        interceptors.add(asyncInterceptor);
        super.addInterceptors(interceptors);
    }

    // 其他SOAP配置（如MessageDispatcherServlet、Wsdl11Definition等）
}

方案2：采用JAX-WS异步API规范 #

如果需要完全遵循SOAP异步服务规范（客户端发起异步请求，后续通过回调获取响应），可以使用JAX-WS的AsyncResponse机制：

1. 修改端点方法为异步模式

@Endpoint
public class MyEndpoint {

    private final MyService myService;

    public MyEndpoint(MyService myService) {
        this.myService = myService;
    }

    @PayloadRoot(namespace = "http://yournamespace.com", localPart = "MyRequest")
    public void processRequestAsync(@RequestPayload MyRequest request, AsyncResponse asyncResponse) {
        // 异步执行业务逻辑
        CompletableFuture.runAsync(() -> {
            try {
                MyResponse response = myService.process(request);
                asyncResponse.resume(response);
            } catch (Exception e) {
                asyncResponse.resume(new WebServiceException("处理失败", e));
            }
        });
    }
}

2. 客户端需通过JAX-WS异步API发起请求，比如dispatch.invokeAsync(request, handler)，Spring WS默认支持该异步端点模式。

方案3：基础代理条件排查（备选） #

如果仍想尝试使用@Async，需确保以下条件满足：

• @Endpoint类和端点方法均不能是final修饰（动态代理无法代理final类/方法）
• @EnableAsync注解添加在被Spring扫描到的配置类上
• 自定义异步任务执行器，避免使用默认同步执行器

@Configuration
@EnableAsync
public class AsyncConfig {

    @Bean
    public TaskExecutor asyncTaskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(5);
        executor.setMaxPoolSize(10);
        executor.setQueueCapacity(20);
        executor.setThreadNamePrefix("soap-async-");
        executor.initialize();
        return executor;
    }
}

注意：此方案仅在Spring WS的端点代理逻辑能被Spring异步代理覆盖时生效，实际测试中大概率无法生效，更推荐方案1或方案2。

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