基于Feign远程调用、自定义Feign配置、性能优化及最佳实践

偏执的太偏执、 2024-04-01 19:00 87阅读 0赞

**目录**

一、基于Feign远程调用

定义和使用Feign客户端

二、自定义Feign的配置

配置Feign日志的两种方式

方式一：配置文件方式

方式二：Java代码方式

三、Feign的性能优化

四、Feign的最佳实践

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

## 一、基于Feign远程调用 ##

Feign是声明式的web service客户端，它让微服务的调用变得更简单了，类似Controller调用

service。SpringCloud集成了Ribbon和Eureka，可在使用Feign时提供负载均衡的http客户端。

官网地址：[https://github.com/OpenFeign/feign![icon-default.png_t_M85B][]https://github.com/OpenFeign/feign][https_github.com_OpenFeign_feign_icon-default.png_t_M85B_https_github.com_OpenFeign_feign]

其作用就是实现http请求的发送，解决下面提到的问题

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

String url = "http://userservice/user/"+order.getUserId();
    User user = restTemplate.getForObject(url,User.class);

存在下面的问题：

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

### 定义和使用Feign客户端 ###

1、引入依赖：

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

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

@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);
    }

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

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

4、用Feign客户端代替RestTemplate

@Autowired
        private UserClient userClient;
    
        public Order queryOrderById(Long orderId) {
            // 1.查询订单
            Order order = orderMapper.findById(orderId);
            //2、用feign远程调用
            User user = userClient.findById(order.getUserId());
            //3.封装user到Order
            order.setUser(user);
            // 4.返回
            return order;
        }

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

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

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

一般需要配置的就是日志级别

### 配置Feign日志的两种方式 ###

#### 方式一：配置文件方式 ####

1、全局生效：

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

2、局部生效：

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

#### 方式二：Java代码方式 ####

需要先声明一个Bean：

public class DefaultFeignConfiguration {
        @Bean
        public Logger.Level LogLevel(){
            return Logger.Level.BASIC;
        }
    }

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)

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

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

## 三、Feign的性能优化 ##

Feign底层的客户端实现：

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

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

> 1、使用连接此代替默认的URLConnection
> 
> 2、日志级别，最好用basic或none

Feign添加HttpClient的支持：

引入依赖：

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

配置连接池：

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

## 四、Feign的最佳实践 ##

方式一（继承）：给消费者的FeignClient和提供者controller定义统一的父接口作为标准

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

![182140a9757b4a65b32ca74e7480f062.png][]

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

![3b014124e9e34d78ae142a5a5cbdaa51.png][]

当定义的FeignClient不在SpringBootAppliction的扫描包范围时，这些FeignClient无法使用，有两种方式解决

方式一：指定FeignClient所在包

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

方式二：指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})

[icon-default.png_t_M85B]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/db80acd7789b4894b2809360a92dbc54.png
[https_github.com_OpenFeign_feign_icon-default.png_t_M85B_https_github.com_OpenFeign_feign]: https://github.com/OpenFeign/feign
[182140a9757b4a65b32ca74e7480f062.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/67b47d9a4b754b138d9cfb67a04bfbed.png
[3b014124e9e34d78ae142a5a5cbdaa51.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ed0876954d114d5083071e73d4054dd9.png