[#1450] FeignClient support setting method read/connect timeout (#1452) (#1466)

chengyouling · web-flow · commit 45c16ebee1e8 · 2025-04-28T11:25:01.000+08:00
diff --git a/integration-tests/discovery-nacos-tests/discovery-tests-client/src/test/java/com/huaweicloud/sample/GovernanceControllerIT.java b/integration-tests/discovery-nacos-tests/discovery-tests-client/src/test/java/com/huaweicloud/sample/GovernanceControllerIT.java
@@ -381,4 +381,18 @@ public void testServiceNameFaultInjectionConsumerFeign() {
     Assertions.assertEquals(null,
         template.getForObject(orderServiceUrl + "/govern/serviceNameFaultInjectionFeign", String.class));
   }
+
+  @Test
+  public void testFeignRequestTimeoutWithAnnotation() {
+    String result
+        = template.getForObject(orderServiceUrl + "/govern/testFeignRequestTimeoutWithAnnotation", String.class);
+    Assertions.assertTrue(result.contains("Read timed out"));
+  }
+
+  @Test
+  public void testFeignRequestTimeout() {
+    String result
+        = template.getForObject(orderServiceUrl + "/govern/testFeignRequestTimeout", String.class);
+    Assertions.assertEquals("success", result);
+  }
 }
diff --git a/integration-tests/discovery-nacos-tests/order-consumer/src/main/java/com/huaweicloud/sample/FeignService.java b/integration-tests/discovery-nacos-tests/order-consumer/src/main/java/com/huaweicloud/sample/FeignService.java
@@ -25,6 +25,8 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseBody;
 
+import com.huaweicloud.governance.adapters.feign.options.FeignRequestOptions;
+
 import feign.Headers;
 import feign.Param;
 
@@ -75,4 +77,11 @@ public interface FeignService {
   @PostMapping("/testHeaderWithJson")
   @Headers("model: {model}")
   public String testHeaderWithJsonCorrect(@Param("model") String model);
+
+  @GetMapping("/testFeignRequestTimeoutWithAnnotation")
+  @FeignRequestOptions(connectTimeout = 5L, readTimeout = 5L)
+  String testFeignRequestTimeoutWithAnnotation();
+
+  @GetMapping("/testFeignRequestTimeout")
+  String testFeignRequestTimeout();
 }
diff --git a/integration-tests/discovery-nacos-tests/order-consumer/src/main/java/com/huaweicloud/sample/GovernanceController.java b/integration-tests/discovery-nacos-tests/order-consumer/src/main/java/com/huaweicloud/sample/GovernanceController.java
@@ -232,4 +232,22 @@ public String restTemplateInstanceBulkhead() throws Exception {
   public String loadbalance() {
     return feignService.loadbalabce();
   }
+
+  @GetMapping("/testFeignRequestTimeoutWithAnnotation")
+  public String testFeignRequestTimeoutWithAnnotation() {
+    try {
+      return feignService.testFeignRequestTimeoutWithAnnotation();
+    }catch (Exception e) {
+      return e.getMessage();
+    }
+  }
+
+  @GetMapping("/testFeignRequestTimeout")
+  public String testFeignRequestTimeout() {
+    try {
+      return feignService.testFeignRequestTimeout();
+    }catch (Exception e) {
+      return e.getMessage();
+    }
+  }
 }
diff --git a/integration-tests/discovery-nacos-tests/price-provider/src/main/java/com/huaweicloud/sample/GovernanceController.java b/integration-tests/discovery-nacos-tests/price-provider/src/main/java/com/huaweicloud/sample/GovernanceController.java
@@ -148,4 +148,16 @@ public String restTemplateInstanceBulkhead() throws Exception {
   public String loadbalance() {
     return "I am price";
   }
+
+  @RequestMapping("/testFeignRequestTimeoutWithAnnotation")
+  public String testFeignRequestTimeoutWithAnnotation() throws InterruptedException {
+    Thread.sleep(6000);
+    return "success";
+  }
+
+  @RequestMapping("/testFeignRequestTimeout")
+  public String testFeignRequestTimeout() throws InterruptedException {
+    Thread.sleep(6000);
+    return "success";
+  }
 }
diff --git a/integration-tests/discovery-servicecomb-tests/discovery-tests-client/src/test/java/com/huaweicloud/sample/GovernanceControllerIT.java b/integration-tests/discovery-servicecomb-tests/discovery-tests-client/src/test/java/com/huaweicloud/sample/GovernanceControllerIT.java
@@ -480,4 +480,18 @@ public void testTemplateFaultInjection() {
     Assertions.assertEquals(null,
         template.getForObject(orderServiceUrl + "/govern/testTemplateFaultInjection?name=tom", String.class));
   }
+
+  @Test
+  public void testFeignRequestTimeoutWithAnnotation() {
+    String result
+        = template.getForObject(orderServiceUrl + "/govern/testFeignRequestTimeoutWithAnnotation", String.class);
+    Assertions.assertTrue(result.contains("Read timed out"));
+  }
+
+  @Test
+  public void testFeignRequestTimeout() {
+    String result
+        = template.getForObject(orderServiceUrl + "/govern/testFeignRequestTimeout", String.class);
+    Assertions.assertEquals("success", result);
+  }
 }
