Spring RestTemplate หมดเวลา

ฉันต้องการตั้งค่าระยะหมดเวลาการเชื่อมต่อสำหรับบริการพักที่แอปพลิเคชันเว็บของฉันใช้ ฉันใช้ RestTemplate ของ Spring เพื่อพูดคุยกับบริการของฉัน ฉันได้ทำการค้นคว้าและพบและใช้ xml ด้านล่าง (ใน xml แอปพลิเคชันของฉัน) ซึ่งฉันเชื่อว่ามีไว้เพื่อตั้งค่าการหมดเวลา ฉันใช้ Spring 3.0

ฉันยังพบปัญหาเดียวกันที่นี่การกำหนดค่าการหมดเวลาสำหรับ Spring webservices ด้วย RestTemplateแต่โซลูชันดูเหมือนจะไม่สะอาดฉันต้องการตั้งค่าการหมดเวลาผ่าน Spring config

<bean id="RestOperations" class="org.springframework.web.client.RestTemplate">
    <constructor-arg>

      <bean class="org.springframework.http.client.CommonsClientHttpRequestFactory">
        <property name="readTimeout" value="${restURL.connectionTimeout}" />
      </bean>
    </constructor-arg>
</bean>

ดูเหมือนว่าอะไรก็ตามที่ฉันตั้งค่า readTimeout เป็นฉันจะได้รับสิ่งต่อไปนี้:

สายเคเบิลเครือข่ายถูกตัดการเชื่อมต่อ: รอประมาณ 20 วินาทีและรายงานข้อยกเว้นต่อไปนี้:

org.springframework.web.client.ResourceAccessExcep ข้อผิดพลาด I / O: ไม่มีเส้นทางไปยังโฮสต์: เชื่อมต่อ; ข้อยกเว้นที่ซ้อนกันคือ java.net.NoRouteToHostException: ไม่มีเส้นทางไปยังโฮสต์: เชื่อมต่อ

URL ไม่ถูกต้องดังนั้น 404 จึงถูกส่งกลับโดย rest service: รอประมาณ 10 วินาทีและรายงานข้อยกเว้นต่อไปนี้:

org.springframework.web.client.HttpClientErrorException: ไม่พบ 404

ข้อกำหนดของฉันต้องการการหมดเวลาที่สั้นลงดังนั้นฉันจึงต้องสามารถเปลี่ยนแปลงสิ่งเหล่านี้ได้ มีความคิดเกี่ยวกับสิ่งที่ฉันทำผิดหรือไม่?

ขอบคุณมาก.

สำหรับSpring Boot> = 1.4

@Configuration
public class AppConfig
{
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) 
    {
        return restTemplateBuilder
           .setConnectTimeout(...)
           .setReadTimeout(...)
           .build();
    }
}

สำหรับSpring Boot <= 1.3

@Configuration
public class AppConfig
{
    @Bean
    @ConfigurationProperties(prefix = "custom.rest.connection")
    public HttpComponentsClientHttpRequestFactory customHttpRequestFactory() 
    {
        return new HttpComponentsClientHttpRequestFactory();
    }

    @Bean
    public RestTemplate customRestTemplate()
    {
        return new RestTemplate(customHttpRequestFactory());
    }
}

จากนั้นในไฟล์ application.properties

custom.rest.connection.connection-request-timeout=...
custom.rest.connection.connect-timeout=...
custom.rest.connection.read-timeout=...

งานนี้เพราะHttpComponentsClientHttpRequestFactoryมี setters สาธารณะconnectionRequestTimeout, connectTimeoutและreadTimeoutและ@ConfigurationPropertiesชุดพวกเขาสำหรับคุณ

สำหรับSpring 4.1 หรือ Spring 5 ที่ไม่มี Spring Boot ให้ใช้@ConfigurationแทนXML

@Configuration
public class AppConfig
{
    @Bean
    public RestTemplate customRestTemplate()
    {
        HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
        httpRequestFactory.setConnectionRequestTimeout(...);
        httpRequestFactory.setConnectTimeout(...);
        httpRequestFactory.setReadTimeout(...);

        return new RestTemplate(httpRequestFactory);
    }
}

ในที่สุดฉันก็ทำงานนี้ได้

ฉันคิดว่าความจริงที่ว่าโครงการของเรามีโถ commons-httpclient สองเวอร์ชันที่แตกต่างกันไม่ได้ช่วยอะไร เมื่อฉันเรียงลำดับแล้วฉันพบว่าคุณสามารถทำได้สองอย่าง ...

ในโค้ดคุณสามารถใส่สิ่งต่อไปนี้:

