SpringCloud：Feign的使用及配置

╰+哭是因爲堅強的太久メ 2024-03-26 16:37 34阅读 0赞

**目录**

Feign的使用及配置

1、Feign替代RestTemplate

2、使用Fegin步骤

3、自定义配置

4、Feign使用优化

5、Feign的最佳实践方式

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

### Feign的使用及配置 ###

#### 1、Feign替代RestTemplate ####

RestTemplate方式远程调用的问题

![5f1b3ddf73f24e9c87a67a23ab52e886.png][]

问题：

1、代码可读性差，编程体验不同统一

2、参数复杂，URL难以维护

Feign介绍

Feign是一个声明式的http客户端，官方地址：[OpenFeign · GitHub][OpenFeign _ GitHub]

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

#### **2、使用Fegin步骤** ####

1、引入依赖

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

2、在启动类添加注解开启Feign的功能

@EnableFeignClients

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

3、编写Feign客户端

@FeignClient("userservice")//服务名称
    public interface UserClient {
        @GetMapping("/user/{id}")//访问路径
        User findById(@PathVariable("id") Long id);//对应远程调用controller接口
    }

主要是基于SpringMVC的注解来声明远程调用的信息，比如:

服务名称: userservice 请求方式:GET· 请求路径:/user/\{lid\}·

请求参数:Long id· 返回值类型: User

#### **3、自定义配置** ####

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

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>作用</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>feign.Logger.Level</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>

**Feign日志配置**

1、yml文件配置

全局生效

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

局部生效

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

2、 java代码配置

定义一个配置类

public class DefaultFeignConfig {
    
        @Bean
        public Logger.Level logLevel(){
            return Logger.Level.BASIC;
        }
    }

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfig.class)

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

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

#### **4、Feign使用优化** ####

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

URLConnection:默认实现，不支持连接池.

Apache HttpClient:支持连接池

OKHttp:支持连接池

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

使用连接池代替默认的URLConnection

日志级别，最好用basic或none

1、引入依赖

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

2、配置连接池

feign:
      httpclient:
        enabled: true # 支持HttpClient的开关
        max-connections: 200 # 最大连接数
        max-connections-per-route: 50 # 单个路径的最大连接数

总结：

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

#### **5、Feign的最佳实践方式** ####

方式一（继承）：

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

![3efcb127a3ca45e29757b9a5878f9c5a.png][]

弊端：

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

方式二（抽取）：

将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，

提供给所有消费者使用  
![880f6e4c53064d1cb4aff9ac337b1af3.png][]

使用这种方式时，如果定义的FeignClient不在SpringBootApplication的扫描包范围时，这些

FeignClient无法使用。有两种方式解决:

1、指定FeignClient所在包

![f1559932b3964519b0994640797a5dec.png][]

2、指定FeignClient字节码

![0dfe6c9d6d3a467385313d19ad795b97.png][]

总结：Feign的最佳实践

1、让controller和FeignClient继承同一接口

2、将Feignclient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

[5f1b3ddf73f24e9c87a67a23ab52e886.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/71327dddf62a4ef1960fe706b4e82715.png
[OpenFeign _ GitHub]: https://github.com/openFeign
[3efcb127a3ca45e29757b9a5878f9c5a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e7f6bd85c2ba4af999e2d934543cd983.png
[880f6e4c53064d1cb4aff9ac337b1af3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/dbe333f118ff4436956ae1833320e2be.png
[f1559932b3964519b0994640797a5dec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a33dc5c04156457da51ada39110fe0d0.png
[0dfe6c9d6d3a467385313d19ad795b97.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/ab524671eb9f45ac99a6c9d0a9132496.png