HTTP客户端Feign

亦凉 2024-03-26 01:33 106阅读 0赞

## 0、RestTemplate方式调用存在的问题 ##

**之前远程调用的代码**

public Order queryOrderById(Long orderId) {
            // 1.查询订单    从数据库中获取
            Order order = orderMapper.findById(orderId);
            //2. 利用RestTemplate发起HTTP请求，获取用户
            //         get请求：getForObject(url路径,返回值类型)
            //                 我们下面的返回值类型不需要JSON，而是需要一个User对象的形式，所以写User.class
            //         post请求：postForObject()
    //        String url = "http://localhost:8081/user/" + order.getUserId();
            String url = "http://userservice/user/" + order.getUserId();
            User user = restTemplate.getForObject(url, User.class);
    
            //3. 封装user到Order中
            order.setUser(user);
            // 4.返回
            return order;
        }

**问题：**

*  代码可读性差，变成体验不同意

*  参数复杂URL难以维护

## 一、Fegin远程调用 ##

Fegin是一个**声明式的http客户端**，官方地址：[OpenFeign/feign: Feign makes writing java http clients easier (github.com)][OpenFeign_feign_ Feign makes writing java http clients easier _github.com]

作用：优雅的实现http请求的发送，解决RestTemplate

### 1.1 maven依赖 ###

在order-service工程中添加依赖

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

### 1.2 启动类添加注解开启Feign功能 ###

开启自动装配的相关功能

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

### 1.3 定义和使用Fegin客户端 ###

**远程调用需要的信息：**

*  服务名称：userservice

*  请求方式：GET

*  请求路径：/user/\{id\}

*  请求参数：Long id

*  返回值类型：User

这些需要的信息，我们Feign通过声明客户端的方式声明出来了，以后我们便可以拿这个接口调用这个方法即可

声明的远程调用封装了所有对userservice所有的远程调用

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

public Order queryOrderById(Long orderId) {
        // 1.查询订单    从数据库中获取
        Order order = orderMapper.findById(orderId);
        // 2.用Fegin远程调用
        User user = userClient.findById(order.getUserId());
        // 3.封装user到Order
        order.setUser(user);
        // 4.返回
        return order;
    }

[localhost:8080/order/101][localhost_8080_order_101]

上面这个请求多发送几次，发现userservice的三个端口8081，8082，8083都会有相应，说名自带负载均衡

![7524511614e7e046bc4f506e0797c412.png][]

**order-service远程调用user-service，确保这两个一定要在同一个命名空间下，否则调用不到，在这里都在默认的public命名空间下**

### 1.4 总结 ###

*  引入依赖

*  添加@EnableFeignClients注解

*  编写FeignClient接口

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

## 二、Feign自定义配置 ##

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:203px;vertical-align:top;height:52px;">类型</td> 
 <td style="width:186px;vertical-align:top;height:52px;">作用</td> 
 <td style="width:518px;vertical-align:top;height:52px;">说明</td> 
 </tr> 
 <tr> 
 <td style="width:393px;vertical-align:top;height:52px;">feign.Logger.Level</td> 
 <td style="width:241px;vertical-align:top;height:52px;">修改日志级别</td> 
 <td style="width:2343px;vertical-align:top;height:52px;">包含四种不同的级别：NONE（没有任何日志）、BASIC（记录请求什么时候发送的，什么时候结束的，耗时多久等基本信息）、HEADERS（除了基本信息以外还有带上请求头和响应头信息）、FULL（除了前面介绍的以外，还会把请求体和响应体信息都记录下来）</td> 
 </tr> 
 <tr> 
 <td style="width:333px;vertical-align:top;height:52px;">feign.codec.Decoder</td> 
 <td style="width:271px;vertical-align:top;height:52px;">响应结果的解析器</td> 
 <td style="width:948px;vertical-align:top;height:52px;">http远程调用的结果做解析，例如解析json字符串为java对象</td> 
 </tr> 
 <tr> 
 <td style="width:333px;vertical-align:top;height:52px;">feign.codec.Encoder</td> 
 <td style="width:241px;vertical-align:top;height:52px;">请求参数编码</td> 
 <td style="width:753px;vertical-align:top;height:52px;">将请求参数编码，便于通过http请求发送</td> 
 </tr> 
 <tr> 
 <td style="width:303px;vertical-align:top;height:52px;">feign. Contract</td> 
 <td style="width:256px;vertical-align:top;height:52px;">支持的注解格式</td> 
 <td style="width:678px;vertical-align:top;height:52px;">默认是SpringMVC的注解</td> 
 </tr> 
 <tr> 
 <td style="width:303px;vertical-align:top;height:52px;">feign. Retryer</td> 
 <td style="width:241px;vertical-align:top;height:52px;">失败重试机制</td> 
 <td style="width:1203px;vertical-align:top;height:52px;">请求失败的重试机制，默认是没有，不过会使用Ribbon的重试(feign没有失败重试而Ribbon有失败重试)</td> 
 </tr> 
 </tbody> 
</table>

### 2.1 配置Fegin日志两种方式 ###

在order-service中

#### 2.1.1 配置文件方式 ####