diff --git a/integration-tests/discovery-servicecomb-tests/order-consumer/src/main/java/com/huaweicloud/sample/FeignService.java b/integration-tests/discovery-servicecomb-tests/order-consumer/src/main/java/com/huaweicloud/sample/FeignService.java
@@ -28,6 +28,8 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseBody;
 
+import com.huaweicloud.governance.adapters.feign.options.FeignRequestOptions;
+
 import feign.Headers;
 import feign.Param;
 
@@ -89,4 +91,11 @@ public interface FeignService {
   @GetMapping("/testDateRequestParam")
   public String testDateRequestParam(@RequestParam(required = false, value = "currentDate")
      Date currentDate);
+
+  @GetMapping("/testFeignRequestTimeoutWithAnnotation")
+  @FeignRequestOptions(connectTimeout = 5L, readTimeout = 5L)
+  String testFeignRequestTimeoutWithAnnotation();
+
+  @GetMapping("/testFeignRequestTimeout")
+  String testFeignRequestTimeout();
 }
diff --git a/integration-tests/discovery-servicecomb-tests/order-consumer/src/main/java/com/huaweicloud/sample/GovernanceController.java b/integration-tests/discovery-servicecomb-tests/order-consumer/src/main/java/com/huaweicloud/sample/GovernanceController.java
@@ -266,4 +266,22 @@ public String testTemplateFaultInjection(@RequestParam String name) {
     restTemplate.getForObject("http://webflux/sayHello?name=tom", String.class);
     return restTemplate.getForObject("http://price/faultInjection", String.class);
   }
+
+  @GetMapping("/testFeignRequestTimeoutWithAnnotation")
+  public String testFeignRequestTimeoutWithAnnotation() {
+    try {
+      return feignService.testFeignRequestTimeoutWithAnnotation();
+    }catch (Exception e) {
+      return e.getMessage();
+    }
+  }
+
+  @GetMapping("/testFeignRequestTimeout")
+  public String testFeignRequestTimeout() {
+    try {
+      return feignService.testFeignRequestTimeout();
+    }catch (Exception e) {
+      return e.getMessage();
+    }
+  }
 }
diff --git a/integration-tests/discovery-servicecomb-tests/price-provider/src/main/java/com/huaweicloud/sample/GovernanceController.java b/integration-tests/discovery-servicecomb-tests/price-provider/src/main/java/com/huaweicloud/sample/GovernanceController.java
@@ -154,4 +154,16 @@ public String restTemplateInstanceBulkhead() throws Exception {
   public String loadbalance() {
     return "I am price";
   }
+
+  @RequestMapping("/testFeignRequestTimeoutWithAnnotation")
+  public String testFeignRequestTimeoutWithAnnotation() throws InterruptedException {
+    Thread.sleep(6000);
+    return "success";
+  }
+
+  @RequestMapping("/testFeignRequestTimeout")
+  public String testFeignRequestTimeout() throws InterruptedException {
+    Thread.sleep(6000);
+    return "success";
+  }
 }
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/GovernanceConst.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/GovernanceConst.java
@@ -35,4 +35,6 @@ public class GovernanceConst {
   public static final String AUTH_API_PATH_EXCLUDE = "spring.cloud.servicecomb.webmvc.publicKey.excludePathPatterns";
 
   public static final String CONTEXT_CURRENT_INSTANCE = "x-current-instance";
+
+  public static final String FEIGN_METHOD_OPTIONS_ENABLED = "feign.client.method.request.options.enabled";
 }
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/FeignConfiguration.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/FeignConfiguration.java
@@ -30,6 +30,9 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
 
+import com.huaweicloud.governance.GovernanceConst;
+import com.huaweicloud.governance.adapters.feign.options.FeignMethodRequestOptionsFactoryBuilder;
+
 import feign.Client;
 import feign.httpclient.ApacheHttpClient;
 
