springcloud之FeignClient使用详解

2025-01-01 03:50

本文主要是介绍springcloud之FeignClient使用详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《springcloud之FeignClient使用详解》Feign是一种声明式、模板化的HTTP客户端,可以简化微服务之间的远程过程调用,通过Feign,开发者可以像调用本地方法一样调用远程服务,而...

前言

在微服务项目中会存在多个微服务之间互相调用的情况,如何高效便捷的进行远程过程调用便成为新的议论话题。spring-cloud中提供的feign方式可以有效解决该问题。

Feign是一种声明式、模板化的HTTP客户端。在Spring Cloud中使用Feign, 我们可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。

如下testMicroServiceAccess方法便是feignClient调用,但是外部看起来和普通方法无二。

springcloud之FeignClient使用详解

业务场景

假设同一个注册中心上有两个微服务:A和B,为完成某个业务功能,B微服务需要调用A微服务中的某个方法逻辑获取返回结果,并且二者是不能作为jar互相依赖的,按照传统方式只能如下处理:

请求——>外部网关——>应用层——>内部网关——>B微服务——>外部网关——>应用层——>内部网关——>A微服务——>结束

即便是拆掉外部网关和应用层,也需要通过内部网关中转才能访问到A微服务,况且还要考虑超时熔断、路由负载等问题。

引入feign后简化流程,并且其结合ribbon实现路由负载超时熔断等措施,具体流程如下:

请求——>外部网关——>应用层——>内部网关——>B微服务——>feignClient——>A微服务——>结束

架构说明

按照上述业务假设进行架构说明:

1、为保持系统良好的可扩展性,降低模块耦合度,新建A-FeignClient模块,用于提供feign接口和相关实体类。后期作为jar文件推送到Maven私服中,供A、B微服务各自引用。

2、A微服务中仅需要在启动类上增加开启feign的注解,可以考虑增加A-FeignClient依赖,这样三个模块使用同一份实体类,保证一致性。

springcloud之FeignClient使用详解

3、B微服务中增加A-FeignClient模块的依赖,编写客户端调用代码。

springcloud之FeignClient使用详解

调用逻辑

1、A-Feignhttp://www.chinasem.cnClient

  • a、在A-FeignClient中增加接口,通过spring注解标识其提供服务的真正接口路径。
  • b、@FeignClient注解中name值目标微服务名,contextId用于标识FeignClient名。
  • c、方法名上的postmapping用于标识该方法需要转发的接口路径。下图代码示例中android意思即:调用该方法后会代理到A微服务的/demoServer/testMicroServiceAccess接口中。
  • d、通过实现该接口的方式新建一个类,可以用于feign调用失败后的容错处理。
package com.demo.DemoFeignClient;

/**
 * 微服务之间调用的核心接口     Aikes
 * 注解@FeignClient中contextID参数用于标识client,防止多个接口共用同一个目标jsFeignClient冲突
 */
@FeignClient(name = "A-server" ,contextId = "DemoFeignClient", fallback = DemoFeignClientFallback.class )
public interface DemoFeignClient{

    @PostMapping("/demoServer/testMicroServiceAccess")
    public ApiResponse<String> testMicroServiceAccess(@RequestBody ServerAccessRequest<DemoPo> cServerAccessRequest);
}

/**
 * 增加访问失败时的处理逻辑
 */
@Component
class DemoFeignClientFallback implements DemoFeignClient{

    @Override
    public ApiResponse<String> testMicroServiceAccess(ServerAccessRequest<DemoPo> cServerAccessRequest) {
        ApiResponse<String> tApiResponsejs = new ApiResponse<>();
        tApiResponse.setStatus(ApiResponse.BUSY);
        return tApiResponse;
    }
}

2、A微服务

作为服务提供方,只需要正常编写业务逻辑即可,重点需要考虑请求入参的实体类把控,建议引用A-FeignClient中,保证一致性。

package com.demo.DemoFeignServerController;

/**
 * 服务提供方    Aikes
 */
@Controller
@RequestMapping("demoServer")
@RestController
@Slf4j
public class DemoFeignServerController {

    @PostMapping("/testMicroServiceAccess")
    public ApiResponse<String> testMicroServiceAccess(@RequestBody ServerAccessRequest<DemoPo> cServerAccessRequest) {
        log.info(cServerAccessRequest.toString());
        log.info("This is FeignServerController");
        ApiResponse<String> tApiResponse = new ApiResponse<String>();
        tApiResponse.setStatus(ApiResponse.SUCCESS);
        tApiResponse.setStatusText(ApiResponse.SUCCESS_TEXT);
        tApiResponse.setData(cServerAccessRequest.getData().getDemoName());
        return tApiResponse;
    }
}

3、B微服务

作为服务消费方,在核心逻辑处理中,通过调用引入的A-FeignClient模块的接口,由feign负责代理转发到A微服务,实现调用A微服务的相关逻辑。

package com.demo.DemoFeignClientController;

/**
 * 服务消费方    Aikes
 */
