【SpringCloud系列】@FeignClient微服务轻舞者

💝💝💝欢迎来到我的博客,很高兴能够在这里和您见面!希望您在这里可以感受到一份轻松愉快的氛围,不仅可以获得有趣的内容和知识,也可以畅所欲言、分享您的想法和见解。
img

  • 推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老
  • 导航
    • 檀越剑指大厂系列:全面总结 java 核心技术点,如集合,jvm,并发编程 redis,kafka,Spring,微服务,Netty 等
    • 常用开发工具系列:罗列常用的开发工具,如 IDEA,Mac,Alfred,electerm,Git,typora,apifox 等
    • 数据库系列:详细总结了常用数据库 mysql 技术点,以及工作中遇到的 mysql 问题等
    • 懒人运维系列:总结好用的命令,解放双手不香吗?能用一个命令完成绝不用两个操作
    • 数据结构与算法系列:总结数据结构和算法,不同类型针对性训练,提升编程思维,剑指大厂

非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨

博客目录

    • 一.简单介绍
      • 1.什么是 FeignClient?
      • 2.FeignClient 优点?
    • 二.基本使用
      • 1.引入依赖
      • 2.获取 token 接口
      • 3.RequestParam
      • 4.Interceptor
      • 5.配置文件类
      • 6.业务接口
      • 7.yaml 配置文件
      • 8.使用总结
    • 三.原理解析
      • 1.value/name
      • 2.url
      • 3.path
      • 4.configuration
      • 5.fallback
      • 6.fallbackFactory
      • 7.decode404

一.简单介绍

1.什么是 FeignClient?

@FeignClient 是 Spring Cloud 中的一个注解,用于创建基于接口的声明式服务客户端。它是在微服务架构中用于进行服务之间通信的一种方式。通过 @FeignClient,您可以定义一个接口,该接口包含要调用的远程服务的方法,而 Feign 将自动处理底层的 HTTP 请求和负载均衡。

2.FeignClient 优点?

@FeignClient 在微服务架构中的使用具有多个优点和特点,这使得它成为一个方便且强大的工具:

  1. 声明式 REST 客户端: @FeignClient 允许您使用声明式的方式定义服务间的 HTTP 调用。通过简单地定义一个接口,而不需要手动编写 HTTP 请求,您可以将服务调用抽象为接口的方法。

  2. 集成了 Ribbon 负载均衡: @FeignClient 集成了 Netflix 的 Ribbon 负载均衡器,自动处理了服务的负载均衡。这使得微服务之间的调用更加健壮和可靠。

  3. 支持服务发现: 默认情况下,@FeignClient 集成了 Eureka 服务发现,允许您使用服务的逻辑名称而不是直接的 IP 地址进行服务调用。这增加了服务调用的灵活性。

  4. 支持多种注解: 除了 @FeignClient,Feign 还支持一系列其他的注解,如 @RequestMapping@RequestParam 等,使得您可以在接口上使用这些注解定义 HTTP 请求的各个方面。

  5. 集成了 Hystrix 进行服务降级: @FeignClient 支持集成 Hystrix,可以通过设置 fallbackfallbackFactory 属性,定义服务降级的逻辑。当远程服务不可用时,可以提供备选方案,防止整个系统崩溃。

  6. 支持自定义配置: 通过 configuration 属性,您可以自定义 Feign 客户端的配置,包括连接超时、读取超时、重试策略等。这使得您可以根据实际需求进行灵活的配置。

  7. 集成了 Spring Cloud Contract: Spring Cloud Contract 可以通过测试契约来确保服务之间的契约一致性。@FeignClient 集成了 Spring Cloud Contract,使得可以通过契约来测试和验证服务之间的通信。

  8. 简化代码: 使用 @FeignClient 可以大大简化微服务之间的通信代码。由于 Feign 处理了底层的 HTTP 请求和负载均衡,开发者只需要关注业务逻辑,使得代码更加清晰简洁。

@FeignClient 是一个强大的工具,它简化了微服务之间的通信,提高了开发效率,同时集成了一系列的微服务治理功能,使得服务调用更加可靠和灵活。

二.基本使用

1.引入依赖

<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId><version>2.2.2.RELEASE</version>
</dependency>

2.获取 token 接口

使用 FeignClient 封装获取 token 的接口

@FeignClient(url = "${xxx.open-api.host}",value = "xxx-open-api",contextId = "oauth",path = "/cas/oauth"
)
public interface AuthOpenApi {@Log("xxx-open-api,获取token")@GetMapping("/token")TokenResponse getToken(@SpringQueryMap GetTokenRequest request);
}

3.RequestParam

请求参数类

@Data
public class GetTokenRequest {private String scope = "xxx";private String grant_type = "xxx";private String client_id;private String client_secret;public GetTokenRequest() {this.client_id = SpringContextHolder.getBean(OpenApiProperties.class).getClientId();this.client_secret = SpringContextHolder.getBean(OpenApiProperties.class).getSecret();}
}

4.Interceptor

