Spring Boot REST API - 请求超时？

Question

我有一个 Spring Boot REST 服务，它有时会在请求中调用第三方服务。我想为我的所有资源设置一个超时时间（比如说 5 秒），这样如果任何请求处理（整个链，从传入到响应）花费的时间超过 5 秒，我的控制器就会使用 HTTP 503 而不是实际响应进行响应.如果这只是一个 Spring 属性，那就太棒了，例如设置

spring.mvc.async.request-timeout=5000

但我没有任何运气。我也尝试过扩展 WebMvcConfigurationSupport 并覆盖 configureAsyncSupport：

@Override
public void configureAsyncSupport(final AsyncSupportConfigurer configurer) {
    configurer.setDefaultTimeout(5000);
    configurer.registerCallableInterceptors(timeoutInterceptor());
}

@Bean
public TimeoutCallableProcessingInterceptor timeoutInterceptor() {
    return new TimeoutCallableProcessingInterceptor();
}

运气不好。

我怀疑我必须手动为所有第三方调用计时，如果调用时间过长，则抛出超时异常。那正确吗？或者是否有任何更简单、更全面的解决方案涵盖我的所有请求端点？

Answer 1

如果你想让spring.mvc.async.request-timeout=5000 工作，你需要返回一个Callable<>。

@RequestMapping(method = RequestMethod.GET)
public Callable<String> getFoobar() throws InterruptedException {
    return new Callable<String>() {
        @Override
        public String call() throws Exception {
            Thread.sleep(8000); //this will cause a timeout
            return "foobar";
        }
    };
}

Answer 2

@Transactional 注解带有一个超时参数，您可以在其中为@RestController 中的特定方法指定超时（以秒为单位）

@RequestMapping(value = "/method",
    method = RequestMethod.POST,
    produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
@Transactional(timeout = 120)

Answer 3

Spring Boot 2.2 需要一个全新的答案，因为 server.connection-timeout=5000 已弃用。每个服务器的行为都不同，因此建议使用特定于服务器的属性。

SpringBoot 默认嵌入 Tomcat，如果您没有使用 Jetty 或其他东西重新配置它。 使用特定于服务器的应用程序属性，例如 server.tomcat.connection-timeout 或 server.jetty.idle-timeout。

正如Wilkinson评论的那样：

设置连接超时只会导致超时 客户端连接但太慢而无法发送其请求。如果你想 客户端最多等待 30 秒的响应，您将 必须在客户端进行配置。如果你想要服务器端 最多只花费 30 秒处理请求没有 保证您不能强制正在处理的线程的方法 请求停止。

你也可以尝试设置spring.mvc.async.request-timeout

Answer 4

我建议您查看 Spring Cloud Netflix Hystrix 启动器，以处理可能不可靠/缓慢的远程调用。它实现了断路器模式，正是为这种事情而设计的。

见offcial docs for more information。

Answer 5

您可以在 application.properties 中尝试server.connection-timeout=5000。来自official documentation：

server.connection-timeout= # 连接器将连接的时间（以毫秒为单位） 在关闭连接之前等待另一个 HTTP 请求。没有的时候 设置后，将使用连接器特定于容器的默认值。用一个 值为 -1 表示没有（即无限）超时。

另一方面，您可能希望使用断路器模式在客户端处理超时，正如我在此处的回答中已经描述的那样：https://stackoverflow.com/a/44484579/2328781

Answer 6

如果您使用的是 RestTemplate，那么您应该使用以下代码来实现超时

@Bean
public RestTemplate restTemplate() {
    return new RestTemplate(clientHttpRequestFactory());
}

private ClientHttpRequestFactory clientHttpRequestFactory() {
    HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
    factory.setReadTimeout(2000);
    factory.setConnectTimeout(2000);
    return factory;
}}

xml配置

<bean class="org.springframework.web.client.RestTemplate">
<constructor-arg>
    <bean class="org.springframework.http.client.HttpComponentsClientHttpRequestFactory"
        p:readTimeout="2000"
        p:connectTimeout="2000" />
</constructor-arg>

Answer 7

在 Spring 属性文件中，您不能只为该属性指定一个数字。您还需要指定一个单位。所以你可以说spring.mvc.async.request-timeout=5000ms 或spring.mvc.async.request-timeout=5s，两者都会给你一个5 秒的超时时间。

Answer 8

我觉得没有一个答案能真正解决问题。我认为您需要告诉 Spring Boot 的嵌入式服务器处理请求的最长时间应该是多少。我们如何做到这一点取决于所使用的嵌入式服务器的类型。

如果是 Undertow，可以这样做：

@Component
class WebServerCustomizer : WebServerFactoryCustomizer<UndertowServletWebServerFactory> {
    override fun customize(factory: UndertowServletWebServerFactory) {
        factory.addBuilderCustomizers(UndertowBuilderCustomizer {
            it.setSocketOption(Options.READ_TIMEOUT, 5000)
            it.setSocketOption(Options.WRITE_TIMEOUT, 25000)
        })
    }
}

Spring Boot 官方文档：https://docs.spring.io/spring-boot/docs/2.2.0.RELEASE/reference/html/howto.html#howto-configure-webserver

Answer 9

您可以为 Springboot REST 服务配置异步线程执行器。 setKeepAliveSeconds() 应该考虑请求链的执行时间。设置 ThreadPoolExecutor 的 keep-alive 秒数。默认值为 60。可以在运行时修改此设置，例如通过 JMX。

@Bean(name="asyncExec")
public Executor asyncExecutor()
{
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(3);
    executor.setMaxPoolSize(3);
    executor.setQueueCapacity(10);
    executor.setThreadNamePrefix("AsynchThread-");
    executor.setAllowCoreThreadTimeOut(true);
    executor.setKeepAliveSeconds(10);
    executor.initialize();

    return executor;
}

然后您可以如下定义您的 REST 端点

@Async("asyncExec")
@PostMapping("/delayedService")
public CompletableFuture<String> doDelay()
{ 
    String response = service.callDelayedService();
    return CompletableFuture.completedFuture(response);
}