Bootstrap

SpringCloud-OpenFeign拓展-连接池、最佳使用方法、日志输出

目录

1 OpenFeign连接池

1.1 常见连接类型

1.2 连接池使用方法

1.2.1 引入依赖

1.2.2 开启连接池功能

1.2.3 配置完成,重启实例即可,底层将更改设置。

2 OpenFeign最佳使用方法

2.1 每个微服务都是单独的project,内部有三个独立模块

2.2 每个微服务都是一个module,一个project,内设单独api module

2.3 可根据项目的调整所使用的项目架构,选择最好的使用方法。

3 OpenFeign日志输出

3.1 关于OpenFeign中日志的默认设置

3.2 更改OpenFeign日志设置,使其输出日志

3.2.1 检查Feign所在module日志是否为debug级别

3.2.2 自定义日志级别需要声明一个类型为Logger.Level的Bean,在其中定义日志级别

4 总结

4.1 如何利用OpenFeign实现远程调用?

4.2 如何配置OpenFeign的连接池?

4.3 OpenFeign使用的最佳实践方式是什么?

4.4 如何配置OpenFeign输出日志的级别?


在OpenFeign发起远程调用时,默认是请求一次建立一次连接,然后断开,消耗资源,因此推荐使用连接池。

1 OpenFeign连接池

1.1 常见连接类型

OpenFeign对Http请求做了优雅的伪装,不过其底层发起http请求,依赖于其它的框架。这些框架可以自己选择,包括以下三种:

  • HttpURLConnection: 默认实现,不支持连接池
  • Apache HttpClient:支持连接池
  • OKHttp: 支持连接池

具体源码可以参考FeignBlockingLoadBalancerClient类中的delegate成员变量。

1.2 连接池使用方法

此处示例使用OKHttp

1.2.1 引入依赖

<!--OKHttp-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-okhttp</artifactId>
</dependency>

1.2.2 开启连接池功能

在yaml配置文件中添加

feign:
  okhttp:
    enable:true

1.2.3 配置完成,重启实例即可,底层将更改设置。

2 OpenFeign最佳使用方法

OpenFeign在实践中,尤其是FeignClient维护的过程中有两种常见的项目结构

2.1 每个微服务都是单独的project,内部有三个独立模块

每个微服务再下再建立三个模块。其中dto中存放实体类,api模块中存放接口类,biz中则是业务代码。(耦合度低,项目结构较为复杂,适合每个微服务都是一个单独的project情况,大型项目

2.2 每个微服务都是一个module,一个project,内设单独api module

第二种,是抽取的形式,将FeignClient,配置,实体等公共部分抽取为一个单独的api模块。(结构简单,耦合度高一些,适合多个微服务从属于同一个project,中小型项目

2.3 可根据项目的调整所使用的项目架构,选择最好的使用方法。

3 OpenFeign日志输出

3.1 关于OpenFeign中日志的默认设置

OpenFeign,只会在FeignClient所在包的日志级别为DEBUG时,才会输出日志。而且其日志级别有4级:

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

由于OpenFeign,默认的日志级别就是NONE,所以默认我们看不到请求日志。

3.2 更改OpenFeign日志设置,使其输出日志

3.2.1 检查Feign所在module日志是否为debug级别

首先关于项目中包(module)的基本设置,在yaml文件中检查配置(注意改为自己的包名):

logging:
  level:
    com.example:debug

3.2.2 自定义日志级别需要声明一个类型为Logger.Level的Bean,在其中定义日志级别

一般定义在api微服务模块汇总的config文件中:

定义如下类(此类后续还可以添加其他Feign配置):

public class DefaultFeignConfig {
    @Bean
    public Logger.Level feignLoggerLevel(){
        return  Logger.Level.FULL;
    }

}

但此时这个Bean并未生效,要想配置某个FeignClient的日志,可以在@FeignClient注解中声明(不建议,建议全局使用,看下一条):

@Feignclient(value "item-service",configuration DefaultFeignConfig.class)


如果想要全局配置,让所有FeignClienta都按照这个日志配置,则需要在启动类中的@EnableFeignClients注解中声明(此时@Feignclient则不需要了,有全局即可):

@EnableFeignclients(defaultConfiguration DefaultFeignConfig.class)

4 总结

4.1 如何利用OpenFeign实现远程调用?

  1. 引入OpenFeign和SpringCloudLoadBalancer依赖
  2. 利用@EnableFeignClients:注解开启OpenFeign功能
  3. 编写FeignClient

4.2 如何配置OpenFeign的连接池?

  1. 引入http客户端依赖,例如OKHttp、HttpClient
  2. 配置yaml文件,打开OpenFeign连接池开关

4.3 OpenFeign使用的最佳实践方式是什么?


由服务提供者编写独立module,将FeignClient及DTO抽取

4.4 如何配置OpenFeign输出日志的级别?

  1. 声明类型为Logger.Level的Bean
  2. 在@FeignClient或@EnableFeignClients注解上使用(@EnableFeignclients(defaultConfiguration DefaultFeignConfig.class))
;