微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档

文章目录

  • OpenFeign
      • 其作用就是基于SpringMVC的常见注解,帮我们优雅的==实现http请求的发送==。
    • RestTemplate实现了服务的远程调用
  • OpenFeign快速入门
      • 负载均衡组件==SpringCloudLoadBalancer==
    • 1.引入依赖
    • 2.启用OpenFeign
    • 3.编写OpenFeign客户端
    • 4.使用FeignClient
  • 连接池
    • OpenFeign整合OKHttp的步骤
  • 最佳实践
    • 思路分析
    • 日志配置
    • 小结:


OpenFeign

OpenFeign是一个声明式的http客户端,是SpringCloud在Eureka公司开源的Feign基础上改造而来。

其作用就是基于SpringMVC的常见注解,帮我们优雅的实现http请求的发送

官方地址:https://github.com/OpenFeign/feign
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第1张图片

在这里插入图片描述
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第2张图片

RestTemplate实现了服务的远程调用

我们利用Nacos实现了服务的治理,利用RestTemplate实现了服务的远程调用。但是远程调用的代码太复杂了:
而且这种调用方式,与原本的本地方法调用差异太大,编程时的体验也不统一,一会儿远程调用,一会儿本地调用。
因此,我们必须想办法改变远程调用的开发模式,让远程调用像本地方法调用一样简单。而这就要用到OpenFeign组件了。

其实远程调用的关键点就在于四个:

  • 请求方式
  • 请求路径
  • 请求参数
  • 返回值类型

微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第3张图片

OpenFeign快速入门

所以,OpenFeign就利用SpringMVC的相关注解来声明上述4个参数,然后基于动态代理帮我们生成远程调用的代码,而无需我们手动再编写,非常方便。

  1. 引入依赖,包括OpenFeign和负载均衡组件SpringCloudLoadBalancer
  2. 通过@EnableFeignClients注解,启用OpenFeign功能
  3. 编写FeignClien
  4. 使用FeignClient,实现远程调用

负载均衡组件SpringCloudLoadBalancer

1.引入依赖

在cart-service服务的pom.xml中引入OpenFeign的依赖和loadBalancer依赖:

  
  <dependency>
      <groupId>org.springframework.cloudgroupId>
      <artifactId>spring-cloud-starter-openfeignartifactId>
  dependency>
  
  <dependency>
      <groupId>org.springframework.cloudgroupId>
      <artifactId>spring-cloud-starter-loadbalancerartifactId>
  dependency>

2.启用OpenFeign

接下来,我们在cart-service的CartApplication启动类上添加注解,启动OpenFeign功能:
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第4张图片

3.编写OpenFeign客户端

在cart-service中,定义一个新的接口,编写Feign客户端:
其中代码如下:

package com.hmall.cart.client;

import com.hmall.cart.domain.dto.ItemDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@FeignClient("item-service")
public interface ItemClient {

    @GetMapping("/items")
    List<ItemDTO> queryItemByIds(@RequestParam("ids") Collection<Long> ids);
}

这里只需要声明接口,无需实现方法。接口中的几个关键信息:

  • @FeignClient(“item-service”) :声明服务名称
  • @GetMapping :声明请求方式
  • @GetMapping(“/items”) :声明请求路径
  • @RequestParam(“ids”) Collection ids :声明请求参数
  • List :返回值类型

有了上述信息,OpenFeign就可以利用动态代理帮我们实现这个方法,并且向http://item-service/items发送一个GET请求,携带ids为请求参数,并自动将返回值处理为List。
我们只需要直接调用这个方法,即可实现远程调用了。

4.使用FeignClient

最后,我们在cart-service的com.hmall.cart.service.impl.CartServiceImpl中改造代码,直接调用ItemClient的方法:
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第5张图片

feign替我们完成了服务拉取、负载均衡、发送http请求的所有工作,是不是看起来优雅多了。

而且,这里我们不再需要RestTemplate了,还省去了RestTemplate的注册。

连接池

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

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

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

OpenFeign整合OKHttp的步骤

此我们通常会使用带有连接池的客户端来代替默认的HttpURLConnection。比如,我们使用OK Http.

1.引入依赖


<dependency>
  <groupId>io.github.openfeigngroupId>
  <artifactId>feign-okhttpartifactId>
dependency>

2.开启连接池
在cart-service的application.yml配置文件中开启Feign的连接池功能:

feign:
  okhttp:
    enabled: true # 开启OKHttp功能

重启服务,连接池就生效了。

3.验证
我们可以打断点验证连接池是否生效,在org.springframework.cloud.openfeign.loadbalancer.FeignBlockingLoadBalancerClient中的execute方法中打断点:
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第6张图片
Debug方式启动cart-service,请求一次查询我的购物车方法,进入断点:
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第7张图片
可以发现这里底层的实现已经改为OkHttpClient

最佳实践

微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第8张图片
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第9张图片
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第10张图片

思路分析

相信大家都能想到,避免重复编码的办法就是抽取。不过这里有两种抽取思路:

  • 思路1:抽取到微服务之外的公共module
  • 思路2:每个微服务自己抽取一个module

微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第11张图片
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第12张图片
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第13张图片

方案1抽取更加简单,工程结构也比较清晰,但缺点是整个项目耦合度偏高。
方案2抽取相对麻烦,工程结构相对更复杂,但服务之间耦合度降低。

日志配置

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

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

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

1.定义日志级别
在hm-api模块下新建一个配置类,定义Feign的日志级别:

微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第14张图片
2.配置
接下来,要让日志级别生效,还需要配置这个类。有两种方式:
微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第15张图片

小结:

微服务--03--OpenFeign 实现远程调用 (负载均衡组件SpringCloudLoadBalancer)_第16张图片

你可能感兴趣的:(SpringCloud,微服务,架构,云原生)