OpenFeign

荒流2021年12月21日大约 4 分钟约 1199 字

HTTP 客户端Feign，本文说的Feign是指OpenFeign。
Feign 来自 Netflix，OpenFeign 来自 Spring Cloud 官方，其基于 Feign 做了改进。
Feign 与 OpenFeign 最大的区别是：前者不支持对 SpringMVC 的注解，而后者支持。
Feign 的坐标是spring-cloud-starter-feign，OpenFeign 的坐标是 spring-cloud-starter-openfeign。

1. 前言

`RestTemplate`方式调用存在的问题

对于之前利用RestTemplate发起远程调用的代码：

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

其存在以下问题：

代码可读性差，编程体验不统一
参数复杂，URL 难以维护

Feign 简介

Feign 就是一个声明式的 HTTP 客户端，官方地址 https://github.com/OpenFeign/feign ，其作用就是帮助我们优雅的实现 HTTP 请求的发送，解决上述问题。

2. 定义和使用 Feign 客户端

使用 Feign 的步骤如下：

引入依赖：

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

在 order-service 的启动类添加注解开启 Feign 的功能：

@EnableFeignClients
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

编写 Feign 客户端：
```
@FeignClient("useruservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}
```
这里主要是基于 SpringMVC 的注解来声明远程调用的信息，比如
- 服务名称：userservice
- 请求方式：GET
- 请求路径：/user/
- 请求参数：Long id
- 返回值类型：User

用 Feign 客户端代替RestTemplate

@Autowired
private UserClient userClient;

public Order queryOrderById(Long orderId) {
    // 1. 查询清单
    Order order = orderMapper.findById(orderId);
    // 2. 利用 Feign 发起 HTTP 请求，查询用户
    User user = userClient.findById(order.getUserId());
    // 3. 封装 user 到 Order
    order.setUser(user);
    // 4. 返回
    return order;
}

3. 自定义 Feign 的配置

Feign 支持自定义配置来覆盖默认配置，可以修改的配置如下（一般我们需要配置的就是日志级别）：

类型	作用	说明
`feign.Logger.Level`	修改日志级别	包含 4 种不同的级别：NONE, BASIC, HEADERS, FULL
`feign.codec.Decoder`	响应结果的解析器	HTTP 远程调用的结果做解析，例如解析 JSON 字符串为 Java 对象
`feign.codec.Encoder`	请求参数编码	将请求参数编码，便于通过 HTTP 请求发送
`feign.Contract`	支持的注解格式	默认是 SpringMVC 的注解
`feign.Retryer`	失败重试机制	请求失败的重试机制，默认是没有，不过会使用 Ribbon 的重试

配置 Feign 日志的方式：

方式一：配置文件方式

全局生效：

feign:
  client:
    config:
      default: # 这里用 default 就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL # 日志级别

局部生效：

feign:
  client:
    config:
      userservice: # 这里用 default 就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL # 日志级别

方式二：代码方式。需先声明一个 Bean：

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

全局配置——放到@EnableFeignClients注解中

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)

局部配置——放到@FeignClient注解中：

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

4. Feign 的性能优化

Feign 底层的客户端实现：

URLConnection: 默认实现，不支持连接池
Apache HttpClient: 支持连接池
OKHttp: 支持连接池

因此优化 Feign 的性能主要包括：

使用连接池替代默认的URLConnection

如 Feign 添加HttpClient的支持：

引入依赖：

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

配置连接池：

feign:
  client:
    config:
      default: # default 全局的配置
        loggerLevel: FULL # 日志级别，BASIC 就是基本的请求和响应消息
  httpclient:
    enabled: true # 开启 feign 对 HttpClient 的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

日志级别，最好用basic或none

5. Feign 的最佳实践

5.1 方式一：继承

此法给消费者的FeignClient和提供者的Controller定义统一的父接口作为标准，其特点是：

服务紧耦合
父接口参数列表中的映射不会被继承

5.2 方式二：抽取

将FeignClient抽取为独立模块，并且把接口有关的 POJO、默认的 Feign 配置都放到这个模块中，提供给所有的消费者使用：

抽取FeignClient的步骤：

首先创建一个 module，命名为 feign-api，然后引入 feign 的 starter 依赖；
将 order-service 中编写的 UserClient, User, DefaultFeignConfiguration 都复制到 feign-api 项目中；
在 order-service 中引入 feign-api 的依赖；
修改 order-service 中的所有与上述三个组件有关的 import 部分，改成导入 feign-api 中的包；
重启测试。

当定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用，可通过如下两种方式解决：

方式一：指定FeignClient所在包

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

方式二：指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})

OpenFeign

详情