拦截器,用于给 FeignClient 添加自定义拦截器

@Slf4j
public class OpenApiRequestInterceptor implements RequestInterceptor {@Autowiredprivate JedisClient JedisClient;@Autowiredprivate AuthOpenApi AuthOpenApi;@Autowiredprivate OpenApiProperties OpenApiProperties;@Overridepublic void apply(RequestTemplate requestTemplate) {String accessToken = JedisClient.get(CommonConstant.REDIS__KEY_PREFIX + "accessToken");if (StringUtils.isEmpty(accessToken)) {TokenResponse response = AuthOpenApi.getToken(new GetTokenRequest());if (response.getCode() != 200) {throw new ApplicationException("获取 accessToken失败");}accessToken = response.getData().getAccessToken();final int expiresIn = response.getData().getExpiresIn();log.info("apply() called with: expiresIn = [" + expiresIn + "]");JedisClient.set(CommonConstant.REDIS__KEY_PREFIX + "accessToken", accessToken, Math.max(expiresIn - 10, 1));}long timestamp = System.currentTimeMillis();String requestId = UUID.randomUUID().toString();String str = OpenApiProperties.getClientId() + timestamp + requestId + accessToken + this.OpenApiProperties.getSecret();String signature = DigestUtils.md5Hex(str).toUpperCase();requestTemplate.header("clientId", this.OpenApiProperties.getClientId());requestTemplate.header("timestamp", timestamp + "");requestTemplate.header("requestId", requestId);requestTemplate.header("signatureMethod", "MD5");requestTemplate.header("accessToken", accessToken);requestTemplate.header("signature", signature);}
}

5.配置文件类

鉴权需要的参数配置信息

@Configuration
@ConfigurationProperties(prefix = "open-api")
@Data
public class OpenApiProperties {private String url;private String clientId;private String secret;private String aesKey;private String aesIv;
}

开启 FeignClients 的功能

@EnableFeignClients
@Configuration
public class OpenFeignConfig {
}

6.业务接口

获取图片的权限

@FeignClient(url = "${open-api.host}",value = "open-api",configuration = {OpenApiRequestInterceptor.class},contextId = "picAuth",path = "/permission-portal/picture/auth"
)
public interface PicOpenApi {@Log("open-api,图片授权模块")@GetMappingPicResultDto auth(@RequestParam(value = "userNo") String userNo);
}

7.yaml 配置文件

open-api:host: xxxxxclientId: insightsecret: xxxxaesKey: xxxxaesIv: xxxx

8.使用总结

首先用@FeignClient 定义了 2 个接口,一个是获取 token 的接口,一个是获取图片权限的接口,在获取图片权限的接口中添加了 configuration 属性,该属性指向 OpenApiRequestInterceptor 类,在请求获取图片接口的时候,会前置处理拦截器中的逻辑,在拦截器中我们调用的是获取 token 的接口,并解析返回结果,放入到了 http 的请求头中,非常方便的给获取图片的接口添加了 header 鉴权信息。

三.原理解析

1.value/name

value/name: 用于指定目标服务的名称。valuename 都可以用来设置服务的名称,它们是互换的。这是 @FeignClient 唯一需要指定的参数。

@FeignClient(value = "example-service")
public interface ExampleFeignClient {// ...
}

2.url

url: 如果不想使用服务发现,可以使用 url 参数指定目标服务的 URL。这个 URL 可以是完整的服务地址。

@FeignClient(url = "http://example.com")
public interface ExampleFeignClient {// ...
}

3.path

path: 用于为 Feign 客户端的所有请求添加一个基本路径。

@FeignClient(value = "example-service", path = "/api")
public interface ExampleFeignClient {// ...
}

4.configuration

configuration: 用于指定 Feign 客户端的配置类,可以配置连接超时、重试策略、拦截器等。可以指定一个,也可以指定多个,非常给力的功能参数。

@FeignClient(value = "example-service", configuration = MyFeignConfig.class)
public interface ExampleFeignClient {// ...
}

5.fallback

fallback: 用于指定一个降级处理的类,当调用失败时会执行该类的方法。

@FeignClient(value = "example-service", fallback = ExampleFallback.class)
public interface ExampleFeignClient {// ...
}

6.fallbackFactory

fallbackFactory: 与 fallback 类似,用于指定一个降级处理的工厂类,可以在工厂类中对异常进行更详细的处理。

@FeignClient(value = "example-service", fallbackFactory = ExampleFallbackFactory.class)
public interface ExampleFeignClient {// ...
}

7.decode404

decode404: 默认情况下,Feign 不会解码 404 响应。通过设置 decode404 = true,可以让 Feign 解码 404 响应。

@FeignClient(value = "example-service", decode404 = true)
public interface ExampleFeignClient {// ...
}

@FeignClient 注解的参数,提供了灵活性和配置选项,以适应不同的微服务调用场景。Feign 会根据这些参数配置底层的 HTTP 请求,实现服务之间的通信。

