OpenFeign的高级配置和最佳实践

源码：https://gitee.com/qing11/learning-demo.git

源码目录：微服务：08 和 09

目录：

1. OpenFeign的自定义配置
2. OpenFeign的使用优化
3. OpenFeign的最佳实践

一、OpenFeign的自定义配置

Feign可以支持很多的自定义配置，如下表所示：

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

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

1、Java代码方式

可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

/**
 * OpenFeign的配置
 */
public class DefaultFeignConfiguration {

    /**
     * 配置日志基本
     * @return
     */
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到 启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

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

2、还可以用 配置文件方式

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

而日志的级别分为四种：

1. - NONE：不记录任何日志信息，这是默认值。
2. - BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
3. - HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
4. - FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

日志的级别如果没有特殊要求，一般使用 NONE、BASIC 两个就好了，默认是NONE。

二、OpenFeign的使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

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

因此提高Feign的性能主要手段就是使用**连接池**代替默认的URLConnection。

这里我们用Apache的HttpClient来演示。

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

2）配置连接池

在order-service的application.properties中添加配置：

# 开启feign对HttpClient的支持
feign.httpclient.enabled=true
# 最大的连接数
feign.httpclient.max-connections=200
# 每个路径的最大连接数
feign.httpclient.max-connections-per-route=50

总结，Feign的优化：

1.日志级别尽量用basic

2.使用 HttpClient 或 OKHttp 代替 URLConnection

①  引入feign-httpClient依赖

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

三、OpenFeign的最佳实践

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式。

这里的方式是使用【抽取方式】

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

中，提供给所有消费者使用。

例如，将UserClients、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依

赖包，即可直接使用。

1、实现基于抽取的最佳实践

1）抽取

首先创建一个module，命名为feign-api

 

项目结构：

在feign-api中然后引入feign的starter依赖

<!--feign客户端依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项

目中

2）在order-service中使用feign-api

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

在order-service的pom文件中中引入feign-api的依赖：

<!--引入feign的统一api-->
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>feign-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

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

3）重启测试

重启后，发现服务报错了：

这是因为 UserClients 现在在 cn.itcast.feign.clients 包下，

而order-service的 @EnableFeignClients 注解是在cn.itcast.order 包下，不在同一个包，无法扫描到 UserClients。

4）解决扫描包问题

在启动类中的 @EnableFeignClients 添加如下：

方式一：

指定Feign应该扫描的包：

@EnableFeignClients(basePackages = "orderservice.feign.clients")

 方式二：

@EnableFeignClients(clients = {UserClients.class})