Feign Client

1. 快速开始

1. 引入依赖

   依赖管理：

   <properties>
       <spring-boot.version>2.7.6</spring-boot.version>
       <spring-cloud.version>2021.0.8</spring-cloud.version>
   </properties>
   
   <dependencyManagement>
       <dependencies>
           <!-- Spring Boot Dependencies -->
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-dependencies</artifactId>
               <version>${spring-boot.version}</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
   
           <!-- Spring Cloud Dependencies -->
           <dependency>
               <groupId>org.springframework.cloud</groupId>
               <artifactId>spring-cloud-dependencies</artifactId>
               <version>${spring-cloud.version}</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>

   Open Feign 依赖：

   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-openfeign</artifactId>
   </dependency>

2. 添加注解开启 Feign Client

   @EnableFeignClients(basePackages = "your.feign.client.package.path")
   @SpringBootApplication
   public class YourApplication {
       public static void main(String[] args) {
           SpringApplication.run(YourApplication.class, args);
       }
   }

3. 编写 Feign Client

   @FeignClient("user-service")
   public interface RemoteUserService {
       @GetMapping("/user/{id}")
       UserVO getUser(@PathVariable("id") int id);
   }

4. 使用 Feign Client 替代 RestTemplate

   原代码：

   restTemplate.getForObject("http://user-service/user/" + id, UserVO.class)

   新代码：

   remoteUserService.getUser(id)

2. 自定义配置

2.1. 日志

Spring OpenFeign 支持以下几种日志模式：

• NONE：无日志记录（默认）；
• BASIC：仅记录请求方法、URL、响应状态码和执行时间；
• HEADERS：记录基本信息以及请求和响应的头部信息；
• FULL：记录请求和响应的头部、正文和元数据。

配置方式：

1. 通过配置文件配置：

   feign:
     client:
       config:
         default:       # 全局配置
           logger-level: full
         user-service:  # 针对 user-service 的配置
           logger-level: full

2. 通过 Java 代码配置：

   Spring Cloud 会使用 FeignClientsConfiguration 为每个命名客户端按需创建一个新的 ApplicationContext。

   public class MyFeignClientConfiguration {
       @Bean
       public Logger.Level feignLoggerLevel() {
           return Logger.Level.BASIC;
       }
   }

   @FeignClient(value = "user-service", configuration = MyFeignClientConfiguration.class)
   public interface RemoteUserService {
       @GetMapping("/user/{id}")
       UserVO getUser(@PathVariable("id") int id);
   }

   在这种情况下，user-service 客户端由 FeignClientsConfiguration 中的组件以及 MyFeignClientConfiguration 中的组件共同组成（后者会覆盖前者）。

   警告

   MyFeignClientConfiguration 不需要使用 @Configuration 注解。然而，如果加了这个注解，则必须确保它不会被 @ComponentScan 扫描到。否则，当你在 @FeignClient 中指定该配置类时，它会成为默认的 feign.Decoder、feign.Encoder、feign.Contract 等组件的来源。避免这种情况的方法包括：

   • 将它放在一个与 @ComponentScan 或 @SpringBootApplication 不重叠的包中；
   • 或者在 @ComponentScan 中明确将其排除。

   也可以将 MyFeignClientConfiguration 作为全局配置：

   @EnableFeignClients(
           basePackages = "your.feign.client.package.path",
           defaultConfiguration = MyFeignClientConfiguration.class)
   @SpringBootApplication
   public class YourApplication {
       public static void main(String[] args) {
           SpringApplication.run(YourApplication.class, args);
       }
   }

2.2. 重试机制

OpenFeign 的默认 Retryer 实现是 Retryer.NEVER_RETRY。这意味着默认情况下，OpenFeign 本身不会进行任何重试！当 OpenFeign 与 Ribbon 或 SCLB（Spring Cloud LoadBalancer）集成时，负载均衡器负责从服务注册中心（如 Eureka, Nacos）获取可用实例列表，并根据策略选择一个实例进行调用。

• Feign Retryer: 发生在 Feign 客户端层面，决定对同一个目标 URL（这个 URL 在负载均衡后已经指向一个具体的实例）是否重试；

• LB 重试：发生在负载均衡器层面，决定当一个服务实例调用失败后，是重试同一个实例还是切换到下一个实例再试（或者两者结合）。

提示

LB 重试与 Feign 重试需协调，避免嵌套（例如，Feign 重试 3 次 × LoadBalancer 切换 2 次 = 6 次总调用）。

常用的负载均衡器有 Ribbon 和 Spring Cloud LoadBalancer。鉴于 Spring Cloud 2020 以后，Ribbon 已被弃用，推荐使用 Spring Cloud LoadBalancer。

SCLB 集成的 OpenFeign 默认不提供开箱即用的重试机制（无论是 LB 切换还是同一实例重试）。需要显式配置。可以通过引入 spring-retry 来支持重试。

2.3. HTTP 客户端

Feign 底层客户端默认实现是 URLConnection，不支持连接池，建议替换为 HttpClient 或 OKHttp。

当与 SCLB 集成时，Spring 会使用 LoadBalancerFeignClient 代理真正的 HTTP 请求客户端，以实现客户端负载均衡。

以 HttpClient 为例：

1. 引入依赖：

   <dependency>
       <groupId>io.github.openfeign</groupId>
       <artifactId>feign-httpclient</artifactId>
   </dependency>

2. 配置连接池：

   feign:
     httpclient:
       enabled: true
       max-connections: 200
       max-connections-per-route: 50

3. 最佳实践

1. 方式一，给消费者的 Feign Client 和提供者的 Controller 定义统一的父接口；

   public interface UserAPI {
       @GetMapping("/user/{id}")
       UserVO getUser(@PathVariable("id") int id);
   }

   @FeignClient("user-service")
   public interface RemoteUserService extends UserAPI {}

   @RestController
   public class UserAPI implements UserAPI {
       public UserVO getUser(@PathVariable("id") int id) {
           // ...
       }
   }

   该方案虽然可以避免在 Feign Client 中编写重复、冗余的代码，但是缺点也很明显：

   1. Feign Client 与 Controller 紧耦合；
   2. 父接口参数列表中的注解不会被 Controller 继承，需要重复再声明一次。

2. 方式二，将 Feign Client 抽取为独立模块，并把默认的 Feign 配置都放到这个模块中；

   操作步骤：

   1. 创建一个 Module，引入 Feign 的 Starter 依赖；

   2. 将 Feign Client 相关接口定义以及默认的 Feign 配置类都挪到该 Module 中；

   3. 其它业务模块引入该 Module，保留原启动类上的 @EnableFeignClients 并根据需要调整 basePackages 配置值；

   4. 调整相关 import，启动测试。