Spring Boot如何为单个REST调用及Feign方法单独设置超时时间

Spring Boot Starter Web作为HTTP客户端发REST请求时，全局配置的超时会作用于所有请求，要给单个调用设置独立超时，根据你用的客户端API选择对应实现即可：

基于RestClient实现（Spring 6+/Spring Boot 3+官方推荐客户端） #

直接在单次调用前构建专属的RestClient实例，指定自定义超时，不会影响全局注入的RestClient默认配置：

@Autowired
private RestClient.Builder restClientBuilder;

public byte[] callSlowExportApi() {
    // 仅为当前请求构建专属客户端，设置连接超时3s、读取超时60s
    RestClient singleCallClient = restClientBuilder
            .requestFactory(SimpleClientHttpRequestFactory::new)
            .setConnectTimeout(Duration.ofSeconds(3))
            .setReadTimeout(Duration.ofSeconds(60))
            .build();

    return singleCallClient.get()
            .uri("https://your-business-api/export/large-data")
            .retrieve()
            .body(byte[].class);
}

如果你底层替换了Apache HttpClient、OkHttp作为HTTP实现，把SimpleClientHttpRequestFactory替换为对应客户端的请求工厂类，按对应API设置超时参数即可。

基于RestTemplate实现（传统Spring Boot版本通用） #

RestTemplate本身没有提供单次请求修改超时的API，针对特殊调用单独创建专属RestTemplate实例即可，不要把这个实例注入Spring容器，避免覆盖全局配置：

public byte[] callSlowExportApiWithRestTemplate() {
    SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
    requestFactory.setConnectTimeout(3000); // 连接超时3s
    requestFactory.setReadTimeout(60000); // 读取超时60s
    RestTemplate singleCallTemplate = new RestTemplate(requestFactory);

    return singleCallTemplate.getForObject("https://your-business-api/export/large-data", byte[].class);
}

Spring Cloud OpenFeign支持两种方式实现方法级别的独立超时配置，不需要修改全局默认值：

配置文件直接配置（Spring Cloud 2020.0.0及以上版本支持，无代码侵入） #

直接在application.yml/application.properties中按方法全路径指定超时参数即可，优先级高于Feign客户端的全局配置。
比如你有如下Feign接口：

@FeignClient(name = "order-service")
public interface OrderClient {
    @GetMapping("/order/detail")
    Order getOrderDetail(Long orderId);

    @GetMapping("/order/export/all")
    byte[] exportAllOrder(String startDate, String endDate);
}

要给exportAllOrder方法单独设置超时，直接添加如下配置：

feign:
  client:
    config:
      order-service: # 对应@FeignClient注解上的name值
        # 格式：接口全限定名#方法名(参数类型全类名列表)
        com.your.project.feign.OrderClient#exportAllOrder(String,String):
          connectTimeout: 5000 # 连接超时5s
          readTimeout: 120000 # 读取超时2分钟，不影响同个Feign客户端下的其他方法

自定义注解+拦截器实现（兼容所有Spring Cloud版本） #

如果你的项目Spring Cloud版本较低不支持方法级配置，可以通过自定义注解+请求拦截器实现：

• 定义超时标记注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomFeignTimeout {
    int connectTimeout() default 1000;
    int readTimeout() default 5000;
}

• 在需要自定义超时的Feign方法上添加注解

@FeignClient(name = "order-service")
public interface OrderClient {
    @GetMapping("/order/detail")
    Order getOrderDetail(Long orderId);

    @CustomFeignTimeout(connectTimeout = 5000, readTimeout = 120000)
    @GetMapping("/order/export/all")
    byte[] exportAllOrder(String startDate, String endDate);
}

• 编写Feign拦截器，识别注解并注入自定义超时配置

@Component
public class FeignTimeoutInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        Method targetMethod = template.methodMetadata().method();
        CustomFeignTimeout timeoutAnno = targetMethod.getAnnotation(CustomFeignTimeout.class);
        if (timeoutAnno != null) {
            Request.Options customOptions = new Request.Options(
                    timeoutAnno.connectTimeout(), TimeUnit.MILLISECONDS,
                    timeoutAnno.readTimeout(), TimeUnit.MILLISECONDS,
                    true
            );
            template.attr(Request.Options.class.getCanonicalName(), customOptions);
        }
    }
}

内容的提问来源于stack exchange，提问作者Jerry