觉得有用的话点个赞 👍🏻 呗。
❤️❤️❤️本人水平有限,如有纰漏,欢迎各位大佬评论批评指正!😄😄😄

💘💘💘如果觉得这篇文对你有帮助的话,也请给个点赞、收藏下吧,非常感谢!👍 👍 👍

🔥🔥🔥Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧!🌙🌙🌙

img

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

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

相关文章

NX二次开发UF_MTX3_vec_multiply_t 函数介绍

文章作者&#xff1a;里海 来源网站&#xff1a;https://blog.csdn.net/WangPaiFeiXingYuan UF_MTX3_vec_multiply_t Defined in: uf_mtx.h void UF_MTX3_vec_multiply_t(const double vec [ 3 ] , const double mtx [ 9 ] , double vec_product [ 3 ] ) overview 概述 Ret…

windows10 Arcgis pro3.0-3.1

我先安装的arcgis pro3.0&#xff0c;然后下载的3.1。 3.0里面有pro、help、sdk、还有一些补丁包根据个人情况安装。 3.1里面也是这些。 下载 正版试用最新的 ArcGIS Pro 21 天教程&#xff0c;仅需五步&#xff01;-地理信息云 (giscloud.com.cn) 1、安装windowsdesktop-…

使用docker-compose优雅部署rocketMQ

使用docker-compose优雅部署RocketMQ 随着市场的发展&#xff0c;越来越多的复杂场景出现在我们日常的开发工作中。随之也越来越多的好的工具&#xff0c;也同步出现在程序员的学习范围清单内。好的工具提高产品性能的同时&#xff0c;也带来了很多安装上的问题&#xff0c;do…

申请免费的ssl证书

申请网站&#xff1a; https://freessl.cn/ 解密域名&#xff0c;添加cname跳转 下载acme.sh 工具脚本&#xff0c;地址&#xff1a;https://github.com/acmesh-official/acme.sh/wiki/Install-in-China 下载成功之后的acme.sh是一个目录&#xff0c;进去之后才是脚本 执行…

深入浅出 Vue 中的插槽 slot

深入浅出 Vue 中的插槽 slot start 最近被问到好几次 Vue 中的插槽相关知识&#xff0c;掌握的还是有些不全面。抱着重新学习的心态&#xff0c;写这篇博客。首先对基础知识做一个回顾&#xff0c;然后再对源码实现做一个学习。作者&#xff1a;番茄编写时间&#xff1a;2023…

ArkTS-WebView内嵌H5页面

鸿蒙开发使用WebView内嵌H5页面 访问在线网页时需添加网络权限&#xff1a;ohos.permission.INTERNET module.json5文件配置 {"module" : {"requestPermissions":[{"name": "ohos.permission.INTERNET"}]} }踩坑日记 加载网页效果无法…

Java---权限修饰符、final、static

文章目录 1. 权限修饰符2. final(最终态)3. static(静态) 1. 权限修饰符 修饰符同一个类中同一个包中的子类和无关类不同包的子类不同包的无关类private√默认√√protected√√√public√√√√ 2. final(最终态) 1. final关键字是最终的意思&#xff0c;可以修饰成员方法、…

《数据结构与测绘程序设计》试题详细解析(仅供参考)

一. 选择题&#xff08;每空2分&#xff0c;本题共30分&#xff09; &#xff08;1&#xff09;在一个单链表中&#xff0c;已知q所指结点是p所指结点的前驱结点&#xff0c;若在q和p之间插入结点s&#xff0c;则执行( B )。 A. s->nextp->next; p->nexts; …

第3章 表、栈和队列

前言 本章讨论最简单和最基本的三种数据结构。实际上&#xff0c;每一个有意义的程序都将至少明确使用一种这样的数据结构&#xff0c;而栈则在程序中总是隐含使用&#xff0c;不管你在程序中是否做了声明。 在这一章&#xff0c;我们将&#xff1a; 介绍抽象数据类型…

Asp.net core WebApi 配置自定义swaggerUI和中文注释

1.创建asp.net core webApi项目 默认会引入swagger的Nuget包 <PackageReference Include"Swashbuckle.AspNetCore" Version"6.2.3" />2.配置基本信息和中文注释&#xff08;默认是没有中文注释的&#xff09; 2.1创建一个新的controller using Micr…

Apipost也出IDEA插件了?Apipost-Helper!

IDEA是一款功能强大的集成开发环境&#xff08;IDE&#xff09;&#xff0c;它可以帮助开发人员更加高效地编写、调试和部署软件应用程序。我们在编写完接口代码后需要进行接口调试等操作&#xff0c;一般需要打开额外的调试工具。 今天给大家介绍一款IDEA插件&#xff1a;Api…

WordPress插件大全-免费的WordPress插件汇总

随着互联网的不断发展&#xff0c;网站建设变得日益普及。对于大多数人而言&#xff0c;WordPress是一个熟悉且易于使用的网站建设平台。然而&#xff0c;有时候我们可能会觉得WordPress的功能还不够满足我们的需求&#xff0c;这时候&#xff0c;插件就成了解决问题的得力工具…