springboot接口超时配置过程及异常处理方式

SpringBoot控制接口超时设置

处理接口超时，其实就三个关键步骤：配置、接口定义和异常处理。弄明白这三步，你就能轻松掌控请求的“生命线”。

1. 配置

首先，我们得在配置文件中把超时的规矩定下来。SpringBoot为此提供了清晰的配置项。

spring:
  mvc:
    async:
      request-timeout: 2000 //单位是毫秒哦 2000代表2秒

不过，光配置上还不够。有时候你会发现，明明配了2秒超时，但请求好像“无视”了这个限制？别急，问题通常出在接口的写法上。

关键在于，这个配置生效的前提，是你的接口必须遵循特定的异步规范。如果接口本身是同步的，这个超时设置是不会起作用的。

2. 接口定义

想让配置的超时时间真正发挥作用，接口的写法有两点核心要求。

第一，它必须是异步的。这意味着处理逻辑会被分配到一个独立的线程中去执行，主线程不会被阻塞。

第二，方法的返回值必须是Callable类型，其中的泛型T就是你实际要返回的数据类型。下面是一个标准的示例：

/**
 * 设置超时用的测试接口.通常如下写法
 *
 * @return 返回值一定是Callable的.
 */
@GetMapping("/test")
public Callable timeOutMethod() {
    //new Callable<> 单独开启一个线程去执行
    return new Callable() {
        @Override
        public ResultVO call() throws Exception {
            //这里将会触发超时
            Thread.sleep(10000);
            //正常返回逻辑
            return ResultVO.response(ReturnEnum.PAY_TOP_UP_ORDER, String.valueOf(new IdWorker().nextId()));
        }
    };
}

看上面的代码，Thread.sleep(10000)模拟了一个耗时10秒的操作，而我们配置的超时时间是2秒。这样一来，超时机制就会被触发。

3. 异常处理

超时发生后，系统会抛出AsyncRequestTimeoutException异常。为了让前端或调用方获得清晰友好的提示，而不是一堆晦涩的错误栈，我们需要统一捕获并处理这个异常。

利用Spring的@ControllerAdvice注解，我们可以定义一个全局异常处理器：

@ControllerAdvice //所有的Controller都会进入到这个类?
public class BaseExceptionAdvice {

    @ExceptionHandler(AsyncRequestTimeoutException.class)
    public ResponseEntity handException(AsyncRequestTimeoutException e) {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("timestamp", DateTime.now().toString("yyyy-MM-dd HH:mm:ss"));
        jsonObject.put("status", 500);
        jsonObject.put("message","接口超时");
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(jsonObject);
    }
    //往下还可以写很多的异常统一处理方法.上面只是写了超时异常的处理,其它无关主题的省略了.
}

这样，一旦接口执行超时，客户端就会收到一个结构化的JSON响应，明确告知“接口超时”，以及发生的时间戳和状态码。

测试结果

经过上述三步配置和编码后，当接口处理时间超过设定阈值，前端便会收到一个清晰友好的超时错误提示。

总结

总而言之，在SpringBoot中有效设置接口超时，是一个环环相扣的过程：先在配置文件里设定时间，再按照异步规范编写返回Callable的接口，最后别忘了全局捕获AsyncRequestTimeoutException异常以提供友好反馈。掌握这套“组合拳”，你就能游刃有余地管理后端服务的响应时长了。