【Spring Cloud H 版教程】第七篇：远程调用服务组件OpenFeign 之进阶

素颜马尾好姑娘i 2023-03-13 06:23 25阅读 0赞

## 1 概述 ##

前面一篇文章 [【远程调用服务组件OpenFeign 之入门】][OpenFeign] 中我们已经简单介绍了 OpenFeign 的使用情况，OpenFeign 作为一个 HTTP 客户端组件，还有很多功能特性是需要我们掌握的，例如切换底层 HTTP 实现组件、超时重试配置，容错处理等等，我们将在这篇文章中介绍 OpenFeign 的进阶内容，而容错处理则在后面介绍 Hystrix 组件时再详细介绍。

## 2 切换客户端 ##

当使用 Feign 时，默认会加载 FeignRibbonClientAutoConfiguration 配置类，该配置类会通过 @Import 导入三个 HTTP 客户端实现配置类：HttpClientFeignLoadBalancedConfiguration、OkHttpFeignLoadBalancedConfiguration、DefaultFeignLoadBalancedConfiguration ，分别对应了 ApacheHttpClient、OkHttpClient、Default（HttpURLConnection），Feign 默认使用 HttpURLConnection 作为其 HTTP 客户端实现。

@Import({  HttpClientFeignLoadBalancedConfiguration.class,
    		OkHttpFeignLoadBalancedConfiguration.class,
    		DefaultFeignLoadBalancedConfiguration.class })
    public class FeignRibbonClientAutoConfiguration { 
    	//......省略部分代码
    }

### 2.1 使用 OkHttp ###

**第一步**：在 POM 中加入 OkHttp 依赖。

<dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-okhttp</artifactId>
        <version>10.7.2</version>
    </dependency>

**第二步**：在 application.yml 文件中开启 okhttp。

feign:
      okhttp:
        enabled: true #使用 okhttp HTTP 客户端
      httpclient:
        max-connections: 100 #连接池个数，默认200
        max-connections-per-route: 30 #单个路径的最大连接数，默认50

### 2.2 源码分析 ###

通过上面两步即可切换使用 OkHttp，重启消费者服务 cloud-feign-consumer 后将会加载 OkHttpFeignLoadBalancedConfiguration 配置类：

@Configuration(proxyBeanMethods = false)
    @ConditionalOnClass(OkHttpClient.class)
    @ConditionalOnProperty("feign.okhttp.enabled")
    @Import(OkHttpFeignConfiguration.class) //导入 OkHttpFeignConfiguration 配置类
    class OkHttpFeignLoadBalancedConfiguration { 
    
    	@Bean
    	@ConditionalOnMissingBean(Client.class)
    	public Client feignClient(CachingSpringLoadBalancerFactory cachingFactory,
    			SpringClientFactory clientFactory, okhttp3.OkHttpClient okHttpClient) { 
    		OkHttpClient delegate = new OkHttpClient(okHttpClient);
    		// 通过 OkHttpClient 构建 LoadBalancerFeignClient
    		return new LoadBalancerFeignClient(delegate, cachingFactory, clientFactory);
    	}
    
    }

该配置类通过 @Import(OkHttpFeignConfiguration.class)，先加载 OkHttpFeignConfiguration 配置类，完成 OkHttpClient 和连接池 ConnectionPool 的构建工作：

