SpringCloud组件--Feign远程调用

ShiShuoMing
92 阅读5分钟

一、Feign远程调用

1.基本使用
  • (1).引入依赖
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • (2).启动类开启注解@EnableFeignClients
  • (3).编写Feign客户端： 在order-service中新建一个接口，内容如下：
基于SpringMVC的注解来声明远程调用信息 且集成ribbon实现负载均衡
@FeignClient("user-service") //服务名称
public interface UserClient {
    @GetMapping("/user/{id}") //请求方式+路径
    User findById(@PathVariable("id") Long id);
}
  • (4).测试(根据id返回订单信息) image.png
2.自定义配置

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)配置文件方式--可以基于配置文件(例如yml)修改feign的日志级别
    • 局部生效：可以针对单个服务：
    • 全局生效：也可以针对所有服务：
feign:  
  client:
    config: 
      userservice: # 写具体服务名称,针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

feign:  
  client:
    config: 
      default: # 使用default为全局配置
        loggerLevel: FULL #  日志级别

而日志的级别分为四种：

NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。
  • (2)Java代码方式--也可以基于Java代码来修改日志级别
    • 1.先声明一个类，然后声明一个Logger.Level的对象：
    • 2.如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：
    • 3.如果是局部生效，则把它放到对应Client的@FeignClient注解中：
public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

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

3.性能优化

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.yml中添加配置，连接数需要自己测试最佳数量：

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

(3)总结

  • Feign性能优化主要手段：

    • 日志级别尽量用basic或none

    • 使用HttpClient或OKHttp代替URLConnection

      • 引入feign-httpClient依赖
      • 配置文件开启httpClient功能，设置连接池参数
4.最佳实践方式

(1)前言

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

通过观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端： image.png UserController: image.png 有没有一种办法简化这种重复的代码编写呢？

(2)继承方式

一样的代码可以通过继承来共享：

1）定义统一的父接口作为标准，定义方法，并基于SpringMVC注解做声明。

2）Feign客户端和Controller都继承该接口 image.png

  • 优点：

    • 简单
    • 实现了代码共享

  • 缺点：

    • 官方不太推荐使用
    • 服务提供方、服务消费方紧耦合
    • 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

(3) 抽取方式

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

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。 image.png (4)实现基于抽取的最佳实践

  • 1.首先创建一个module，命名为feign-api
  • 2.在feign-api中然后引入feign的客户端依赖
  • 3.然后，order-service中编写的UserClient、User、DefaultFeignConfiguration(自定义配置类)都复制到feign-api项目中
  • 4.在order-service中引入feign-api依赖
    • 1.首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
    • 2.修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包。
    • 3.重启后，发现报错(userclient not be found)
      • 这是因为UserClient现在在cn.itcast.feign.clients包下，而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。
      • 方式一、在启动类中指定Feign应该扫描的包@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
      • 方式二 (推荐)、在启动类中指定需要加载的Client接口字节码@EnableFeignClients(clients = {UserClient.class})

feign-api模块结构

image.png

avatar
文章
阅读
粉丝