Feign远程调用

秒速五厘米 2024-02-20 09:49 19阅读 0赞

**本篇用到的资料：[https://gitee.com/Allengan/cloud-demo.git![icon-default.png?t=N7T8][icon-default.png_t_N7T8]https://gitee.com/Allengan/cloud-demo.git][https_gitee.com_Allengan_cloud-demo.git_icon-default.png_t_N7T8_icon-default.png_t_N7T8_https_gitee.com_Allengan_cloud-demo.git]**

**目录**

2.Feign远程调用

2.1.Feign替代RestTemplate

1）引入依赖

2）添加注解

3）编写Feign的客户端

4）测试

5）总结

2.2.自定义配置

2.2.1.配置文件方式

2.2.2.Java代码方式

2.3.Feign使用优化

1）引入依赖

2）配置连接池

2.4.最佳实践

2.4.1.继承方式

2.4.2.抽取方式

2.4.3.实现基于抽取的最佳实践

1）抽取

2）在order-service中使用feign-api

4）解决扫描包问题

--------------------

#### 2.Feign远程调用 ####

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

![a3d40f26597f43f38acc45acaca5288e.png][]

存在下面的问题：

•代码可读性差，编程体验不统一

•参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：[GitHub - OpenFeign/feign: Feign makes writing java http clients easier][GitHub - OpenFeign_feign_ Feign makes writing java http clients easier]

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

![a316e8291a0542fb996153da027f72c5.png][]

##### 2.1.Feign替代RestTemplate #####

###### 1）引入依赖 ######

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

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

###### 2）添加注解 ######

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

![2d4e454b88d84881850a26e4a3c00cec.png][]

###### 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来发送了。

###### 4）测试 ######

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

![a545b367b4e1417fb7f3e8c3ec3468bc.png][]

###### 5）总结 ######

① 引入依赖

② 添加**@EnableFeignClients**注解

③ 编写FeignClient接口

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

##### 2.2.自定义配置 #####

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

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

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

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

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

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

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

也可以针对所有服务：

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

而日志的级别分为四种：

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

###### 2.2.2.Java代码方式 ######

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

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

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

##### 2.3.Feign使用优化 #####

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

•URLConnection：默认实现，不支持连接池

•Apache HttpClient ：支持连接池

•OKHttp：支持连接池

因此提高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 # 每个路径的最大连接数

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

![8085ffd55bdc4706a66371ad6e7eb869.png][]

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

![1b78819026094c75a9501ea4ee814010.png][]

**总结，Feign的优化：**

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

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

##### 2.4.最佳实践 #####

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

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

feign客户端：

![e63730ca07624d42a519c3417fd53153.png][] UserController：

![0e0f41b66b774e98970f3125185bfbc6.png][]

###### 2.4.1.继承方式 ######

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

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

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

![01c3061f4fa14eeb976336e76657e7d1.png][]

优点：

*  简单
 *  实现了代码共享

缺点：

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

###### 2.4.2.抽取方式 ######

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

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

![fe2e17dabece4bdbb01ce6bf2cb290cd.png][]

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

###### 1）抽取 ######

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

![e8492864bf4a4a47bc908445a0928c3f.png][]

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

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

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

![38ef3d322b8f4c37961e7ab8c682b42d.png][]

###### 2）在order-service中使用feign-api ######

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

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

<dependency>
        <groupId>cn.itcast.demo</groupId>
        <artifactId>feign-api</artifactId>
        <version>1.0</version>
    </dependency>

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

###### 4）解决扫描包问题 ######

方式一：

指定Feign应该扫描的包：

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

方式二：

指定需要加载的Client接口：

@EnableFeignClients(clients = {UserClient.class})

[icon-default.png_t_N7T8]: https://csdnimg.cn/release/blog_editor_html/release2.3.6/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=N7T8
[https_gitee.com_Allengan_cloud-demo.git_icon-default.png_t_N7T8_icon-default.png_t_N7T8_https_gitee.com_Allengan_cloud-demo.git]: https://gitee.com/Allengan/cloud-demo.git
[a3d40f26597f43f38acc45acaca5288e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/feffedc33ec6446e8c3aa57d025e529d.png
[GitHub - OpenFeign_feign_ Feign makes writing java http clients easier]: https://github.com/OpenFeign/feign
[a316e8291a0542fb996153da027f72c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/3128b178b32148d9b62273dc3ca83e87.png
[2d4e454b88d84881850a26e4a3c00cec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/012bfcec67e643208eb74bd6eb97d1da.png
[a545b367b4e1417fb7f3e8c3ec3468bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/0a66fabb11ed4c99af83555c4fb18d7c.png
[8085ffd55bdc4706a66371ad6e7eb869.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/e86c1b13563248eead5a283f0c16c42b.png
[1b78819026094c75a9501ea4ee814010.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/f21fe43025be4b73ae0cdf35f81f80e3.png
[e63730ca07624d42a519c3417fd53153.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/d367964bd69a4457bde5131c272c112e.png
[0e0f41b66b774e98970f3125185bfbc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/c6e09fac82b74807a1fd81a3ecb95e64.png
[01c3061f4fa14eeb976336e76657e7d1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/6b84894d3b4f4ee390bbc70db06e84f8.png
[fe2e17dabece4bdbb01ce6bf2cb290cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/a3a6873f2953440db0a0b7f30206110b.png
[e8492864bf4a4a47bc908445a0928c3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/1d4bf0dce3f84ffb99ed639151168cc7.png
[38ef3d322b8f4c37961e7ab8c682b42d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/ff8e65d57ea34637bac26a19561eaa5b.png