Http 客户端 Feign 学习笔记

从 RestTemplate 到 Feign

RestTemplate 存在的问题

在未使用 Feign 之前，使用 RestTemplate 发起远程调用的代码如下：

String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);

核心痛点：

• 代码可读性差：URL 拼接丑陋，参数多时难以维护。
• 编程体验不统一：需要手动处理 HTTP 请求细节，而不是像调用 Java 方法一样简单。
• 参数复杂 URL 难以维护：特别是当参数包含复杂对象时，GET 请求的 URL 构造非常痛苦。

Feign 介绍

Feign 是一个声明式的 Http 客户端。它的作用是帮助我们优雅地实现 Http 请求的发送。

• 声明式：只需要定义接口，加上注解，像调用本地方法一样调用远程服务。
• 集成了 Ribbon：自动实现负载均衡调用。

---

快速入门使用

使用步骤

第 1 步：引入依赖

在微服务消费端（调用方）引入 openfeign 依赖：

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

第 2 步：开启 Feign 功能

在启动类上添加注解 @EnableFeignClients：

@EnableFeignClients // 核心注解：扫描 FeignClient 接口并生成动态代理
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
public class OrderApplication {public static void main(String[] args) {SpringApplication.run(OrderApplication.class, args);}
}

第 3 步：编写 Feign 客户端接口

创建一个接口，使用 SpringMVC 的注解来声明远程调用的信息：

@FeignClient("userservice") // 指定服务名称，Ribbon 会根据这个名称进行负载均衡
public interface UserClient {@GetMapping("/user/{id}") User findById(@PathVariable("id") Long id);
}

关键点解析：

• 服务名称：userservice
• 请求方式：GET
• 请求路径：/user/{id}
• 请求参数：Long id
• 返回值：User

第 4 步：在使用处注入并调用

@Service
public class OrderService {@Autowiredprivate OrderMapper orderMapper;@Autowiredprivate UserClient userClient; // 像注入 Mapper 一样注入 FeignClientpublic Order queryOrderById(Long orderId) {// 1. 查询订单Order order = orderMapper.findById(orderId);// 2. 使用 Feign 远程调用User user = userClient.findById(order.getUserId());// 3. 封装 user 到 Orderorder.setUser(user);// 4. 返回return order;}
}

常见问题

• 复杂参数处理：如果是对象参数，GET 请求需要加 @SpringQueryMap，POST 请求使用 @RequestBody。

---

自定义 Feign 配置

Feign允许运行自定义配置来覆盖默认配置，常用的配置如下：

类型	作用	说明
feign.Logger.Level	修改日志级别	最常用。包含：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果解析器	HTTP -> Java 对象
feign.codec.Encoder	请求参数编码	Java 对象 -> HTTP请求参数
feign.Contract	支持的注解格式	默认 SpringMVC，也可配置为 Feign 原生注解
feign.Retryer	失败重试机制	默认不重试（即Retryer.NEVER_RETRY），依赖 Ribbon 重试

配置日志级别

默认日志级别是 NONE，不打印任何日志。开发调试建议设为 FULL 或 BASIC。

方式一：配置文件（YAML）

• 全局生效

  （所有 FeignClient 都生效）：

  feign:client:config:default: # 这里写 default 表示全局配置loggerLevel: FULL
  

• 局部生效

  （指定服务生效）：

  feign:client:config:userservice: # 这里写具体服务名称loggerLevel: FULL
  

方式二：Java 代码方式

首先声明配置类（不需要加 @Configuration 注解，避免自动扫包导致全局生效）：

public class FeignClientConfiguration {@Beanpublic Logger.Level feignLogLevel() {return Logger.Level.BASIC; }
}

• 全局配置

  （在启动类注解中指定）：

  @EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
  

• 局部配置

  （在具体的 Client 接口注解中指定）：

  @FeignClient(value = "userservice", configuration = FeignClientConfiguration.class)
  

---

Feign 的性能优化（重要）

默认的 Feign 只是一个声明式客户端，它只负责把注解转换成 HTTP 请求，实际发送请求依赖底层的委托客户端。

底层客户端对比