##### 2.1.1.1 全局生效 #####

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

##### 2.1.1.2 局部生效 #####

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

我怕们除了sql语句之外，还有响应头等信息，确实比之前全一点

![718e41457d8a71787191d2b7394beda6.png][]

#### 2.1.2 java代码方式 ####

注意看，这个类并没有加注解，所以不可能生效

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

那怎么生效呢？

**如果是全局配置，则把它放到@EnableFeignClients这个注解中：**

对所有的服务都有效

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)

**如果是局部配置，则把它放到@FeignClient这个注解中：**

只针对当前的服务有效

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

## 三、Fegin优化 ##

Fegin帮助我们把声明变成http请求，最终发别的请求的时候还会用到一些别的客户端

**Feign底层的客户端实现：**

*  URLConnection：默认实现，不支持连接池（JDK中自带的发请求的客户端，性能低）

*  Apache HttpClient ：支持连接池（推荐）

*  OKHttp：支持连接池（推荐）

**连接池的作用：减少连接、创建、销毁的性能损耗**

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

*  使用连接池代替默认的URLConnection

*  日志级别，最好用basic或none（不开日志的情况下，性能会提高很多）

### 3.1 引入httpClient依赖 ###

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

### 3.2 配置连接池 ###

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

### 3.3 总结 ###

*  日志级别尽量用basic

*  使用HttpClient或OKHttp代替URLConnection

*  引入feign-httpClient依赖

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

## 四、最佳实践分析 ##

### 4.2 方式1 继承 ###

给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

我们可以对照一下这两个方法（下面是user-service中的方法，上面是order-service中的方法），除了方法名不一样之外，其他都一样。既然他们长得一模一样，我们就可以做抽取

![afa042b97b1087ff67b309effc1cda07.png][]

下面进行更改

![cd4846084b9f10e54421b47169bd6fe9.png][]

### 4.2 方式2 抽取 ###

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

将client、实体类、默认配置等都抽取出来组成一个jar包，别人引用依赖直接就可调用

![6b0376c72f82fb0854b5cc1177622184.png][]

#### 4.2.1 实现步骤 ####

*  首先创建一个module，命名为feign-api，然后引入feign的starter依赖

*  将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

*  在order-service中引入feign-api的依赖

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

*  重启测试

##### 4.2.1.1 新建module并引入feign的starter依赖 #####

![a9a538595e058d12bd18f7e6b9990f38.png][]

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

将order-service下面的类抽取到这里

![6c09bc15cb9ae43508881707d7449872.png][]

##### 4.2.1.2 order-service引用feign-api依赖 #####

这个依赖是我们刚刚编写的module

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

我们修改order-service之后，与Feign相关的只有下面这个代码

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)
    public class OrderApplication {}

##### 4.2.1.3 重启后的问题 #####

重启之后，我们发现他说Field userClient in cn.itcast.order.service.OrderService required a bean of type 'cn.itcast.feign.clients.UserClient' that could not be found.

无法创建cn.itcast.feign.clients.UserClient这个bean

![9f591eac58493132961b69aff33fc231.png][]

**那是怎么回事呢？**

**编译成功了，但是无法编译这个类**

我们启动的项目的启动类是orderApplication，他会加载cn.itcast.order包下的所有文件

但是！！！我们的cn.itcast.feign.clients.UserClient并不在这个包下，而是在feign-api项目下cn.itcast.fegin包下，很显然是扫描不到的，因此无法创建实例对象

**怎么解决这个问题？**

\*\*方式1：\*\*指定FeignClient所在包

将包直接拿过来批量的搞

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

\*\*方式2：\*\*指定FeignClient字节码(**推荐**)

精准定位，这个地方可以定位多个写成数组的方式，如果只有一个的话不写成数组也是可以的

多加了字段之后就可以成功启动

@EnableFeignClients(clients = {UserClient.class})

@EnableFeignClients(clients = {UserClient.class},defaultConfiguration = DefaultFeignConfiguration.class)
    public class OrderApplication {}

[OpenFeign_feign_ Feign makes writing java http clients easier _github.com]: https://github.com/OpenFeign/feign
[localhost_8080_order_101]: http://localhost:8080/order/101
[7524511614e7e046bc4f506e0797c412.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/ca7b5ddc3971416e9aabed1f30525190.png
[718e41457d8a71787191d2b7394beda6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/c2192be37e704604a4841d12261d9600.png
[afa042b97b1087ff67b309effc1cda07.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/8beb83576aa841219a6b7686d8e56866.png
[cd4846084b9f10e54421b47169bd6fe9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/60227910a4d74230be4e0c75b0aaca05.png
[6b0376c72f82fb0854b5cc1177622184.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a4d6ac06316f4219a4ddf1c81c7e1685.png
[a9a538595e058d12bd18f7e6b9990f38.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/49e47e67dde2432e8171db5ae714d441.png
[6c09bc15cb9ae43508881707d7449872.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/64fc80b51bcf4b08a95ad1b7b164938b.png
[9f591eac58493132961b69aff33fc231.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fa6403f476ae4d26858422e9513d2560.png