微服务学习-服务调用组件 OpenFeign 实战

1. OpenFeign 接口方法编写规范

1.1. 在编写 OpenFeign 接口方法时，需要遵循以下规范

1.1.1.1. 接口中的方法必须使用 @RequestMapping、@GetMapping、@PostMapping 等注解声明 HTTP 请求的类型。
1.1.1.2. 方法的参数可以使用 @RequestParam、@RequestHeader、@PathVariable 等注解来制定如何传递 HTTP 请求的参数。
1.1.1.3. 可以使用 @RequestBody 来指定如何传递请求体中的参数。
1.1.1.4. 可以使用 @HearderMap 来传递头部信息。

1.2. 案例演示

1.2.1.1. Get 请求

get 请求，参数全放 URL 中，不建议放 Body，部分浏览器可能会限制不能读取 body 中的数据；

get 请求参数过长的话，也会有问题，适用于参数不长的场景。

目标接口方法：

@GetMapping("/getOrderByUserId")
public Result<List<OrderResponse>> getOrderByUserId(@RequestParam("userId") Long userId)

OpenFeign 接口方法

@GetMapping("/getOrderByUserId")
Result<List<OrderResponse>> getOrderByUserId(@RequestParam("userId") Long userId);
1.2.1.2. post 请求
1.2.1.2.1. @RequestBody

目标接口方法：

@RequestMapping(value = "/post1")
public Result<OrderResponse> post1(@RequestBody OrderRequest orderRequest)

OpenFeign 接口方法

@PostMapping("/post1")
Result<OrderResponse> post1(@RequestBody OrderRequest orderRequest);
1.2.1.2.2. URL 后面追加参数

除了放在 body 中的参数，还能直接 url 后面追加参数，@RequestParam 注解

例如：增加参数 token http:/XXXXXXXX?token=xxxxxx

目标接口方法：

@RequestMapping(value = "/post2")
public Result<OrderResponse> post2(@RequestBody OrderRequest orderRequest, @RequestParam("token") String token)

OpenFeign 接口方法：

@PostMapping("/post2")
Result<OrderResponse> post2(@RequestBody OrderRequest orderRequest, @RequestParam("token") String token);
1.2.1.2.3. url 中加参数

url 中追加参数，参数用 @PathVariable 注解

目标接口方法：

@RequestMapping(value = "/post3/{userId}")
public Result<OrderResponse> post3(@RequestBody OrderRequest orderRequest, @PathVariable("userId") Long userId)

OpenFeign 接口方法：

@PostMapping("/post3/{userId}")
Result<OrderResponse> post3(@RequestBody OrderRequest orderRequest, @PathVariable("userId") Long userId);

2. OpenFeign 的调用流程

3. OpenFeign 常用扩展点配置

openFeign 提供了很多的扩展机制，让用户可以更加灵活的使用。

3.1. 测试环境

速通版：git checkout v2.0.0 版本：

icoolkj-microservices-code 标签 - Gitee.com

会员服务调用订单服务。

3.2. 日志配置

配置 Feign 的日志，让 Feign 把请求信息输出，方便查找问题等。

日志级别有4 种：

  • NONE【性能最佳，默认值】：不记录任何日志。
  • BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及执行时间。
  • HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
  • FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body和元数据。
3.2.1.1. 配置方式
3.2.1.1.1. Java Bean 方式

全局生效：利用 @Configuration 实现全局生效，对所有的微服务调用者都生效。

    1. 定义一个配置类，指定日志级别
// 注意： 此处配置@Configuration注解就会全局生效，如果想指定对应微服务生效，就不能配置@Configuration
@Configuration
public class FeignConfig {/*** 日志级别* @return*/@Beanpublic Logger.Level feignLoggerLevel(){return Logger.Level.FULL;}}
    1. 在 application.yml 中配置 Client 的日志级别才能正常输出日志

格式：logging.level.feign 接口包路径=debug

logging:level:com.icoolkj.mall.user.openfeign.demo.feign: debug
    1. 重启测试

分别选择日志级别进行测试，查看控制台输出结果信息。

局部生效：让指定的微服务生效，在 @FeignClient 注解中指定 configuration

