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统一处理。

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

相关文章

  • spring单元测试下模拟rabbitmq的实现

    spring单元测试下模拟rabbitmq的实现

    这篇文章主要介绍了spring单元测试下模拟rabbitmq的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-05-05
  • Java 中如何使用 stream 流

    Java 中如何使用 stream 流

    这篇文章主要介绍了Java中如何使用stream流,文章围绕Stream API支持的许多操作展开主题,感兴趣的小伙伴可以参考一下
    2022-09-09
  • java实现科研信息管理系统

    java实现科研信息管理系统

    这篇文章主要为大家详细介绍了java科研信息管理系统,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-02-02
  • 图解JVM内存模型

    图解JVM内存模型

    这篇文章主要介绍了JVM内存模型的相关资料,帮助大家更好的理解和学习Java虚拟机,感兴趣的朋友可以了解详细
    2020-10-10
  • 浅谈基于SpringBoot实现一个简单的权限控制注解

    浅谈基于SpringBoot实现一个简单的权限控制注解

    这篇文章主要介绍了基于SpringBoot实现一个简单的权限控制注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • 彻底解决Spring MVC中文乱码问题的方案

    彻底解决Spring MVC中文乱码问题的方案

    这篇文章主要介绍了彻底解决Spring MVC中文乱码问题的方案,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2016-11-11
  • SpringBoot入门实现第一个SpringBoot项目

    SpringBoot入门实现第一个SpringBoot项目

    今天我们一起来完成一个简单的SpringBoot(Hello World)。就把他作为你的第一个SpringBoot项目。具有一定的参考价值,感兴趣的可以了解一下
    2021-09-09
  • Spring循环依赖之问题复现详解

    Spring循环依赖之问题复现详解

    这篇文章主要为大家详细介绍了Spring的循环依赖什么时候会出现以及如何解决循环依赖,文中的示例代码讲解详细,感兴趣的可以学习一下
    2022-07-07
  • Java结构型设计模式之享元模式示例详解

    Java结构型设计模式之享元模式示例详解

    享元模式(FlyWeight Pattern),也叫蝇量模式,运用共享技术,有效的支持大量细粒度的对象,享元模式就是池技术的重要实现方式。本文将通过示例详细讲解享元模式,感兴趣的可以了解一下
    2022-09-09
  • SpringBoot+layui实现文件上传功能

    SpringBoot+layui实现文件上传功能

    Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。这篇文章主要介绍了SpringBoot+layui实现文件上传,需要的朋友可以参考下
    2018-09-09

最新评论