1. URLConnection(默认)：
   • JDK 自带，每次请求都会建立新的连接，用完即销毁。
   • 不支持连接池，性能较差，频繁的三次握手四次挥手。
2. Apache HttpClient(推荐)：
   • 广泛使用，支持连接池，复用连接。
3. OKHttp(推荐)：
   • 谷歌出品，轻量级，支持连接池。

优化步骤：使用连接池（以 HttpClient 为例）

第 1 步：引入依赖

在 POM 文件中添加 HttpClient 依赖，替代默认的 URLConnection：

<!-- httpClient 的依赖 -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-httpclient</artifactId>
</dependency>

第 2 步：在 YAML 中配置连接池

引入依赖后，Feign 默认就会检测并使用 HttpClient，但我们需要开启并配置参数：

feign:httpclient:enabled: true # 开启 feign 对 HttpClient 的支持max-connections: 200 # 最大连接数max-connections-per-route: 50 # 每个路径的最大连接数

4.3 优化总结

1. 日志级别：生产环境建议使用 BASIC 或 NONE，不要用 FULL（影响性能）。
2. 连接池：务必引入 HttpClient 或 OKHttp 并配置连接池参数。

---

Feign 的最佳实践

在使用 Feign 时，消费者（Client）和提供者（Controller）的方法签名、URL 是一模一样的，如何避免重复代码？

方式一：继承方式（不推荐）

• 做法：定义一个统一的 API 接口，Controller 实现该接口，FeignClient 也继承该接口。
• 缺点：
  • 紧耦合：Consumer 和 Provider 共享了接口，参数修改会影响双方。
  • 参数注解兼容性：SpringMVC 的部分注解在继承时无法完美传递（如 @PathVariable 必须显式指定名称）。

方式二：抽取方式（推荐）

• 做法：将 FeignClient 接口、POJO（实体类）、DTO 等公共代码抽取成一个独立的 Module（例如叫 feign-api）。
• 好处：服务与服务之间解耦，复用性高。

操作步骤：

1. 创建 Module：创建一个名为 feign-api 的模块。

2. 引入依赖：

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

3. 编写代码：把 UserClient.java, User.java, FeignConfig.java 等剪切到该模块中。

4. 消费方引用：在 order-service 中引入 feign-api 的依赖。

5. 解决扫描问题：

   此时，因为 Client 在另一个包下，order-service 的启动类默认扫描不到 feign-api 中的 Client。

   解决方法 A（指定扫描的包）：

   @EnableFeignClients(basePackages = "cn.itcast.feign.clients")
   

   解决方法 B（指定具体的 Client 字节码）：

   @EnableFeignClients(clients = {UserClient.class})
   

---

进阶：Feign 与 Hystrix/Sentinel 整合

Feign 可以配合熔断降级组件（通常是 Sentinel 或 Hystrix）使用，确保服务调用失败时有兜底逻辑。

开启 Sentinel 支持

在 YAML 中配置：

feign:sentinel:enabled: true

编写失败降级逻辑

方式一：FallbackClass

实现 FeignClient 接口，内部写降级逻辑。

@Component
public class UserClientFallback implements UserClient {@Overridepublic User findById(Long id) {return new User(); // 返回空对象或默认值}
}

在使用时指定：

@FeignClient(value = "userservice", fallback = UserClientFallback.class)

方式二：FallbackFactory（推荐，可获取异常信息）

@Component
@Slf4j
public class UserClientFallbackFactory implements FallbackFactory<UserClient> {@Overridepublic UserClient create(Throwable throwable) {return new UserClient() {@Overridepublic User findById(Long id) {log.error("查询用户失败，异常信息：", throwable);return new User(); // 降级逻辑}};}
}

在使用时指定：

@FeignClient(value = "userservice", fallbackFactory = UserClientFallbackFactory.class)

---

总结

使用 Feign 的核心流程：

1. 导包：OpenFeign, (HttpClient)
2. 开启：@EnableFeignClients
3. 定义：@FeignClient 接口
4. 配置：
   • 日志：YAML 或 Java Config (Logger.Level)
   • 连接池：YAML 配置 HttpClient
5. 优化架构：抽取独立的 feign-api 模块。