HttpComponentsClientHttpRequestFactory rf =
    (HttpComponentsClientHttpRequestFactory) restTemplate.getRequestFactory();
rf.setReadTimeout(1 * 1000);
rf.setConnectTimeout(1 * 1000);

ครั้งแรกที่เรียกรหัสนี้จะกำหนดระยะหมดเวลาสำหรับHttpComponentsClientHttpRequestFactoryคลาสที่ใช้โดยRestTemplate. ดังนั้นการโทรที่ตามมาทั้งหมดRestTemplateจะใช้การตั้งค่าการหมดเวลาที่กำหนดไว้ข้างต้น

หรือทางเลือกที่ดีกว่าคือทำสิ่งนี้:

<bean id="RestOperations" class="org.springframework.web.client.RestTemplate">
    <constructor-arg>
        <bean class="org.springframework.http.client.HttpComponentsClientHttpRequestFactory">
            <property name="readTimeout" value="${application.urlReadTimeout}" />
            <property name="connectTimeout" value="${application.urlConnectionTimeout}" />
        </bean>
    </constructor-arg>
</bean>

ที่ฉันใช้RestOperationsอินเทอร์เฟซในโค้ดของฉันและรับค่าการหมดเวลาจากไฟล์คุณสมบัติ

คำถามนี้เป็นลิงก์แรกสำหรับการค้นหา Spring Boot ดังนั้นจึงเป็นการดีที่จะนำวิธีการแก้ปัญหาที่แนะนำในเอกสารอย่างเป็นทางการมาที่นี่ Spring Boot มีRestTemplateBuilder ของถั่วที่สะดวกสบายของตัวเอง:

@Bean
public RestTemplate restTemplate(
        RestTemplateBuilder restTemplateBuilder) {

    return restTemplateBuilder
            .setConnectTimeout(Duration.ofSeconds(500))
            .setReadTimeout(Duration.ofSeconds(500))
            .build();
}

การสร้างอินสแตนซ์ RestTemplate ด้วยตนเองเป็นแนวทางที่อาจเป็นปัญหาได้เนื่องจากถั่วที่กำหนดค่าอัตโนมัติอื่น ๆ จะไม่ถูกแทรกเข้าไปในอินสแตนซ์ที่สร้างขึ้นด้วยตนเอง

นี่คือ 2 เซ็นต์ของฉัน ไม่มีอะไรใหม่ แต่มีคำอธิบายการปรับปรุงและโค้ดที่ใหม่กว่า

ตามค่าเริ่มต้นRestTemplateหมดเวลาไม่สิ้นสุด การหมดเวลามีสองประเภท ได้แก่ การหมดเวลาการเชื่อมต่อและการหมดเวลาอ่าน ตัวอย่างเช่นฉันสามารถเชื่อมต่อกับเซิร์ฟเวอร์ได้ แต่ไม่สามารถอ่านข้อมูลได้ แอปพลิเคชันหยุดทำงานและคุณไม่ทราบว่าเกิดอะไรขึ้น

ฉันจะใช้คำอธิบายประกอบซึ่งสมัยนี้เป็นที่ต้องการมากกว่า XML

@Configuration
public class AppConfig {

    @Bean
    public RestTemplate restTemplate() {

        var factory = new SimpleClientHttpRequestFactory();

        factory.setConnectTimeout(3000);
        factory.setReadTimeout(3000);

        return new RestTemplate(factory);
    }
}

ที่นี่เราใช้SimpleClientHttpRequestFactoryเพื่อตั้งค่าการเชื่อมต่อและการอ่านค่าเวลา RestTemplateมันเป็นเรื่องที่ผ่านไปแล้วคอนสตรัคของ

@Configuration
public class AppConfig {

    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {

        return builder
                .setConnectTimeout(Duration.ofMillis(3000))
                .setReadTimeout(Duration.ofMillis(3000))
                .build();
    }
}

ในวิธีที่สองเราใช้ไฟล์RestTemplateBuilder. Durationนอกจากนี้ยังทราบพารามิเตอร์ของทั้งสองวิธีที่พวกเขาใช้ ขณะนี้วิธีการที่มากเกินไปซึ่งใช้เวลามิลลิวินาทีโดยตรงจะเลิกใช้แล้ว

แก้ไข ทดสอบด้วย Spring Boot 2.1.0 และ Java 11

นี่เป็นวิธีง่ายๆในการตั้งค่าระยะหมดเวลา:

RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());

private ClientHttpRequestFactory getClientHttpRequestFactory() {
    int timeout = 5000;
    HttpComponentsClientHttpRequestFactory clientHttpRequestFactory =
      new HttpComponentsClientHttpRequestFactory();
    clientHttpRequestFactory.setConnectTimeout(timeout);
    return clientHttpRequestFactory;
}

