如何在Spring WebServiceTemplate中设置超时时间

Question

我正在使用org.springframework.ws.client.core.WebServiceTemplate来进行Web服务调用。我该如何配置调用的超时时间。

- Sai Kumar

Answer 1

如果您正在使用Spring Webservices 2.1.0版本，则可以使用HttpComponentsMessageSender设置超时时间。 CommonsHttpMessageSender已被弃用，Spring不再推荐使用。

我实现的方式是，定义我的WebServiceTemplate使用HttpComponentsMessageSender。

值以毫秒为单位。

<bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
    <property name="defaultUri" value="${endpoint.url}" />
    <property name="marshaller" ref="marshaller" />
    <property name="unmarshaller" ref="unmarshaller" />
    <property name="messageSender">
        <bean class="org.springframework.ws.transport.http.HttpComponentsMessageSender">
            <property name="connectionTimeout" value="1200000" />
            <property name="readTimeout" value="1200000" />
        </bean>
    </property>
</bean>

请确保您在pom文件中添加了以下内容

<dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.2.1</version>
        <scope>compile</scope>
    </dependency>

- Sathish Murugesan

Answer 2

与Sathish的答案相同，但以编程方式实现（Spring 4+）：

@Component
public class MyWebServiceGatewaySupport extends WebServiceGatewaySupport
{
    @Value("${my.ws.readtimeout}")
    private String readTimeout;

    @Value("${my.ws.connectiontimeout}")
    private String connectionTimeout;

    Object marshalSendAndReceive(String endpoint, Object requestPayload)
    {

        WebServiceTemplate wsTemplate = this.getWebServiceTemplate();
        WebServiceMessageSender[] senders = wsTemplate.getMessageSenders();
        for (WebServiceMessageSender sender: senders)
        {
            try
            {
                int readTimeoutMsec = Integer.parseInt(readTimeout);
                int connTimeoutMsec = Integer.parseInt(connectionTimeout);
                HttpComponentsMessageSender httpSender = (HttpComponentsMessageSender) sender;
                httpSender.setReadTimeout(readTimeoutMsec);
                httpSender.setConnectionTimeout(connTimeoutMsec);
            }
            catch (ClassCastException|NumberFormatException cex)
            {
                 logger.warn("Cannot set WS timeout: " + cex.getMessage());
            }
        }

        return wsTemplate.marshalSendAndReceive(endpoint, requestPayload);

     }
 }

- Guildenstern70

---

我在我的Spring Boot和Spring WS项目中已经使用了Integer注入，例如：@Value("${my.ws.readtimeout}") private Integer readTimeout。 - EliuX

我必须在senders中找到HttpUrlConnectionMessageSender，并将java.time.Duration.ofMillis()提供给设置器。 - Zyl

出现错误：java.lang.UnsupportedOperationException 位于org.apache.http.impl.client.InternalHttpClient.getParams(InternalHttpClient.java:211) 在org.springframework.ws.transport.http.HttpComponentsMessageSender.setReadTimeout(HttpComponentsMessageSender.java:149) - Lho Ben

Answer 3

自Spring Webservices 2.2起，您还可以使用Spring的ClientHttpRequestMessageSender：

@Service
public class CustomWebServiceImpl extends WebServiceGatewaySupport implements CustomWebService {
    private static final int CONNECTION_TIMEOUT = (10 * 1000);
    private static final int READ_TIMEOUT = (10 * 1000);

    public CustomWebServiceImpl() {
        SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
        requestFactory.setConnectTimeout(CONNECTION_TIMEOUT);
        requestFactory.setReadTimeout(READ_TIMEOUT);
        setMessageSender(new ClientHttpRequestMessageSender(requestFactory));
    }

    (...)
}

（不需要依赖于Apache HTTP组件）

- darrachequesne

---

谢谢@darrachequesne，这解决了我的问题 :) - MattWeiler

Answer 4

以下代码对我起作用。

@Bean
public YourClassImpl yourClassImpl(Jaxb2Marshaller marshaller, HttpComponentsMessageSender  httpComponentsMessageSender) {
    YourClassImpl client = new YourClassImpl();
    client.setDefaultUri(PiiProperties.SOAP_ACTION.getValue());
    client.setMarshaller(marshaller);
    client.setUnmarshaller(marshaller);
    client.setMessageSender(httpComponentsMessageSender);
    return client;
}

@Bean
public HttpComponentsMessageSender httpComponentsMessageSender() {     
    HttpComponentsMessageSender sender = new HttpComponentsMessageSender();
    sender.setReadTimeout(1000);
    sender.setConnectionTimeout(1000);
    return sender;
}

- Sreekanth

Answer 5

如果您想获得这种控制权，您可以：

• 要么切换到使用Jakarta Commons HttpClient的CommonsHttpMessageSender
• 要么子类化HttpUrlConnectionMessageSender，并在prepareConnection(HttpURLConnection)方法中调用UrlConnection.setReadTimeOut(int)

