Spring Boot REST API - request timeout

Question

I have a Spring Boot REST service that sometimes call third party services as a part of a request  I would like to set a timeout on all my resources  let s say 5 seconds   so that if any request handling  the whole chain  from incoming to response  takes longer than 5 seconds my controllers responds with HTTP 503 instead of the actual response  It would be awesome if this was just a Spring property  for example setting   spring mvc async request-timeout 5000   but I haven t had any luck with that  I ve also tried extending WebMvcConfigurationSupport and overriding configureAsyncSupport    Override public void configureAsyncSupport final AsyncSupportConfigurer configurer        configurer setDefaultTimeout 5000       configurer registerCallableInterceptors timeoutInterceptor         Bean public TimeoutCallableProcessingInterceptor timeoutInterceptor         return new TimeoutCallableProcessingInterceptor        without any luck   I suspect I have to manually time all my third party calls  and if they take too long  throw a timeout exception  Is that right  Or is there any easier  holistic solution that covers all my request endpoints

User · Answer

You can try server connection-timeout 5000 in your application properties  From the official documentation      server connection-timeout    Time in milliseconds that connectors will   wait for another HTTP request before closing the connection  When not   set  the connector s container-specific default will be used  Use a   value of -1 to indicate no  i e  infinite  timeout    On the other hand  you may want to handle timeouts on the client side using Circuit Breaker pattern as I have already described in my answer here  https   stackoverflow com a 44484579 2328781

User · Answer

I would suggest you have a look at the Spring Cloud Netflix Hystrix starter to handle potentially unreliable slow remote calls  It implements the Circuit Breaker pattern  that is intended for precisely this sorta thing   See offcial docs for more information

User · Answer

A fresh answer for Spring Boot 2 2 is required as server connection-timeout 5000 is deprecated  Each server behaves differently  so server specific properties are recommended instead   SpringBoot embeds Tomcat by default  if you haven t reconfigured it with Jetty or something else  Use server specific application properties like server tomcat connection-timeout or server jetty idle-timeout

User · Answer

The  Transactional annotation takes a timeout parameter where you can specify timeout in seconds for a specific method in the  RestController  RequestMapping value    quot  method quot       method   RequestMethod POST      produces   MediaType APPLICATION JSON VALUE   Timed  Transactional timeout   120

User · Answer

You can configure the Async thread executor for your Springboot REST services  The setKeepAliveSeconds   should consider the execution time for the requests chain  Set the ThreadPoolExecutor s keep-alive seconds  Default is 60  This setting can be modified at runtime  for example through 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      Then you can define your REST endpoint as follows   Async  asyncExec    PostMapping   delayedService   public CompletableFuture lt String gt  doDelay          String response   service callDelayedService        return CompletableFuture completedFuture response

User · Answer

if you are using RestTemplate than you should use following code to implement timeouts   Bean public RestTemplate restTemplate         return new RestTemplate clientHttpRequestFactory        private ClientHttpRequestFactory clientHttpRequestFactory         HttpComponentsClientHttpRequestFactory factory   new HttpComponentsClientHttpRequestFactory        factory setReadTimeout 2000       factory setConnectTimeout 2000       return factory       The xml configuration   lt bean class  org springframework web client RestTemplate  gt   lt constructor-arg gt       lt bean class  org springframework http client HttpComponentsClientHttpRequestFactory          p readTimeout  2000          p connectTimeout  2000    gt   lt  constructor-arg gt

User · Answer

I feel like none of the answers really solve the issue  I think you need to tell the embedded server of Spring Boot what should be the maximum time to process a request  How exactly we do that is dependent on the type of the embedded server used   In case of Undertow  one can do this    Component class WebServerCustomizer   WebServerFactoryCustomizer lt UndertowServletWebServerFactory gt        override fun customize factory  UndertowServletWebServerFactory            factory addBuilderCustomizers UndertowBuilderCustomizer               it setSocketOption Options READ TIMEOUT  5000              it setSocketOption Options WRITE TIMEOUT  25000                       Spring Boot official doc  https   docs spring io spring-boot docs 2 2 0 RELEASE reference html howto html howto-configure-webserver

User · Answer

You need to return a Callable lt  gt  if you want spring mvc async request-timeout 5000 to work    RequestMapping method   RequestMethod GET  public Callable lt String gt  getFoobar   throws InterruptedException       return new Callable lt String gt               Override         public String call   throws Exception               Thread sleep 8000     this will cause a timeout             return  foobar

User · Answer

In Spring properties files  you can t just specify a number for this property  You also need to specify a unit  So you can say spring mvc async request-timeout 5000ms or spring mvc async request-timeout 5s  both of which will give you a 5-second timeout

[java] Spring Boot REST API - request timeout?

Examples related to java

Examples related to spring

Examples related to rest

Examples related to spring-boot

Examples related to timeout