Feign远程调用

矫情吗；* 2024-03-27 13:32 24阅读 0赞

## 1. Feign远程调用 ##

> 为啥需要学Feign呢？我们先来回顾之前写的代码

先来看我们以前利用RestTemplate发起远程调用的代码：

![img][]

这里就有几个问题：

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

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

### 1.1. Feign替代RestTemplate ###

#### 1.1.1. 引入依赖 ####

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

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

#### 1.1.2. 添加注释 ####

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

![img][img 1]

#### 1.1.3. 编写Feign的客户端 ####

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

@FeignClient("userservice")
    public interface UserClient {
        
       
        @GetMapping("/user/{id}")
        User findById(@PathVariable("id") Long id);
    }

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

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

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

#### 1.1.4. 总结 ####

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

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

### 1.2. 自定义配置 ###

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

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

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

#### 1.2.1. 配置文件方式 ####

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

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

也可以针对**所有服务**：

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

#### 1.2.2. 2.2 Java代码方式 ####

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

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

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

### 1.3. Feign使用优化 ###

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

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

这里我们用Apache的HttpClient来演示：

**1）引入依赖**

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

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

**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 # 每个路径的最大连接数

**总结Feign的优化：**

使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

### 1.4. 最佳实践 ###

所谓最佳实践，就是使用过程中总结的经验，最好的一种使用方式。

自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：

![img][img 2]

UserController：

![img][img 3]

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

#### 1.4.1. 继承方式 ####

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

1.  定义一个API接口，利用定义方法，并基于SpringMVC注解做声明
2.  Feign客户端和Controller都集成改接口

![img][img 4]

优点：

*  简单
 *  实现了代码共享

缺点：

参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

#### 1.4.2. 抽取方式 ####

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

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

![img][img 5]

#### 1.4.3. 实现基于抽取的最佳实践 ####

##### 1.4.3.1. 抽取 #####

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

![img][img 6]

项目结构：

![img][img 7]

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

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

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

![img][img 8]

##### 1.4.3.2. 在order-service中使用 feign-api #####

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

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

<dependency>
        <groupId>com.xn2001.feign</groupId>
        <artifactId>feign-api</artifactId>
        <version>1.0</version>
    </dependency>

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

##### 1.4.3.3. 重启测试 #####

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

![img][img 9]

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

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

##### 1.4.3.4. 解决扫描包问题 #####

**方式一：**

指定Feign应该扫描的包：（不推荐）

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

**方式二：**

指定需要加载的Client接口：

@EnableFeignClients(clients = {
        
            UserClient.class})

[img]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/fe5f60e627924ed3b1962a25fab0a33e.png
[img 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/1fbf76d56c4a421fa0bfe7eb6f071338.png
[img 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/5de0f65608ec49bf9f297ec76fd827d2.png
[img 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c48cf0cb91f54d038050fe48388fe3da.png
[img 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d9c08cc440a948ddba7d51aa008aa30b.png
[img 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/25b878e9f8864e1bb82f923ff6698fce.png
[img 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/118d72c5c96748d98bcfcaa6ee1bf0a3.png
[img 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3c722e7d1f0a4dffb72f0ad54f59733b.png
[img 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/e34c1612c9e04cf1ad24a932cfd24b24.png
[img 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d749b14cea804617899fc587f5eb9a58.png