- Sean Patrick Floyd

---

那么，WebServiceTemplate甚至没有默认的超时时间？调用可以有效多长时间？ - Sai Kumar

能否针对每个请求设置超时时间？这样我们就可以在运行时调整超时时间。 - Renan Mozone

Answer 6

这就是我做的方法：

@Configuration
public class MunisServiceConfig {

    @Value("${service.uri}")
    private String soapUri;

    @Bean
    Jaxb2Marshaller jaxb2Marshaller() {
        Jaxb2Marshaller jaxb2Marshaller = new Jaxb2Marshaller();
        jaxb2Marshaller.setContextPath(CheckStatePayment.class.getPackage().getName());

        return jaxb2Marshaller;
    }

    @Bean
    public WebServiceTemplate munisService() {
        WebServiceTemplate template = new WebServiceTemplate();

        template.setMarshaller(jaxb2Marshaller());
        template.setUnmarshaller(jaxb2Marshaller());

        template.setDefaultUri(soapUri);

        HttpComponentsMessageSender httpComponentsMessageSender = new HttpComponentsMessageSender();
        httpComponentsMessageSender.setReadTimeout(3000);
        httpComponentsMessageSender.setConnectionTimeout(5000);
        template.setMessageSender(httpComponentsMessageSender);

        return template;
    }

}

- Sarvar Nishonboyev

Answer 7

这篇文章可能会帮助您解决问题： http://onebyteatatime.wordpress.com/2009/03/19/how-to-set-socket-timeout-using-spring-webservicetemplate/ 我使用的实现方式是，定义了一个WebServiceTemplate来使用CommonsHttpMessageSender：

<bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
        <constructor-arg ref="messageFactory" />
        <property name="messageSender">
            <bean
                class="org.springframework.ws.transport.http.CommonsHttpMessageSender">
            </bean>
        </property>
</bean>

接着，在代码中，我获取了messageSender并设置了它的超时时间。你同样可以在你的xml文件中完成这个操作。

CommonsHttpMessageSender messageSender = (CommonsHttpMessageSender)webServiceTemplate.getMessageSenders()[0];
messageSender.getHttpClient().getParams().setSoTimeout(timeoutMillis);

- Paul Adamson

Answer 8

这段代码适用于 Spring Boot（验证版本为2.1.5.RELEASE）：

@Configuration
public class ExampleServiceClientConfiguration {

    @Value("${example-service.uri}")
    private String exampleServiceUri;

    @Value("${example-service.timeout:120}")
    private int exampleServiceTimeout;

    @Bean
    public ExampleServiceClient exampleServiceClient() {
        ExampleServiceClient client = new ExampleServiceClient();
        client.setMessageSender(httpUrlConnectionMessageSender());
        client.setDefaultUri(exampleServiceUri);
        client.setMarshaller(marshaller());
        client.setUnmarshaller(marshaller());
        return client;
    }

    @Bean
    HttpUrlConnectionMessageSender httpUrlConnectionMessageSender() {
        HttpUrlConnectionMessageSender sender = new HttpUrlConnectionMessageSender();
        Duration timeout = Duration.ofSeconds(exampleServiceTimeout);
        sender.setReadTimeout(timeout);
        sender.setConnectionTimeout(timeout);
        return sender;
    }

    @Bean
    public Jaxb2Marshaller marshaller() {
        Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
        marshaller.setContextPath(ObjectFactory.class.getPackageName());
        return marshaller;
    }
}

- Bunarro

---

类似这样的代码也适用于Spring Boot：var messageSender = new HttpWebServiceMessageSenderBuilder().setReadTimeout(properties.getHttpReadTimeout()).setConnectTimeout(properties.getHttpConnectTimeout()).build(); return builder.setMarshaller(marshaller) .setUnmarshaller(marshaller).additionalMessageSenders(messageSender).build();其中builder来自于WebServiceTemplateBuilder。 - Julius Krah

Answer 9

对于CommonsHttpMessageSender，我们可以按照以下方式设置超时时间：

<bean id="httpParams" class="org.apache.commons.httpclient.params.HttpClientParams">
  <!-- Timeout in milliseconds: in this case 1 minute -->
  <property name="soTimeout" value="60000" />
</bean>

<bean id="httpClient" class="org.apache.commons.httpclient.HttpClient">
    <property name="params" ref="httpParams" />
</bean>

<!-- Define the message sender used by all web service templates -->
<bean id="webServiceMessageSender" class="org.springframework.ws.transport.http.CommonsHttpMessageSender">
    <constructor-arg>
        <ref bean="httpClient"/>
    </constructor-arg>
</bean>

请参考以下内容并引用webServiceMessageSender：

<bean id="genericWebServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
       <property name="messageSender" ref="webServiceMessageSender"/>
</bean>

- Uresh K