Feign快速上手

1. 基本介绍#

在传统的 Spring 应用中，如果你需要调用另一个服务，你可能需要手动使用 RestTemplate 或 WebClient，自己拼接 URL、设置请求头、处理响应等，这会比较繁琐且容易出错。

而 Feign的核心思想就是让你定义一个接口，然后在这个接口上使用注解来描述 HTTP 请求的细节（如请求方法、URL、参数等）。当你调用这个接口中的方法时，Feign 会自动帮你生成具体的实现，完成 HTTP 请求的全过程。这大大简化了服务间的调用，提高了开发效率。

2. 快速使用#

1. 引入依赖#

由于Feign的使用需要依赖注册中心，因此此处我们以Nacos为例进行介绍

<properties>
    <java.version>17</java.version>
    <spring-cloud.version>2021.0.8</spring-cloud.version>
    <spring-cloud-alibaba.version>2021.0.5.0</spring-cloud-alibaba.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>

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

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

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

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>${spring-cloud-alibaba.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

2. 定义 Feign 客户端接口#

接下来，定义一个接口，使用 @FeignClient 注解来指定你要调用的服务。这个注解中的 value 或 name 属性通常是你在注册中心注册的服务名称。

在接口方法上，使用 Spring MVC 的注解（如 @GetMapping, @PostMapping）来声明请求的类型和路径。

@FeignClient(value = "service-provider")
public interface UserService {

    /**
     * 调用远程服务 service-provider 的 /users/{id} 接口
     * @param id 用户ID
     * @return 用户信息
     */
    @GetMapping("/users/{id}")
    String getUserById(@PathVariable("id") Long id);

}

在这个例子中，@FeignClient(value = "service-provider") 告诉 Feign，这个接口是用来调用名为 service-provider 的服务。当你调用 getUserById 方法时，Feign 会自动向 service-provider 发送一个 GET 请求到 /users/{id} 路径。

3. 开启 Feign#

在 Spring Boot 启动类上，通过 @EnableFeignClients 注解来启用 Feign 客户端功能。

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients(clients = HelloProviderClient.class)
// 或者 @EnableFeignClients(basePackages = "com.minjer.consumer.feign")
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

4. 使用 Feign 客户端#

现在，可以在业务逻辑中，像注入普通的 Spring Bean 一样，注入并使用这个 Feign 接口了。

@RestController
public class OrderController {

    @Autowired
    private UserService userService;

    @GetMapping("/orders/{userId}")
    public String getOrderDetails(@PathVariable Long userId) {
        // 直接调用 Feign 接口，就像调用本地方法一样
        String user = userService.getUserById(userId);
        return "Order details for user: " + user;
    }
}

3. 高级特性#

1. 超时配置#

在微服务架构中，一个服务调用另一个服务可能会因为网络延迟或被调用方处理缓慢而导致超时。为了避免因单个服务调用阻塞而影响整个系统，配置合理的超时时间非常重要。

你可以在配置文件中对 Feign 进行全局或局部的超时配置：

全局配置（application.yml）：

feign:
  client:
    config:
      default:
        connectTimeout: 5000 # 连接超时时间，单位毫秒
        readTimeout: 5000    # 读取超时时间，单位毫秒

connectTimeout: 客户端与服务器建立连接的超时时间。
readTimeout: 客户端从服务器读取响应的超时时间。

局部配置：

如果你想为某个特定的 Feign 客户端设置不同的超时时间，可以通过 @FeignClient 的 qualifier 属性配合 feign.client.config 进行配置。

feign:
  client:
    config:
      service-provider: # service-provider 是 FeignClient 的 name
        connectTimeout: 3000
        readTimeout: 3000

2. 日志配置#

为了方便调试和监控，Feign 提供了强大的日志功能。你可以通过配置日志级别来控制 Feign 打印的日志信息量。

首先，需要创建一个 Logger.Level Bean：

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL; // 打印完整的请求和响应信息
    }
}

然后，在 application.yml 中配置 Feign 客户端的日志级别：

logging:
  level:
    # service-provider 是 FeignClient 的 name
    com.example.feign.UserService: DEBUG

Logger.Level 提供了以下几种日志级别：

NONE: 不记录任何日志 (默认)。
BASIC: 仅记录请求方法、URL、响应状态码和执行时间。
HEADERS: 在 BASIC 级别基础上，增加请求和响应的头信息。
FULL: 记录完整的请求和响应信息，包括请求体、响应体和所有头信息。在生产环境中应谨慎使用，因为可能会打印敏感信息，并影响性能。

3. 自定义拦截器（`RequestInterceptor`）#

当你需要为所有的 Feign 请求添加统一的逻辑时，比如添加 JWT 认证信息、链路追踪 ID 或者自定义的请求头，自定义拦截器是一个非常好的选择。

你只需要创建一个类，实现 feign.RequestInterceptor 接口，并将其注册为 Bean 即可。

import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyFeignInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate template) {
        // 在所有 Feign 请求的请求头上添加一个自定义的追踪ID
        template.header("X-Trace-ID", "uuid-12345");
        // 也可以获取当前请求的Token，并转发到下一个服务
        // String token = getCurrentUserToken();
        // template.header("Authorization", "Bearer " + token);
    }
}

Spring Cloud Feign 会自动检测到这个 RequestInterceptor Bean，并将其应用到所有的 Feign 客户端上。

4. 集成负载均衡和熔断#

负载均衡 Feign 默认集成了 Ribbon（或 Spring Cloud LoadBalancer），可以自动实现客户端侧的负载均衡。当一个服务有多个实例时，Feign 会自动从这些实例中选择一个进行调用。你只需要在 @FeignClient 中使用服务的注册名称，无需关心具体的 IP 和端口。

熔断器 为了防止服务雪崩，Feign 可以与 Hystrix 或 Resilience4j 等熔断器组件集成。

Hystrix (已进入维护模式，新项目不推荐)：在 application.yml 中开启 Hystrix： feign.hystrix.enabled=true 然后，在 @FeignClient 中指定一个 fallback 实现类，当远程调用失败或超时时，会调用这个 fallback 类中的方法。
```
@FeignClient(value = "service-provider", fallback = UserFallback.class)
public interface UserService {
    // ...
}
```
Resilience4j (推荐)：在 Spring Cloud 2020.0.x 版本之后，Resilience4j 成为了主流的熔断器方案。你可以在配置文件中对 Resilience4j 进行配置，Feign 会自动集成它。

5. 请求/响应压缩#

在网络带宽有限或需要传输大量数据时，开启请求/响应压缩可以有效减少网络负载，提高性能。

你可以在 application.yml 中进行配置：

feign:
  compression:
    request:
      enabled: true    # 开启请求压缩
      mime-types: [text/xml, application/json] # 指定要压缩的MIME类型
      min-request-size: 2048 # 最小压缩阈值，单位字节
    response:
      enabled: true    # 开启响应压缩

当请求体或响应体超过 min-request-size 并且 MIME 类型匹配时，Feign 会自动进行 GZIP 压缩。