如何在Spring Boot REST API上设置超时？

Question

我有一些可能需要一段时间才能执行的REST API，我想限制它们的执行持续时间。优选地，如果30秒过去了并且请求没有返回，我希望返回特定的HTTP代码/数据并完全终止该请求。

当前代码：

@RestController
@CrossOrigin(origins = {"*"}, maxAge = 4800, allowCredentials = "false")
public class APIController {

@RequestMapping(value = "/api/myapifunc", method = RequestMethod.POST, produces = "application/json")
public ResponseEntity<?> optimize(@RequestParam(value="param1", defaultValue="")) {
    // Code here
}

Answer 1

@RequestMapping(value = "/api/myapifunc", method = RequestMethod.POST, produces = 
"application/json")
public ResponseEntity<?> optimize(@RequestParam(value="param1", defaultValue="")) {
 return new Callable<String>() {
    @Override
    public String call() throws Exception {
        Thread.sleep(3000); //this will cause a timeout
        return "foobar";
    }
  };
}

未来你可以使用或注释< code > @ Timed @ Transactional(time out = 3000)

Answer 2

在Spring Boot 2.3/Tomcat 9中，您可以通过安装TomcatStuckThreadDetectionValve为所有传入的HTTP请求设置超时。以下是您需要的Spring配置代码（它是Kotlin）：

import org.apache.catalina.valves.StuckThreadDetectionValve
import org.springframework.beans.factory.annotation.Value
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration
class RequestTimeoutConfiguration(
    @Value("\${app.tomcat.stuck-thread-detection.request-timeout.seconds}")
    private val stuckThreadTimeoutSeconds: Int
) {

    @Bean
    fun stuckThreadDetectionValve() =
        StuckThreadDetectionValve().apply {
            threshold = stuckThreadTimeoutSeconds
            interruptThreadThreshold = stuckThreadTimeoutSeconds
        }

    @Bean
    fun stuckThreadDetectionWebServerFactoryCustomizer(valve: StuckThreadDetectionValve) =
        WebServerFactoryCustomizer { factory: TomcatServletWebServerFactory ->
            factory.addContextValves(valve)
        }
}

然后你只需要application.properties中的属性来控制它：

app.tomcat.stuck-thread-detection.request-timeout.seconds=130

Answer 3

看起来您正在描述断路器模式。如果您可以控制客户端和服务器代码，并且想要探索Spring Cloud和NetflixHysterix库，您可以查看入门：断路器指南。

如果您使用Apache Tomcat作为您的servlet容器，您可以配置卡住的线程检测阀：

这个阀门允许检测需要很长时间处理的请求，这可能表明正在处理它的线程被阻塞了。此外，它可以选择性地中断这些线程，以尝试并解除对它们的阻塞。

当检测到这样的请求时，其线程的当前堆栈跟踪将写入具有WARN级别的Tomcat日志。

卡住线程的ID和名称可通过JMX在StuckThreadID和stuckThreadNames属性中获得。这些ID可以与标准线程JVM MBean（java.lang:type=Threading）一起使用，以检索关于每个卡住线程的其他信息。