springcloud之FeignClient使用详解

 更新时间:2024年12月31日 15:16:22   作者:Aikes902  
Feign是一种声明式、模板化的HTTP客户端,可以简化微服务之间的远程过程调用,通过Feign,开发者可以像调用本地方法一样调用远程服务,而无需感知这是一个HTTP请求,引入Feign后,微服务之间的调用流程更加简化,结合Ribbon实现了路由负载、超时熔断等功能

前言

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

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

如下testMicroServiceAccess方法便是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依赖,这样三个模块使用同一份实体类,保证一致性。

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

调用逻辑

1、A-FeignClient

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

/**
 * 微服务之间调用的核心接口     Aikes
 * 注解@FeignClient中contextID参数用于标识client,防止多个接口共用同一个目标FeignClient冲突
 */
@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> tApiResponse = 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 处理返回结果
    }

    public ApiResponse<String> testFeign() {
        ServerAccessRequest<DemoPo> tServerAccessRequest = new ServerAccessRequest<DemoPo>();
        tServerAccessRequest.setBusinessNo("TEST001");
        return mDemoFeignClient.testMicroServiceAccess(tServerAccessRequest);
    }
}

小结

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

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 基于Java实现根据周次生成数据的工具类

    基于Java实现根据周次生成数据的工具类

    这篇文章主要为大家详细介绍了一个基于Java的周次生成工具,用于根据指定的年份和周次类型(自然周或财务周)生成连续的周次列表数据,希望对大家有所帮助
    2025-08-08
  • javap命令的使用技巧

    javap命令的使用技巧

    本篇文章给大家分享了关于JAVA中关于javap命令的使用技巧以及相关代码分享,有需要的朋友参考学习下。
    2018-05-05
  • Mybatis SQL数量限制插件的实现

    Mybatis SQL数量限制插件的实现

    本文介绍了一种应对大数据查询风险的Mybatis插件,通过配置限制查询结果数量,并支持动态调整和特殊接口绕过,具有一定的参考价值,感兴趣的可以了解一下
    2025-07-07
  • java使用短信设备发送sms短信的示例(java发送短信)

    java使用短信设备发送sms短信的示例(java发送短信)

    这篇文章主要介绍了java使用短信设备发送sms短信的示例(java发送短信),需要的朋友可以参考下
    2014-04-04
  • springmvc配置线程池Executor做多线程并发操作的代码实例

    springmvc配置线程池Executor做多线程并发操作的代码实例

    今天小编就为大家分享一篇关于springmvc配置线程池Executor做多线程并发操作的代码实例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03
  • Spring加载配置和读取多个Properties文件的讲解

    Spring加载配置和读取多个Properties文件的讲解

    今天小编就为大家分享一篇关于Spring加载配置和读取多个Properties文件的讲解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03
  • Java中JSR303的基本使用详情

    Java中JSR303的基本使用详情

    这篇文章主要介绍了Java中JSR303的基本使用详情,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-09-09
  • Java 枚举的常用技巧汇总

    Java 枚举的常用技巧汇总

    在Java中,枚举类型是一种特殊的数据类型,允许定义一组固定的常量,默认情况下,toString方法返回枚举常量的名称,本文提供了一个完整的代码示例,展示了如何在Java中通过重写枚举的toString方法来展示枚举实例的字段信息,感兴趣的朋友一起看看吧
    2025-01-01
  • MyBatisX代码自动生成的实现示例

    MyBatisX代码自动生成的实现示例

    本文主要介绍了MyBatisX代码自动生成的实现示例, 文中通过图文示例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-05-05
  • SpringBoot项目中@RestControllerAdvice全局异常失效问题的解决

    SpringBoot项目中@RestControllerAdvice全局异常失效问题的解决

    @RestController注解是一个用于定义RESTful Web服务的控制器的特殊注解,它是@Controller和@ResponseBody注解的结合体,意味着你不需要在每个处理请求的方法上都添加@ResponseBody,本文给大家介绍了解决SpringBoot项目中@RestControllerAdvice全局异常失效问题
    2024-11-11

最新评论