@FeignClient(name = "icoolkj-mall-order01", path = "/api/order", configuration = OpenFeignConfig.class)
public interface OrderFeignService {

注意：此时配置类不能添加 @Configuration 注解 。

3.2.1.1.2. yum 配置文件方式

全局生效：配置{服务名} 为 default，对应的微服务调用者都生效。

spring:cloud:openfeign:client:config:default:loggerLevel: FULL

局部生效：配置{服务名}为具体的服务名（icoolkj-mall-order01），对调用的微服务提供者生效。

spring:cloud:openfeign:client:config:icoolkj-mall-order01:loggerLevel: FULL
3.2.1.1.3. 配置方式选择

建议使用 yml 配置，可以利用配置中心对配置进行统一管理。

3.3. 超时时间配置

3.3.1.1. OpenFeign 使用两个超时参数

connectionTimeout 可以防止由于较长的服务器处理时间而阻塞调用者。

readTimeout 从连接建立时开始应用，当返回响应花费太长时间时触发。

注意：OpenFeign 底层使用 LoadBalancer，但是超时以 OpenFeign 配置为准。

3.3.1.2. 配置方式
3.3.1.2.1. Java bean 方式

通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个参数是连接的超时时间（ms）；第二个是请求处理的超时时间（ms）。

@Bean
public Request.Options options() {return new Request.Options(3000, 5000);
}
3.3.1.2.2. yml 配置文件方式
spring:cloud:openfeign:client:config:icoolkj-mall-order01:loggerLevel: FULL# 连接超时时间connectTimeout: 3000# 请求处理超时时间readTimeout: 5000
3.3.1.2.3. 测试配置是否生效

利用 Thread.sleep 来修改订单接口调用时间，验证是否超时。

3.4. 契约配置

Spring Cloud 在 Feign 的基础上做了扩展，可以让 Feign 支持 Spring MVC 的注解来调用。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。

3.4.1.1. 配置方式
3.4.1.1.1. Java Bean 方式
@Bean
public Contract feignContract(){return new Contract.Default();
}
3.4.1.1.2. yml 配置文件方式
spring:cloud:openfeign:client:config:icoolkj-mall-order01:loggerLevel: FULL# 连接超时时间connectTimeout: 3000# 请求处理超时时间readTimeout: 5000# 指定contract: feign.Contract.Default

注意：修改契约配置后，OrderFeignService 不在支持 SpringMvc 的注解，需要使用 Feign 原生的注解。

Class OrderFeignService has annotations [FeignClient] that are not used by contract Default

@FeignClient(name = "icoolkj-mall-order01", path = "/api/order")
public interface OrderFeignService {// 使用 Feign 原生注解调用@RequestLine("GET /getOrderByUserId?userId={userId}")Result<List<OrderResponse>> getOrderByUserId(@Param("userId") Long userId);
}

3.5. 客户端组件配置

Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求，没有连接池，我们可以集成别的组件来替换掉 URLConnection，比如 Apache HttpClient5，OKHttp。

Feign 发起调用真正执行逻辑：feign.Client#execute（扩展点）

3.5.1.1. 配置 Apache HttpClient5（推荐）
3.5.1.1.1. 引入依赖
<!-- Apache HttpClient5 -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-hc5</artifactId>
</dependency>
3.5.1.1.2. 修改 yml 配置，启用 Apache HttpClient5，引入依赖后默认启用的，可以忽略
spring:cloud:openfeign:httpclient:hc5:enabled: true

关于配置可参考：org.springframework.cloud.openfeign.FeignAutoConfiguration

3.5.1.1.3. 重启测试

调用会进入 feign.hc5.ApacheHttp5Client#execute

3.5.1.2. 配置 OkHttp
3.5.1.2.1. 引入依赖
<!-- okhttp -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-okhttp</artifactId>
</dependency>
3.5.1.2.2. 修改 yml 配置，将 Feign 的 HttpClient 禁用，启用 OkHttp。
spring:cloud:openfeign:httpclient:hc5:enabled: falseokhttp:enabled: true

关于配置可参考：org.springframework.cloud.openfeign.FeignAutoConfiguration

3.5.1.2.3. 重启测试

调用会进入 feign.okhttp.OkHttpClient#execute

3.6. GZIP 压缩配置

开启压缩可以有效节约网络资源，提升接口性能，我们可以配置 GZIP 来压缩数据

spring:openfeign:compression: # 配置 GZIP 来压缩数据request:enabled: truemime-types: text/xml,application/xml,application/jsonmin-request-size: 1024 # 最小请求压缩阈值response:enabled: true

关于配置可参考：

org.springframework.cloud.openfeign.encoding.FeignAcceptGzipEncodingAutoConfiguration

3.7. 编码器解码器配置

Feign 中提供了自定义的编码器解码器设置，同时也提供了多种编码器的实现，比如 Gson、Jaxb、Jackson。我们可以用不同的编码器解码器来处理数据的传输。如果你想传输 XML 格式的数据，可以自定义 XML 编码器解码器来实现，或者使用官方提供的 Jaxb。

扩展点：feign.codec.Encoder & feign.codec.Decoder

public interface Encoder {void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException;
}public interface Decoder {Object decode(Response var1, Type var2) throws IOException, DecodeException, FeignException;
}

3.8. 配置方式

3.8.1.1.1. 引入依赖
<!-- jackson -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-jackson</artifactId>
</dependency>
3.8.1.1.2. Java Bean 方式
@Bean
public Encoder encoder(){return new JacksonEncoder();
}@Bean
public Decoder decoder(){return new JacksonDecoder();
}
3.8.1.1.3. yml 配置文件方式
spring:cloud:openfeign:client:config:icoolkj-mall-order01:# 配置编码器解码器encoder: feign.jackson.JacksonEncoderdecoder: feign.jackson.JacksonDecoder

3.9. 拦截器配置

通过拦截器实现参数传递。

常用场景：统一添加 header 信息，比如向服务提供者传递全局事务 XID，会员 ID，认证 token 令牌，链路追踪的 traceID 等等。

扩展点：feign.RequestInterceptor

public interface RequestInterceptor {void apply(RequestTemplate var1);
}

每次 feign 发起 http 调用之前，会去执行拦截器中的逻辑。

3.9.1. 自定义拦截器实现认证逻辑

需求场景，微服务调用链路需要传递请求头的 token 信息

如果不做任何配置，直接使用 openFeign 在服务间进行调用就会丢失请求头。

解决方案：

3.9.1.1. 方案1：增加接口参数
@RequestMapping(value = "/api/product/getPriceProduct", method = RequestMethod.GET)  
String getPriceProduct(@RequestParam(value = "productId") Long productId, @RequestHeader(value = "token") String token);

该方案不好，代码有侵入性，需要开发人员每次手动获取和添加接口参数。

3.9.1.2. 方案2：添加拦截器

OpenFeign 在远程调用之前会遍历容器中的 RequestInterceptor，调用 RequestInterceptor 的 apply 方法，创建一个新的 Request 进行远程服务调用。因此可以通过实现 RequestInterceptor 给容器中添加自定义的 RequestInterceptor 实现类，这个类里面设置需要发送请求的参数，比如请求头信息，链路追踪信息等。

3.9.1.2.1. 代码实现拦截器：
@Slf4j
public class FeignAuthRequestInterceptor implements RequestInterceptor{@Overridepublic void apply(RequestTemplate template) {// 业务逻辑，模拟认证逻辑ServletRequestAttributes requestAttributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();if(null != requestAttributes){HttpServletRequest request = requestAttributes.getRequest();String access_token = request.getHeader("Authorization");log.info("从 Request 中解析请求头：{}", access_token);// 设置 tokentemplate.header("Authorization", access_token);}}
}
3.9.1.2.2. 配置拦截器生效

方式1，Java Bean

@Bean
public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){return new FeignAuthRequestInterceptor();
}

方式2，yml 配置文件

spring:cloud:openfeign:client:config:icoolkj-mall-order01:  #对应微服务request-interceptors:   # 配置拦截器- com.icoolkj.mall.user.openfeign.demo.interceptor.FeignAuthRequestInterceptor
3.9.1.2.3. 重启测试

postman 中增加请求头参数 Authorization，查看会员服务 openFeign 日志是否有 Authorization 信息。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/893745.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

基于C语言的数组从入门到精通

基于C语言的数组从入门到精通

简介:本篇文章主要介绍了一维数组,二维数组,字符数组的定义,数组的应用,数组的核心代码解析,适用于0基础的初学者. C语言数组 1.一维数组 1.1定义 1.1.1声明 语法:数据类型 数组名[数组大小];示例:int arr[5]; 1.1.2初始化 a.静态初始化 完全初始化&#xff1a;int arr[5] {1…
阅读更多...
音频入门（二）：音频数据增强

音频入门（二）：音频数据增强

本文介绍了一些常见的音频数据增强方法&#xff0c;并给出了代码实现。 目录 一、简介 二、代码 1. 安装必要的库 2. 代码 3. 各函数的介绍 4. 使用方法 参考&#xff1a; 一、简介 音频数据增强是机器学习和深度学习领域中用于改善模型性能和泛化能力的技术。 使用数据…
阅读更多...
Go中new和make的区别对比

Go中new和make的区别对比

Go 中 new 和 make 的区别 在 Go 语言中&#xff0c;new 和 make 都用于分配内存&#xff0c;但它们的使用场景和行为有显著的区别。 1. new 定义 new 是 Go 语言中的一个内置函数&#xff0c;用于分配内存并返回指向该内存的指针。new 分配的内存会被初始化为零值。 作用…
阅读更多...
消息队列篇--通信协议篇--AMOP（交换机，队列绑定，消息确认，AMOP实现实例，AMOP报文，帧，AMOP消息传递模式等）

消息队列篇--通信协议篇--AMOP（交换机，队列绑定，消息确认，AMOP实现实例，AMOP报文，帧，AMOP消息传递模式等）

AMQP&#xff08;Advanced Message Queuing Protocol&#xff0c;高级消息队列协议&#xff09;是一种开放的、跨平台的消息传递协议&#xff0c;旨在提供一种标准化的方式在不同的消息代理和客户端之间进行消息传递。AMQP不仅定义了消息格式和路由机制&#xff0c;还规定了如何…
阅读更多...
LLaMA-Factory 微调LLaMA3

LLaMA-Factory 微调LLaMA3

LoRA介绍 LoRA&#xff08;Low-Rank Adaptation&#xff09;是一种用于大模型微调的技术&#xff0c; 通过引入低秩矩阵来减少微调时的参数量。在预训练的模型中&#xff0c; LoRA通过添加两个小矩阵B和A来近似原始的大矩阵ΔW&#xff0c;从而减 少需要更新的参数数量。具体来…
阅读更多...
【项目实战】—— 高并发内存池设计与实现

【项目实战】—— 高并发内存池设计与实现

目录 一&#xff0c;项目介绍 1.1 关于高并发内存池 1.2 关于池化技术 1.3 关于malloc 二&#xff0c;定长内存池实现 2.1 实现详情 ​2.2 完整代码 三&#xff0c;高并发内存池整体设计 四&#xff0c;threadcache设计 4.1 整体设计 4.2 哈希桶映射对齐规则 4.3 …
阅读更多...
设计模式的艺术-代理模式

设计模式的艺术-代理模式

结构性模式的名称、定义、学习难度和使用频率如下表所示&#xff1a; 1.如何理解代理模式 代理模式&#xff08;Proxy Pattern&#xff09;&#xff1a;给某一个对象提供一个代理&#xff0c;并由代理对象控制对原对象的引用。代理模式是一种对象结构型模式。 代理模式类型较多…
阅读更多...
计算机网络 （54）系统安全：防火墙与入侵检测

计算机网络 （54）系统安全：防火墙与入侵检测

前言 计算机网络系统安全是确保网络通信和数据不受未经授权访问、泄露、破坏或篡改的关键。防火墙和入侵检测系统&#xff08;IDS&#xff09;是维护网络系统安全的两大核心组件。 一、防火墙 定义与功能 防火墙是一种用来加强网络之间访问控制的特殊网络互联设备&#xff0c;它…
阅读更多...
three.js+WebGL踩坑经验合集(3):THREE.Line的射线检测问题（不是阈值方面的，也不是难选中的问题）

three.js+WebGL踩坑经验合集(3):THREE.Line的射线检测问题（不是阈值方面的，也不是难选中的问题）

笔者之所以要在标题里强调不是阈值方面&#xff0c;是因为网上的大多数文章提到线的射线检测问题&#xff0c;90%以上的文章都说是因为线太细所以难选中&#xff0c;然后让大家把线的阈值调大。 而本文所要探讨的问题则恰好相反&#xff0c;不是难选中&#xff0c;而是在某些角…
阅读更多...
省市区三级联动

省市区三级联动

引言 在网页中&#xff0c;经常会遇到需要用户选择地区的场景&#xff0c;如注册表单、地址填写等。为了提供更好的用户体验&#xff0c;我们可以实现一个三级联动的地区选择器&#xff0c;让用户依次选择省份、城市和地区。 效果展示&#xff1a; 只有先选择省份后才可以选择…
阅读更多...
快速搭建深度学习环境（Linux：miniconda+pytorch+jupyter notebook）

快速搭建深度学习环境（Linux：miniconda+pytorch+jupyter notebook）

本文基于服务器端环境展开&#xff0c;使用的虚拟终端为Xshell。 miniconda miniconda是Anaconda的轻量版&#xff0c;仅包含Conda和Python&#xff0c;如果只做深度学习&#xff0c;可使用miniconda。 [注]&#xff1a;Anaconda、Conda与Miniconda Conda&#xff1a;创建和管…
阅读更多...
BGP分解实验·11——路由聚合与条件性通告（3）

BGP分解实验·11——路由聚合与条件性通告（3）

续接上&#xff08;2&#xff09;的实验。其拓扑如下&#xff1a; 路由聚合的负向也就是拆分&#xff0c;在有双出口的情况下&#xff0c;在多出口做流量分担是优选方法之一。 BGP可以根据指定来源而聚合路由&#xff0c;在产生该聚合路由的范围内的条目注入到本地BGP表后再向…
阅读更多...
攻防世界easyRSA

攻防世界easyRSA

解密脚本&#xff1a; p473398607161 q4511491 e17def extended_euclidean(a, b):if b 0:return a, 1, 0gcd, x1, y1 extended_euclidean(b, a % b)x y1y x1 - (a // b) * y1return gcd, x, ydef calculate_private_key(p, q, e):phi (p - 1) * (q - 1)gcd, x, y extend…
阅读更多...
常见的多媒体框架（FFmpeg GStreamer DirectShow AVFoundation OpenMax）

常见的多媒体框架（FFmpeg GStreamer DirectShow AVFoundation OpenMax）

1.FFmpeg FFmpeg是一个非常强大的开源多媒体处理框架&#xff0c;它提供了一系列用于处理音频、视频和多媒体流的工具和库。它也是最流行且应用最广泛的框架&#xff01; 官方网址&#xff1a;https://ffmpeg.org/ FFmpeg 的主要特点和功能&#xff1a; 编解码器支持: FFmpe…
阅读更多...
.NET MAUI进行UDP通信（二）

.NET MAUI进行UDP通信（二）

上篇文章有写过一个简单的demo&#xff0c;本次对项目进行进一步的扩展&#xff0c;添加tabbar功能。 1.修改AppShell.xaml文件&#xff0c;如下所示&#xff1a; <?xml version"1.0" encoding"UTF-8" ?> <Shellx:Class"mauiDemo.AppShel…
阅读更多...
计算机网络之链路层

计算机网络之链路层

本文章目录结构出自于《王道计算机考研 计算机网络_哔哩哔哩_bilibili》 02 数据链路层 在网上看到其他人做了详细的笔记&#xff0c;就不再多余写了&#xff0c;直接参考着学习吧。 1 详解数据链路层-数据链路层的功能【王道计算机网络笔记】_wx63088f6683f8f的技术博客_51C…
阅读更多...
YOLOv11改进，YOLOv11检测头融合DSConv(动态蛇形卷积)，并添加小目标检测层（四头检测），适合目标检测、分割等任务

YOLOv11改进，YOLOv11检测头融合DSConv(动态蛇形卷积)，并添加小目标检测层（四头检测），适合目标检测、分割等任务

前言 精确分割拓扑管状结构例如血管和道路，对各个领域至关重要，可确保下游任务的准确性和效率。然而，许多因素使任务变得复杂，包括细小脆弱的局部结构和复杂多变的全局形态。在这项工作中，注意到管状结构的特殊特征，并利用这一知识来引导 DSCNet 在三个阶段同时增强感知…
阅读更多...
Flutter android debug 编译报错问题。插件编译报错

Flutter android debug 编译报错问题。插件编译报错

下面相关内容 都以 Mac 电脑为例子。 一、问题 起因&#xff1a;&#xff08;更新 Android studio 2024.2.2.13、 Flutter SDK 3.27.2&#xff09; 最近 2025年 1 月 左右&#xff0c;我更新了 Android studio 和 Flutter SDK 再运行就会出现下面的问题。当然 下面的提示只是其…
阅读更多...
扣子平台音频功能：让声音也能“智能”起来

扣子平台音频功能：让声音也能“智能”起来

在数字化时代&#xff0c;音频内容的重要性不言而喻。无论是在线课程、有声读物&#xff0c;还是各种多媒体应用&#xff0c;音频都是传递信息、增强体验的关键元素。扣子平台的音频功能&#xff0c;为开发者和内容创作者提供了一个强大而灵活的工具&#xff0c;让音频的使用和…
阅读更多...
RubyFPV开源代码之系统简介

RubyFPV开源代码之系统简介

RubyFPV开源代码之系统简介 1. 源由2. 工程架构3. 特性介绍&#xff08;软件&#xff09;3.1 特性亮点3.2 数字优势3.3 使用功能 4. DEMO推荐&#xff08;硬件&#xff09;4.1 天空端4.2 地面端4.3 按键硬件Raspberry PiRadxa 3W/E/C 5. 软件设计6. 参考资料 1. 源由 RubyFPV以…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023