微服务间服务(接口)调用关系你还在手工记录吗

初露寒秋
3,941 阅读8分钟

前言

微服务在企业中应用越来越普遍。企业在享受微服务优势的同时，也带来了问题。随着企业的业务发展，相应的应用服务数量不断累加，应用服务间依赖关系愈加错综复杂。

采用微服务架构的企业中，为了业务模块间解耦，更好的迭代发展业务。整个公司业务分成10个模块服务都是很正常的。而且随着业务的不断发展，服务数量和每个服务中接口的数量都在不断增加，且开发人员又在不断更迭。试想，10模块服务间，比较相互依赖，相互调用，链路如一张网。尤其细化到接口级别，更加繁琐。如果靠开发人员用脑子记，恐怕不现实了。如何准确的知晓一个服务被哪些服务调用，一个服务用调用了哪些服务，对服务的稳定，代码的维护，影响的评估，业务的迭代等等都产生着巨大的帮助。

// money资金服务
@RequestMapping("/getById")
public Dto getById(Long id) {
    User user = userFeignClient.getUserById(userId); // 调用user用户服务
    return productFeignClient.getById(userId); // 调用product商品服务
}

上述代码是企业web应用中常见的代码，使用spring cloud实现服务间调用。那么，对这个代码，你是否联想到以下场景的问题。

以下对话是软件开发人员经常遇到的。 场景一：我的接口都谁在调用呢

小张：小王，user服务的获取getById()接口被哪些服务使用呢？
小王：原来业务不多的时候，我还知道。现在业务太复杂了，调用方太多，我已经记不清了。
小张：那么办，我接了一个需求，涉及原接口逻辑的变动，这个接口的调用方都要评估下影响面
小王：那你只能挨个负责服务的同事问下了
小张：太麻烦了，时间都用在寻找调用方上了

RD每天的宝贵时间都浪费在了维护服务和接口的调用关系上，为此失去了专研更有价值的业务的精力

场景二：我的服务都调了谁的服务的哪些接口

小姚：小修，我接手了一个product服务，为了尽量熟悉，我需要知道这个服务都依赖哪些服务，调了哪些接口？
小修：这个···，服务有个wiki文档，你看看呢
小姚：我看了，最新的更新时间是一年前
小修：恐怕你只能翻代码了
小姚：一行一行看代码!，我嚎哭

RD每天的宝贵时间都浪费在了维护服务和接口的调用关系上，为此失去了学习新技术的时间

本项目产生的意义就是为了收集和展示服务的调用关系，特别是服务中接口的调用关系。带来的价值为很好的避免了以往只能通过开发人员头脑记忆，要知道记忆是会减退的。所以利于准备评估后续需求开发涉及的影响面。 从而维护项目上线的稳定，增强服务可用性。所以，微服务梳子意在自动化理清微服务体系下的服务间关系调用

业务背景

微服务架构的流行，在业务分隔，服务复用，敏捷开发等方面带来了很大的飞跃。随着业务场景越来越丰富，业务领域越来越广泛，服务数量越来越庞大。随之，服务间调用越来越错综复杂。

本项目能带来什么

为了准确的知道服务及其接口的调用方信息，本项目为此而出现。通过本项目，你可以准确的、实时的获取服务及其接口的被调用(使用)情况，从而帮助你准备的评估迭代需求的工作量，及时统计出更改所影响的上游服务方，拔高说增强了服务的可维护性和稳定性，提高了可用性。

核心目标

本项目意在提供简单快速的使用教程，真正的协助微服务架构模式下的服务维护成本，减少RD们对服务接口调动错乱的记忆，当然也告别前人留下的大坑。

架构图

组件依赖

本项目基于spring cloud openfeign(目前版本:2.1.0.RELEASE)实现

实现原理

