Feign远程调用

CAMELLIA2024-08-032024-09-11

Feign远程调用

先前利用RestTemplate发起远程调用的代码：

存在下面的问题：

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

Feign是一个声明式的http客户端，其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

1. Feign替代RestTemplate

1.1 引入依赖

在order-service服务的pom文件中引入feign的依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    <version>${spring-cloud-starter-openfeign}</version>
</dependency>

1.2 添加注解

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

1.3 编写Feign的客户端

在order-service中新建一个接口，内容如下：

package orders.clients;

import orders.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * Feign 客户端接口，用于与用户服务进行通信。
 * 通过声明的接口方法调用，Feign 会自动为你生成实现类，简化 HTTP 请求的操作。
 *
 * @FeignClient 注解标记这个接口是一个 Feign 客户端，
 * 它会自动根据指定的服务名 ("user-service") 查找服务实例。
 */
@FeignClient("user-service")
public interface UserClient {
    
    @GetMapping("/user/{id}")
    User finById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

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

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

1.4 修改请求方法

修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

1.5 总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

2. 自定义配置

Feign可以支持很多的自定义配置，如下表所示：

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

一般情况下，默认值就能满足使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

2.1 配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别

也可以针对所有服务：

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

而日志的级别分为四种：

NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

2.2 Java代码方式

也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

1	@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

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

3. Feign使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

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

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里用Apache的HttpClient来演示。

3.1 引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

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

在高版本中不需要导入此依赖，因为feign默认导入了。

3.2 配置连接池

在order-service的application.yml中添加配置：

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

接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：

Debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

3.3 总结

日志级别尽量用basic
使用HttpClient或OKHttp代替URLConnection
- 引入feign-httpClient依赖
- 配置文件开启httpClient功能，设置连接池参数

4. Feign代码结构优化

4.1 引出问题

所谓最近实践，就是使用过程中总结的经验，是最优的使用方式。通过自习观察可以发现，Feign 客户端的代码与服务提供者的 Controller 代码非常相似：

feign客户端：

UserController：

有没有一种办法简化这种重复的代码编写呢？

4.2 继承方式

一样的代码可以通过继承来共享：

1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。

2）Feign客户端和Controller都集成改接口

优点：

简单
实现了代码共享

缺点：

服务提供方、服务消费方紧耦合
参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

4.3 抽取方式

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

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

*4.4 实现基于抽取的实现

抽取复用模块

首先创建一个module，命名为feign-api：

项目结构：

在feign-api中然后引入feign的starter依赖

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

在order-service中使用feign-api

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

在order-service的pom文件中中引入feign-api的依赖：

<dependency>
    <groupId>camellia</groupId>
    <artifactId>feign_api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

重启测试

重启后，发现服务报错了：

这是因为UserClient现在在feign.clients包下，

而order-service的@EnableFeignClients注解是在order包下，不在同一个包，无法扫描到UserClient。

解决扫描包问题

方式一：

指定Feign应该扫描的包：

1	@EnableFeignClients(basePackages = "feign.clients")

方式二：

指定需要加载的Client接口：

1	@EnableFeignClients(clients = {UserClient.class})

[!tip]

第二个加载更精确，能耗比较低。第一个加载指定包下，范围广。