@Configuration(proxyBeanMethods = false)
    @ConditionalOnMissingBean(okhttp3.OkHttpClient.class)
    public class OkHttpFeignConfiguration { 
    
    	//......省略部分代码
    
    	/**构建连接池*/
    	@Bean
    	@ConditionalOnMissingBean(ConnectionPool.class)
    	public ConnectionPool httpClientConnectionPool(
    			FeignHttpClientProperties httpClientProperties,
    			OkHttpClientConnectionPoolFactory connectionPoolFactory) { 
    		Integer maxTotalConnections = httpClientProperties.getMaxConnections();
    		Long timeToLive = httpClientProperties.getTimeToLive();
    		TimeUnit ttlUnit = httpClientProperties.getTimeToLiveUnit();
    		return connectionPoolFactory.create(maxTotalConnections, timeToLive, ttlUnit);
    	}
    
    	/**构建 OkHttpClient */
    	@Bean
    	public okhttp3.OkHttpClient client(OkHttpClientFactory httpClientFactory,
    			ConnectionPool connectionPool,
    			FeignHttpClientProperties httpClientProperties) { 
    		Boolean followRedirects = httpClientProperties.isFollowRedirects();
    		Integer connectTimeout = httpClientProperties.getConnectionTimeout();
    		this.okHttpClient = httpClientFactory
    				.createBuilder(httpClientProperties.isDisableSslValidation())
    				.connectTimeout(connectTimeout, TimeUnit.MILLISECONDS)
    				.followRedirects(followRedirects).connectionPool(connectionPool).build();
    		return this.okHttpClient;
    	}

## 3 超时 ##

Feign 远程服务调用的默认超时时间为 1 秒，这会导致消费者服务在调用一些提供者服务耗时较长的接口时获取不到响应结果，为了处理该问题，我们可以在配置文件或者配置类中手动调整该超时默认值：

# feign 配置
    feign:
      client:
        config:
          default:
            connectTimeout: 5000 #连接超时时间
            readTimeout: 5000 #读取结果超时

@Bean
    public Request.Options options(){ 
        return new Request.Options(5000,5000);
    }

## 4 重试 ##

### 4.1 重试原理 ###

Feign 还提供了重试功能（默认不重试），重试功能和超时功能密切相关，只有远程调用过程耗时超过了超时限制后，才会试图去发起重试请求操作。一旦远程调用在超时范围内返回了结果将不会发起重试操作。Feign 重试由 Retryer 来完成，它包含了三个属性：period、maxPeriod 和 maxAttempts，maxAttempts 表示重试的最大次数，包含首次调用，period 表示重试周期间隔，maxPeriod 表示最大重试周期间隔。下图是在设置 maxAttempts 为 5 的情况下，重试调用过程图：  
![在这里插入图片描述][2020051314332072.png_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA3Mzk1NTE_size_16_color_FFFFFF_t_70]  
红色方块表示的是超时时长，绿色方块表示重试间隔周期，总共发起了 5 次请求，发生 4 次重试周期间隔等待。可以看到重试间隔周期并不是固定时长的，而是逐次增长，但间隔时长总在 period 和 maxPeriod 之间。所以如果当提供者服务的接口耗时超过了超时时长时，那么消费者服务将总共会发起 5 次调用，整个过程耗时将是上面所有红绿方块时长总和。

### 4.2 配置重试 ###

public class MyFeignConfig { 
    
        /**重试策略，默认不重试*/
        @Bean
        public Retryer feignRetryer(){ 
            Retryer retryer = new Retryer.Default(1000, 10000, 5);
            return retryer;
        }
    }

### 4.3 测试重试 ###

我们将提供者服务 cloud-feign-provider 接口睡眠 3 秒，模拟长耗时方法：

@GetMapping("/echo/{id}")
        public UserInfo echo(@PathVariable("id") Long id) throws Exception{ 
            log.info("echo,id:{}",id);
            //休眠3秒
            TimeUnit.SECONDS.sleep(3);
            return new UserInfo(id,"luke",18,new Date());
        }

消费者服务 cloud-feign-consumer 的超时时长设为 1 秒，让其可以触发重试机制：

# feign 配置
    feign:
      client:
        config:
          default:
            connectTimeout: 1000 #连接超时时间
            readTimeout: 1000 #读取结果超时

使用上面 4.2 的重试配置之后，记住需要运用到 Feign 上，例如下面的在主启动类的全局配置：

@EnableFeignClients(defaultConfiguration = MyFeignConfig.class)

重启提供者服务和消费者服务，发起请求可以在提供者服务控制台看到请求的间隔变化情况：

2020-05-13 14:34:58.268  INFO 141100 --- [nio-8084-exec-1] c.l.s.c.FeignProviderController          : echo,id:10
    2020-05-13 14:35:00.778  INFO 141100 --- [nio-8084-exec-3] c.l.s.c.FeignProviderController          : echo,id:10
    2020-05-13 14:35:04.031  INFO 141100 --- [nio-8084-exec-5] c.l.s.c.FeignProviderController          : echo,id:10
    2020-05-13 14:35:08.410  INFO 141100 --- [nio-8084-exec-6] c.l.s.c.FeignProviderController          : echo,id:10
    2020-05-13 14:35:14.475  INFO 141100 --- [nio-8084-exec-4] c.l.s.c.FeignProviderController          : echo,id:10

## 5 @SpringQueryMap ##

### 5.1 说明 ###

Feign 在 2.1.0 版本开始增加了一个注解 @SpringQueryMap，该注解的目的是用于在 GET 请求情况下，让消费者服务将接口参数对象转换为 GET 参数（包含请求在路径上）。在此之前的版本如果不做额外处理是无法在 GET 请求上传递对象参数的。

### 5.2 GET请求传递对象参数 ###

下面我们就来在提供者服务 cloud-feign-provider 新建一个需要传递对象参数的 GET 请求方法：

@Slf4j
    @RequestMapping("/provider")
    @RestController
    public class FeignProviderController { 
    	
    	/**参数是对象的GET请求方法*/
        @GetMapping("/query")
        public UserInfo queryUserInfo(UserInfo userInfo){ 
            log.info("queryUserInfo,userInfo:{}",userInfo);
            return new UserInfo(userInfo.getId(),"luke",18,new Date());
        }
    }

在消费者服务 cloud-feign-consumer 的 Feign 接口类增加该远程服务接口：

@FeignClient(name = "cloud-feign-provider")
    public interface ProviderFeignClient { 
    
        @GetMapping("/provider/query")
        UserInfo queryUserInfo(UserInfo userInfo);
    
    }

在 FeignConsumerController 类远程调用该服务接口：

@Slf4j
    @RequestMapping("/consumer")
    @RestController
    public class FeignConsumerController { 
    
        @Resource
        private ProviderFeignClient providerFeignClient;
    
        @GetMapping("/query/{id}")
        public UserInfo consumerQueryUserInfo(@PathVariable("id") Long id){ 
            log.info("consumerQueryUserInfo,id:{}",id);
            UserInfo userInfo = new UserInfo();
            userInfo.setId(id);
            return providerFeignClient.queryUserInfo(userInfo);
        }
    
    }

在浏览器输入消费者服务方法路径 [http://localhost:8085/consumer/query/10][http_localhost_8085_consumer_query_10] ，将返回 500 错误，同时控制台会打印出下面的错误信息：

java.lang.IllegalArgumentException: method GET must not have a request body.

### 5.3 使用 @SpringQueryMap ###

SpringMVC 本身是支持 GET 请求传递对象参数的，OpenFeign 为了支持该种特性增加了注解 @SpringQueryMap，所以只需要将其添加到 Feign 接口类对应的方法对象参数上即可解决该问题：

@FeignClient(name = "cloud-feign-provider")
    public interface ProviderFeignClient { 
    
        /**@SpringQueryMap 让GET请求参数也可以是对象类型*/
        @GetMapping("/provider/query")
        UserInfo queryUserInfo(@SpringQueryMap UserInfo userInfo);
    
    }

## 6 内容压缩 ##

Feign 提供了对请求响应数据的压缩，使用该功能之后，在传输数据超过指定限制大小之后将执行压缩操作，采用 GZIP 压缩。需要注意的是压缩之后远程调用会将数据先转换成字节数组，所以结果接收需要使用 ResponseEntity<byte\[\]> 。通过下面的配置开启内容压缩功能：

feign:
      compression:
        request:
          enabled: true
          mime-types: text/xml,application/xml,application/json # 配置压缩支持的MIME TYPE
          min-request-size: 2048 # 配置压缩数据大小的下限
        response:
          enabled: true # 配置响应GZIP压缩

## 7 拦截器 ##

Feign 提供了拦截器 RequestInterceptor ，它会在每次发起远程服务接口调用时执行，我们可以通过该拦截器往 HTTP 协议包上添加一些公共数据：

public class MyFeignConfig { 
    
        //拦截器
        @Bean
        public RequestInterceptor requestInterceptor(){ 
            return requestTemplate -> { 
            	//事务id
                requestTemplate.header("username", "123456");
            };
        }
    
    }

作者在自己编写的开源 TCC 分布式事务项目 milo 中，正式通过 RequestInterceptor 拦截器传递了事务的上下文信息：  
![在这里插入图片描述][20200513161724552.png_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA3Mzk1NTE_size_16_color_FFFFFF_t_70]  
对分布式事务感兴趣的读者朋友可以在码云上搜索该项目，项目地址：[https://gitee.com/luke2017/milo][https_gitee.com_luke2017_milo]

## 8 小结 ##

我们首先介绍了 Feign 如何切换内部的 HTTP 客户端，默认使用 HttpURLConnection，它没有连接池，性能较差，实际项目开发中建议使用 OkHttp 客户端。接着我们介绍了 Feign 的超时和重试功能，超时和重试功能能够有效保护上游服务，同时在一些特殊场景下可以适当延长超时时间，实际项目开发中建议针对 GET 请求开启重试，而 POST 请求不开启重试，避免产生重复数据。接下来我们介绍了新注解 @SpringQueryMap，它能够让 Feign 也支持 SpringMVC 中 GET 请求可以传递对象参数的情况。最后我们介绍了 Feign 的压缩和拦截器功能，在特殊需求情况下可能会用到。Feign 还有一个最重要的功能没有说到，那就是容错处理，容错处理是结合 Hystrix 一起使用的，后面讲到 Hystrix 组件时将会详细介绍到该功能。

代码工程地址：[https://gitee.com/luke2017/springcloud2020][https_gitee.com_luke2017_springcloud2020]

如果觉得对您有帮助的话，就帮忙给作者公众号点个关注吧！！！

![在这里插入图片描述][20200429145323478.gif_pic_center]

参考：

[https://www.jdon.com/50638][https_www.jdon.com_50638]

[https://jmnarloch.wordpress.com/2015/10/14/spring-cloud-feign-oauth2-authentication/][https_jmnarloch.wordpress.com_2015_10_14_spring-cloud-feign-oauth2-authentication]

[https://baijiahao.baidu.com/s?id=1657040848272968659&wfr=spider&for=pc][https_baijiahao.baidu.com_s_id_1657040848272968659_wfr_spider_for_pc]

[https://blog.51cto.com/zero01/2424667][https_blog.51cto.com_zero01_2424667]

[https://blog.csdn.net/u014437791/article/details/96479371][https_blog.csdn.net_u014437791_article_details_96479371]

[OpenFeign]: https://blog.csdn.net/u010739551/article/details/106056987
[2020051314332072.png_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA3Mzk1NTE_size_16_color_FFFFFF_t_70]: /images/20230312/0c7fe96fa2384ed7b6ddeced3892e71f.png
[http_localhost_8085_consumer_query_10]: http://localhost:8085/consumer/query/10
[20200513161724552.png_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA3Mzk1NTE_size_16_color_FFFFFF_t_70]: /images/20230312/12c79ed617304354bdb1f23f9bd39959.png
[https_gitee.com_luke2017_milo]: https://gitee.com/luke2017/milo
[https_gitee.com_luke2017_springcloud2020]: https://gitee.com/luke2017/springcloud2020
[20200429145323478.gif_pic_center]: /images/20230312/fedf9b0d2e264009b89852fbdb2c7fad.png
[https_www.jdon.com_50638]: https://www.jdon.com/50638
[https_jmnarloch.wordpress.com_2015_10_14_spring-cloud-feign-oauth2-authentication]: https://jmnarloch.wordpress.com/2015/10/14/spring-cloud-feign-oauth2-authentication/
[https_baijiahao.baidu.com_s_id_1657040848272968659_wfr_spider_for_pc]: https://baijiahao.baidu.com/s?id=1657040848272968659&wfr=spider&for=pc
[https_blog.51cto.com_zero01_2424667]: https://blog.51cto.com/zero01/2424667
[https_blog.csdn.net_u014437791_article_details_96479371]: https://blog.csdn.net/u014437791/article/details/96479371