@@ -57,4 +60,11 @@ public Client feignClient(RetryHandler retryHandler,
   public ResponseStatusCodeExtractor responseStatusCodeExtractor(Environment environment) {
     return new ResponseStatusCodeExtractor(environment);
   }
+
+  @Bean
+  @ConditionalOnProperty(value = GovernanceConst.FEIGN_METHOD_OPTIONS_ENABLED, havingValue = "true",
+      matchIfMissing = true)
+  public FeignMethodRequestOptionsFactoryBuilder feignMethodOptionsFactoryBuilder() {
+    return new FeignMethodRequestOptionsFactoryBuilder();
+  }
 }
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsFactory.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsFactory.java
@@ -0,0 +1,33 @@
+/*
+
+ * Copyright (C) 2020-2025 Huawei Technologies Co., Ltd. All rights reserved.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huaweicloud.governance.adapters.feign.options;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.util.Map;
+
+import feign.InvocationHandlerFactory;
+import feign.Target;
+
+@SuppressWarnings("rawtypes")
+public class FeignMethodRequestOptionsFactory implements InvocationHandlerFactory {
+  @Override
+  public InvocationHandler create(Target target, Map<Method, MethodHandler> dispatch) {
+    return new FeignMethodRequestOptionsHandler(target, dispatch);
+  }
+}
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsFactoryBuilder.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsFactoryBuilder.java
@@ -0,0 +1,29 @@
+/*
+
+ * Copyright (C) 2020-2025 Huawei Technologies Co., Ltd. All rights reserved.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huaweicloud.governance.adapters.feign.options;
+
+import org.springframework.cloud.openfeign.FeignBuilderCustomizer;
+
+import feign.Feign.Builder;
+
+public class FeignMethodRequestOptionsFactoryBuilder implements FeignBuilderCustomizer {
+  @Override
+  public void customize(Builder builder) {
+    builder.invocationHandlerFactory(new FeignMethodRequestOptionsFactory());
+  }
+}
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsHandler.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignMethodRequestOptionsHandler.java
@@ -0,0 +1,74 @@
+/*
+
+ * Copyright (C) 2020-2025 Huawei Technologies Co., Ltd. All rights reserved.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huaweicloud.governance.adapters.feign.options;
+
+import static feign.Util.checkNotNull;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.util.Map;
+import java.util.stream.Stream;
+
+import feign.InvocationHandlerFactory.MethodHandler;
+import feign.Request;
+import feign.Request.Options;
+import feign.Target;
+
+@SuppressWarnings("rawtypes")
+public class FeignMethodRequestOptionsHandler implements InvocationHandler {
+  private final Map<Method, MethodHandler> dispatch;
+
+  public FeignMethodRequestOptionsHandler(Target target, Map<Method, MethodHandler> dispatch) {
+    this.dispatch = checkNotNull(dispatch, "dispatch for %s", target);
+  }
+
+  @Override
+  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
+    Object[] refactorArgs = restructureRequestArgs(method, args);
+    return dispatch.get(method).invoke(refactorArgs);
+  }
+
+  private Object[] restructureRequestArgs(Method method, Object... parameters) {
+    FeignRequestOptions requestOptions = method.getAnnotation(FeignRequestOptions.class);
+
+    // if method have no FeignRequestOptions annotation, or parameters have options, return origin parameters
+    if (requestOptions == null || findArgsOptions(parameters) != null) {
+      return parameters;
+    }
+    Request.Options options = new Options(requestOptions.connectTimeout(), requestOptions.connectTimeoutUnit(),
+        requestOptions.readTimeout(), requestOptions.readTimeoutUnit(), requestOptions.followRedirects());
+    if (parameters == null || parameters.length == 0) {
+      return new Object[]{options};
+    }
+    Object[] argsWithOptions = new Object[parameters.length + 1];
+    System.arraycopy(parameters, 0, argsWithOptions, 0, parameters.length);
+    argsWithOptions[parameters.length] = options;
+    return argsWithOptions;
+  }
+
+  Request.Options findArgsOptions(Object... parameters) {
+    if (parameters == null || parameters.length == 0) {
+      return null;
+    }
+    return Stream.of(parameters)
+        .filter(Options.class::isInstance)
+        .map(Options.class::cast)
+        .findFirst()
+        .orElse(null);
+  }
+}
diff --git a/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignRequestOptions.java b/spring-cloud-huawei-governance/src/main/java/com/huaweicloud/governance/adapters/feign/options/FeignRequestOptions.java
@@ -0,0 +1,65 @@
+/*
+
+ * Copyright (C) 2020-2025 Huawei Technologies Co., Ltd. All rights reserved.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huaweicloud.governance.adapters.feign.options;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.concurrent.TimeUnit;
+
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface FeignRequestOptions {
+    /**
+     * request connect timeout, default 10 second
+     *
+     * @return request connect timeout
+     */
+    long connectTimeout() default 10L;
+
+    /**
+     * request connect timeout unit, default second
+     *
+     * @return request connect timeout unit
+     */
+    TimeUnit connectTimeoutUnit() default TimeUnit.SECONDS;
+
+    /**
+     * response timeout, default 60 second
+     *
+     * @return response timeout
+     */
+    long readTimeout() default 60L;
+
+    /**
+     * request connect timeout unit, default second
+     *
+     * @return request connect timeout unit
+     */
+    TimeUnit readTimeoutUnit() default TimeUnit.SECONDS;
+
+    /**
+     * is follow redirects, default true
+     *
+     * @return is follow redirects
+     */
+    boolean followRedirects() default true;
+}

Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,6 @@ public class GovernanceConst {`
`35`	`35`	`public static final String AUTH_API_PATH_EXCLUDE = "spring.cloud.servicecomb.webmvc.publicKey.excludePathPatterns";`
`36`	`36`
`37`	`37`	`public static final String CONTEXT_CURRENT_INSTANCE = "x-current-instance";`
	`38`	`+`
	`39`	`+ public static final String FEIGN_METHOD_OPTIONS_ENABLED = "feign.client.method.request.options.enabled";`
`38`	`40`	`}`