【微服务】（九）—— Feign

心已赠人 2023-09-30 13:13 14阅读 0赞

## ![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16][] ##

**目录**

一、简介

二、Feign简单应用

1）pom.xml引入Feign的依赖

2）代码改造

1、启动类添加注解 @EnableFeignClients

2、 添加调用Feign接口

三、Feign的自定义配置

1）方式一：基于配置

2）方式二：java代码方式

四、Feign 的性能优化

1）连接池配置

1、依赖引入：

2、配置连接池：

2）日志级别

五、Feign的最佳实践

方式一（继承）：

方式二（抽取）：

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

## 一、简介　　 ##

**Feign**是一个声明式 WebService 客户端，使用Feign能够让编写Web Service 客户端更加简单，它的使用方法是定义一个接口，然后在上面添加注解，同时也支持JAX-RS标准的注解。Feign也支持可插拔式的编码器和解码器。

Spring Cloud 对 Fiegn 进行了封装，使其支持了Spring MVC 标准注解和、HttpMessageConverts。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

开源项目地址：  
[https://github.com/OpenFeign/feign][https_github.com_OpenFeign_feign]

## 二、Feign简单应用 ##

### 1）pom.xml引入Feign的依赖 ###

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

### 2）代码改造 ###

#### 1、启动类添加注解 **@EnableFeignClients** ####

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

#### 2、 添加调用Feign接口 ####

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 2][]

package com.cloud.order.clients;
    
    import com.cloud.order.pojo.User;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    
    /**
     * @author ：jizhibing
     * @date ：Created in 2022/4/20
     * @description：
     */
    @FeignClient("userservice")
    public interface UserClient {
    
        @GetMapping("/user/{id}")
        User queryById(@PathVariable("id") Long id) ;
    }

3、 调用Service修改

package com.cloud.order.service;
    
    import com.cloud.order.clients.UserClient;
    import com.cloud.order.mapper.OrderMapper;
    import com.cloud.order.pojo.Order;
    import com.cloud.order.pojo.User;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.stereotype.Service;
    import org.springframework.web.client.RestTemplate;
    
    @Service
    public class OrderService {
    
        @Autowired
        private OrderMapper orderMapper;
    
        @Autowired
        private UserClient userClient ;
    
    
        public Order queryOrderById(Long orderId) {
            // 1.查询订单
            Order order = orderMapper.findById(orderId);
            //2.用Feign远程调用
            User user = userClient.queryById(order.getId());
            //3.封装User到Order
            order.setUser(user);
            // 4.返回
            return order;
    
    
    //    } public Order queryOrderById(Long orderId) {
    //        // 1.查询订单
    //        Order order = orderMapper.findById(orderId);
    //        //2.利用restTemplate 发起http请求，查询用户
            String url = "http://localhost:8881/user/"+order.getId();
    //        String url = "http://userserver/user/"+order.getId();
    //        User user = restTemplate.getForObject(url,User.class);
    //        //3.设置用户信息
    //        order.setUser(user);
    //        // 4.返回
    //        return order;
        }
    }

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

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

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

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

**Feign日志配置有2种方式：**

### 1）方式一：基于配置 ###

1、全局生效：

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

2、局部生效：

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

日志：

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 3][]

### 2）方式二：java代码方式 ###

*  1、先声明一个Bean

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

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

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.**class**)

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 4][]

*  3、如果是局部变量，则把它放到 @FeignClient 这个注解里

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

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 5][]

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

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

*  **URLConnection**: 默认实现，不支持连接池
 *  **Apache HttpClient** ：支持连接池
 *  **OkHttp**：支持连接池

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

*  1、使用连接池替代默认的URLConnection
 *  2、日志级别，最好用BASIC或者NONE

### 1）连接池配置 ###

#### 1、依赖引入： ####

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

#### 2、配置连接池： ####

feign:
      client:
        config:
          default:  #这里的default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
            loggerLevel: FULL #日志级别
      httpclient:
        enabled: true   #开启feign对httpClient对支持
        max-connections: 200  #最大对连接数
        max-connections-per-route: 50 #每个路径对最大连接数

### 2）日志级别 ###

日志级别尽量BASIC

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

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

### 方式一（继承）： ###

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

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 6][]

### 方式二（抽取）： ###

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

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 7][]

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 8][]

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/c9811edb92b44c84924acf6c90d9ba3d.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[https_github.com_OpenFeign_feign]: https://github.com/OpenFeign/feign
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/ddc0413dd7124d538afde4fa0630da0e.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/f7d3a7a6b39b47d0ab92de4b7924cb38.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/3ba7897d69c74d06b750f50ba972d981.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/2ef1b0b479af4c6ebdaaae6ae8d6954c.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 5]: https://img-blog.csdnimg.cn/f8ecd9060ea74769b3da438a8727f978.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 6]: https://img-blog.csdnimg.cn/0f255227e372458981243f8d5a8ba948.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 7]: https://img-blog.csdnimg.cn/ac60ebc32c5f453291194aa3cd2d8ad3.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5py65pm65YW1_size_20_color_FFFFFF_t_70_g_se_x_16 8]: https://img-blog.csdnimg.cn/4e680c017f4d4703994888a6b8755b33.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5py65pm65YW1,size_20,color_FFFFFF,t_70,g_se,x_16