public class DemoFeignClientController {

    @Autowired
    private DemoFeignClient mDemoFeignClient;

    public void DOService() {
        //TODO 业务处理
        ApiResponse<String> tApiResponse = this.testFeign();//调用 A微服务 处理逻辑
        //TODO 处理返回结果
    }

    puhttp://www.chinasem.cnblic ApiResponse<String> testFeign() {
        ServerAccessRequest<DemoPo> tServerAccessRequest = new ServerAccessRequest<DemoPo>();
        tServerAccessRequest.setBusinessNo("TEST001");
        return mDemoFeignClient.testMicroServiceAccess(tServerAccessRequest);
    }
}

小结

通过feign的方式可以降低服务间调用的复杂度,从而提升系统性能。但同时带来的问题也需要重点考量:

  • 1、服务间调用失败后的事务一致性处理,需要结合各自业务场景分析。
  • 2、错综复杂的服务间调用开启后,相当于给系统开了后门,需要考虑增加服务间调用日志记录的功能,推荐使用自定义注解+AOP统一处理。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持China编程(www.chinasem.cn)。

这篇关于springcloud之FeignClient使用详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1152877

相关文章

Spring Boot 中整合 MyBatis-Plus详细步骤(最新推荐)

《SpringBoot中整合MyBatis-Plus详细步骤(最新推荐)》本文详细介绍了如何在SpringBoot项目中整合MyBatis-Plus,包括整合步骤、基本CRUD操作、分页查询、批... 目录一、整合步骤1. 创建 Spring Boot 项目2. 配置项目依赖3. 配置数据源4. 创建实体类

python subprocess.run中的具体使用

《pythonsubprocess.run中的具体使用》subprocess.run是Python3.5及以上版本中用于运行子进程的函数,它提供了更简单和更强大的方式来创建和管理子进程,本文就来详细... 目录一、详解1.1、基本用法1.2、参数详解1.3、返回值1.4、示例1.5、总结二、subproce

使用Spring Cache时设置缓存键的注意事项详解

《使用SpringCache时设置缓存键的注意事项详解》在现代的Web应用中,缓存是提高系统性能和响应速度的重要手段之一,Spring框架提供了强大的缓存支持,通过​​@Cacheable​​、​​... 目录引言1. 缓存键的基本概念2. 默认缓存键生成器3. 自定义缓存键3.1 使用​​@Cacheab

详解Java中如何使用JFreeChart生成甘特图

《详解Java中如何使用JFreeChart生成甘特图》甘特图是一种流行的项目管理工具,用于显示项目的进度和任务分配,在Java开发中,JFreeChart是一个强大的开源图表库,能够生成各种类型的图... 目录引言一、JFreeChart简介二、准备工作三、创建甘特图1. 定义数据集2. 创建甘特图3.

详解Spring Boot接收参数的19种方式

《详解SpringBoot接收参数的19种方式》SpringBoot提供了多种注解来接收不同类型的参数,本文给大家介绍SpringBoot接收参数的19种方式,感兴趣的朋友跟随小编一起看看吧... 目录SpringBoot接受参数相关@PathVariable注解@RequestHeader注解@Reque

Python中异常类型ValueError使用方法与场景

《Python中异常类型ValueError使用方法与场景》:本文主要介绍Python中的ValueError异常类型,它在处理不合适的值时抛出,并提供如何有效使用ValueError的建议,文中... 目录前言什么是 ValueError?什么时候会用到 ValueError?场景 1: 转换数据类型场景

windows端python版本管理工具pyenv-win安装使用

《windows端python版本管理工具pyenv-win安装使用》:本文主要介绍如何通过git方式下载和配置pyenv-win,包括下载、克隆仓库、配置环境变量等步骤,同时还详细介绍了如何使用... 目录pyenv-win 下载配置环境变量使用 pyenv-win 管理 python 版本一、安装 和

Django中使用SMTP实现邮件发送功能

《Django中使用SMTP实现邮件发送功能》在Django中使用SMTP发送邮件是一个常见的需求,通常用于发送用户注册确认邮件、密码重置邮件等,下面我们来看看如何在Django中配置S... 目录1. 配置 Django 项目以使用 SMTP2. 创建 Django 应用3. 添加应用到项目设置4. 创建

深入探讨Java 中的 Object 类详解(一切类的根基)

《深入探讨Java中的Object类详解(一切类的根基)》本文详细介绍了Java中的Object类,作为所有类的根类,其重要性不言而喻,文章涵盖了Object类的主要方法,如toString()... 目录1. Object 类的基本概念1.1 Object 类的定义2. Object 类的主要方法3. O

IDEA常用插件之代码扫描SonarLint详解

《IDEA常用插件之代码扫描SonarLint详解》SonarLint是一款用于代码扫描的插件,可以帮助查找隐藏的bug,下载并安装插件后,右键点击项目并选择“Analyze”、“Analyzewit... 目录SonajavascriptrLint 查找隐藏的bug下载安装插件扫描代码查看结果总结Sona