本项目分为三部分，一是调用信息收集及发送，二是接收并存储调用信息，三是图表展示微服务调用关系。调用信息的传递(发送和接收)采用的是CQRS模型

  1. 调用信息收集及发送 这部分功能由microservice-comb-infrastructure模块负责。具体原理为调用信息收集采用的是动态代理，通过代理LoadBalancerFeignClient类，使得有机会在服务调用时收集调用信息；并通过kafka发送调用信息给接收方。收集的逻辑通过自定义的InvocationHandler：LoadBalancerFeignClientInvocationHandler完成，发送调用信息通过MessageSender类完成。

  2. 接收并存储调用信息 这部分功能由microservice-comb-server模块负责。使用kafka接收调用信息，随之将信息持久化到硬盘，当前是保存到mysql数据库，后期会采用动态切换，支持mongodb等方式。

  3. 图表展示微服务调用关系 这部分功能由microservice-comb-admin模块负责。使用js等图表组件展示服务调用关系图，通过检索服务名/接口名可以知道：A服务的a接口的调用方信息，什么时间调的，一段时间内调用的次数等。但由于本人还不熟悉前端技术，暂时搁置这个模块。

项目结构

moduledescription
microservice-comb-admin调用信息图表展示,核心组件
microservice-comb-base基础工具包,核心组件
microservice-comb-infrastructure调用信息收集及发送,超核心组件
microservice-comb-server接收并保存调用信息,核心组件
microservice-comb-example使用例子，模拟业务方服务

特别说明：

microservice-comb-example包含三个module。
microservice-comb-server-a 模拟业务方服务，此模块引用microservice-comb-server-b-sdk
microservice-comb-server-b 模拟业务方服务
microservice-comb-server-b-sdk 模拟业务方服务sdk，此模块引用microservice-comb-infrastructure

使用实例

使用方式

使用很简单

总体分两步：

  • 资源准备
  • 引用sdk

资源准备

  1. kafka。调用信息发送和接收采用的kafka，所以你需要准备好运行着的kafka server，并把kafka的配置信息换成你的`kafka server信息

  2. mysql。你需要有mysql数据库。database: server_info，并建表

CREATE TABLE `server_invocation` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id，自增',
  `from_application` varchar(100) NOT NULL DEFAULT '' COMMENT '服务调用方',
  `to_application` varchar(100) NOT NULL DEFAULT '' COMMENT '服务被调用方',
  `from_path` varchar(100) NOT NULL DEFAULT '' COMMENT '服务调用方接口路径path',
  `to_path` varchar(100) NOT NULL DEFAULT '' COMMENT '服务被调用方接口路径path',
  `method` varchar(32) NOT NULL DEFAULT '' COMMENT '请求方式: GET POST',
  `ctime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `utime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `creator_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '操作人id',
  `create_name` varchar(32) NOT NULL DEFAULT '' COMMENT '操作人姓名',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='服务调用信息表';
  1. eureka 本项目是基于spring cloud体系，所以eureka是需要的

引用sdk

import源码后，通过mvn将microservice-comb-infrastructure打jar包, 然后引入到应用project中。将原来引用spring-cloud-starter-openfeign的模块或服务换成引用microservice-comb-infrastructure，如下

<dependency>
    <groupId>com.skyler.cobweb</groupId>
    <artifactId>microservice-comb-infrastructure</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

模拟实战

为方便使用和接入。microservice-comb-example模块提供了模拟实际公司中的微服务架构模式，microservice-comb-example包含三个子模块，整体关系为

microservice-comb-server-a依赖microservice-comb-server-b-sdk，因为microservice-comb-server-a需要调用sdk的feign接口
microservice-comb-server-b依赖microservice-comb-server-b-sdk，因为microservice-comb-server-b的controller实现sdk的feign接口
microservice-comb-server-b-sdk依赖microservice-comb-infrastructure
  1. 运行服务

依次运行如下服务

microservice-comb-server-a
microservice-comb-server-b
microservice-comb-server
  1. 访问microservice-comb-server-a接口

skyler@192 ~  curl -X GET 'localhost:9090/combo/getById?id=10'

  1. 查看数据库数据 如图所示

模拟企业实际应用

microservice-comb-admin的功能负责展示数据库的服务间调用关系图。由于本人没有学习前端技术。效果暂时通过查询sql展示

查看微服务下多个服务间调用关系

  • 查询microservice-comb-server-b调用了哪些服务及接口
SELECT * FROM server_invocation WHERE from_application = 'microservice-comb-server-b'

结果如下图， 20200314235524.png

Note: 支持展示精确到调用方法上，附加条件查询就好

  • 查询哪些服务及接口调用了microservice-comb-server-b
SELECT * FROM server_invocation WHERE to_application = 'microservice-comb-server-b'

结果如下图 20200314235605.png

项目地址: microservice-comb

avatar
文章
阅读
粉丝