ฉันมีสถานการณ์ที่คล้ายกัน แต่ก็จำเป็นต้องตั้งค่า Proxy ด้วย วิธีที่ง่ายที่สุดที่ฉันสามารถทำได้คือการขยายSimpleClientHttpRequestFactoryเพื่อความสะดวกในการตั้งค่าพร็อกซี (พร็อกซีที่แตกต่างกันสำหรับ non-prod vs prod) สิ่งนี้ยังคงใช้ได้แม้ว่าคุณจะไม่ต้องการพร็อกซีก็ตาม จากนั้นในคลาสเพิ่มเติมของฉันฉันจะแทนที่openConnection(URL url, Proxy proxy)เมธอดโดยใช้เหมือนกับซอร์สแต่เพียงแค่ตั้งค่าระยะหมดเวลาก่อนที่จะกลับมา

@Override
protected HttpURLConnection openConnection(URL url, Proxy proxy) throws IOException {
    URLConnection urlConnection = proxy != null ? url.openConnection(proxy) : url.openConnection();
    Assert.isInstanceOf(HttpURLConnection.class, urlConnection);
    urlConnection.setConnectTimeout(5000);
    urlConnection.setReadTimeout(5000);
    return (HttpURLConnection) urlConnection;
}

หากต้องการขยายคำตอบของ benscabbia :

private RestTemplate restCaller = new RestTemplate(getClientHttpRequestFactory());

private ClientHttpRequestFactory getClientHttpRequestFactory() {
    int connectionTimeout = 5000; // milliseconds
    int socketTimeout = 10000; // milliseconds
    RequestConfig config = RequestConfig.custom()
      .setConnectTimeout(connectionTimeout)
      .setConnectionRequestTimeout(connectionTimeout)
      .setSocketTimeout(socketTimeout)
      .build();
    CloseableHttpClient client = HttpClientBuilder
      .create()
      .setDefaultRequestConfig(config)
      .build();
    return new HttpComponentsClientHttpRequestFactory(client);
}

1. การหมดเวลา RestTemplate ด้วย SimpleClientHttpRequestFactory หากต้องการแทนที่คุณสมบัติการหมดเวลาโดยทางโปรแกรมเราสามารถปรับแต่งคลาส SimpleClientHttpRequestFactory ดังต่อไปนี้

แทนที่การหมดเวลาด้วย SimpleClientHttpRequestFactory

//Create resttemplate
RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());

//Override timeouts in request factory
private SimpleClientHttpRequestFactory getClientHttpRequestFactory() 
{
    SimpleClientHttpRequestFactory clientHttpRequestFactory
                      = new SimpleClientHttpRequestFactory();
    //Connect timeout
    clientHttpRequestFactory.setConnectTimeout(10_000);

    //Read timeout
    clientHttpRequestFactory.setReadTimeout(10_000);
    return clientHttpRequestFactory;
}

2. การหมดเวลา RestTemplate ด้วย HttpComponentsClientHttpRequestFactory SimpleClientHttpRequestFactory ช่วยในการตั้งค่าการหมดเวลา แต่มีข้อ จำกัด ในการทำงานและอาจไม่เพียงพอในแอปพลิเคชันแบบเรียลไทม์ ในโค้ดการผลิตเราอาจต้องการใช้ HttpComponentsClientHttpRequestFactory ซึ่งรองรับไลบรารีไคลเอ็นต์ HTTP พร้อมกับรีเฟรชเพลท

HTTPClient มีคุณสมบัติที่เป็นประโยชน์อื่น ๆ เช่นพูลการเชื่อมต่อการจัดการการเชื่อมต่อที่ไม่ได้ใช้งานเป็นต้น

อ่านเพิ่มเติม: ตัวอย่างการกำหนดค่า Spring RestTemplate + HttpClient

แทนที่การหมดเวลาด้วย HttpComponentsClientHttpRequestFactory

//Create resttemplate
RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());

//Override timeouts in request factory
private SimpleClientHttpRequestFactory getClientHttpRequestFactory() 
{
    HttpComponentsClientHttpRequestFactory clientHttpRequestFactory
                      = new HttpComponentsClientHttpRequestFactory();
    //Connect timeout
    clientHttpRequestFactory.setConnectTimeout(10_000);

    //Read timeout
    clientHttpRequestFactory.setReadTimeout(10_000);
    return clientHttpRequestFactory;
}

การอ้างอิง: ตัวอย่างการกำหนดค่าการหมดเวลา Spring RestTemplate