electron-api-gateway

ApiGateway 设计

1.项目说明

这是一个基于electron主进程的api管理框架。我们项目组对electron技术的使用较多，这个也算是经验的总结，经历过生产环境的考验。本项目的所有代码和文档都是我个人完成，只是将框架的核心思想提取出来实现并开源。

1.1 框架要解决的问题

首先说一下项目的组成，我们是一个以electron为核心的PC端项目，以安装包的形式发布版本。

1.1.1 项目现状

1. 进程数量多：其中带UI进程窗口40个以上，还有一些无UI的进程。
2. 进程实现的语言多：有electron渲染进程和主进程，node进程，C++进程。
3. 进程之间通信方式多：进程并不是完全独立的，各个进程之间需要根据业务有通信交互，这些交互有些以IPC形式完成，如electron的渲染进程和主进程通过ipc通信；有些是通过本地开启的消息服务器通过订阅主题完成的，如C++进程通过内部的消息服务器与主进程通信。

1.1.2 问题

我们来看几个ipc通信场景，最复杂的是electron的渲染进程跟C++进程通信

1. electron渲染进程跟C++进程通信
2. electron渲染进程和主进程
3. C++进程和主进程
4. 主进程和node进程
5. node进程和electron渲染进程

原有的设计是这样，每次一个进程发消息给另一个进程都是通过electron主进程做中转。然后每次由于新的业务，都需要新加一条通信通道。所以每次新加一个条通信通道至少需要改动三个项目的代码（消息发起进程=> 主进程=> 消息接收进程），而且这仅仅是消息发送，如果要拿到消息请求的返回值仍然需要加一条新的通道。而且消息传递过程中出错，那么问题几乎无法定位。因为报错可能是发生在任何地方。发送端，中转端，接收端，甚至是消息处理报错。根据已有的方案我们可以总结出来以下问题：

1. 每次添加新的消息都需要去加新的通道，通道名，需要至少修改三个项目的代码。