【微服务】8、http客户端Feign

定义和使用Feign客户端

Feign的介绍

Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

使用Feign客户端

引入依赖

1
2
3
4
5
<!-- OpenFeign -->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

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

编写Feign客户端

1
2
3
4
5
@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

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

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

用Feign客户端代替RestTemplate

自定义Feign的配置

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

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

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

配置Feign日志有两种方式:

方式一:配置文件方式

全局生效:

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

局部生效:

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

方式二:java代码方式,需要先声明一个Bean:

1
2
3
4
5
6
public class FeignClientConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC;
    }
}

而后如果是全局配置,则把它放到@EnableFeignClients这个注解中:

1
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)

如果是局部配置,则把它放到@FeignClient这个注解中

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

Feign的性能优化

Feign底层的客户端实现:

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

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

使用连接池代替默认的URLConnection

日志级别,最好用basic或none

Feign添加HttpClient的支持:

引入依赖:

1
2
3
4
5
<!--httpClient的依赖-->
<dependency>
  <groupId>io.github.openfeign</groupId>
  <artifactId>feign-httpclient</artifactId>
</dependency>

配置连接池:

1
2
3
4
5
6
7
8
9
feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

Feign的最佳实践

方式一(继承)

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

不推荐:因为紧耦合和spring MVC的参数映射无法继承

方式二(抽取)

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

实现最佳实践方式二的步骤如下:

  1. 首先创建一个module,命名为feign-api,然后引入feign的starter依赖

  1. 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
  2. order-service中引入feign-api的依赖
  3. 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
  4. 重启测试

此时会启动失败:

这是因为springboot的启动扫描默认不会扫描到这个bean,解决办法:

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

方式一:指定FeignClient所在包

方式二:指定FeignClient字节码

使用 Hugo 构建
主题 StackJimmy 设计