VSCode 源码解读:IPC通信机制
更新日期:
最近在研究前端大型项目中要怎么管理模块间通信,本文记录研究 VSCode 中通信机制的过程,主要包括 IPC 部分吧。
Electron 的 通信机制
我们知道 Electron 是基于 Chromium + Node.js 的架构。同样基于 Chromium + Node.js 的,还有 NW.js,我们先来看看它们之间有什么不一样吧。
Electron 与 NW.js
说到 Node.js 的桌面应用,基本上大家都会知道 Electron 和 NW.js。例如 VsCode 就是基于 Electron 写的,而小程序开发工具则是基于 NW.js 来开发的。
我们知道,Node.js 和 Chromium 的运行环境不一样,它们的 JavaScript 上下文都有一些特有的全局对象和函数。在 Node.js 中包括 module、process、require等,在 Chromium 中会有 window、 documnet等。
那么,Electron 和 NW.js 都分别是怎样管理 Node.js 和 Chromium 的呢?
NW.js 内部架构
NW.js 是最早的 Node.js 桌面应用框架,架构如图1。
在 NW.js 中,将 Node.js 和 Chromium 整合在一起使用,其中做了几件事情,我们来分别看下。
Node.js 和 Chromium 都使用 V8 来处理执行的 JavaScript,因此在 NW.js 中它们使用相同的 V8 实例。
Node.js 和 Chromium 都使用事件循环编程模式,但它们用不同的软件库(Node.js 使用 libuv,Chromium 使用 MessageLoop/Message-Pump)。NW.js 通过使 Chromium 使用构建在 libuv 之上的定制版本的 MessagePump 来集成 Node.js 和 Chromium 的事件循环(如图2)。
- 整合 Node.js 的上下文到 Chromium 中,使 Node.js 可用(如图3)。
因此,虽然 NW.js 整合了 Node.js 和 Chromium,但它更接近一个前端的应用开发方式(如图4),它的入口是 index.html。
Electron 内部架构
Electron 强调 Chromium 源代码和应用程序进行分离,因此并没有将 Node.js 和 Chromium 整合在一起。
在 Electron 中,分为主进程(main process)和渲染器进程(renderer processes):
- 主进程:一个 Electron 应用中,有且只有一个主进程(package.json 的 main 脚本)
- 渲染进程:Electron 里的每个页面都有它自己的进程,叫作渲染进程。由于 Electron 使用了 Chromium 来展示 web 页面,所以 Chromium 的多进程架构也被使用到
那么,不在一个进程当然涉及跨进程通信。于是,在 Electron 中,可以通过以下方式来进行主进程和渲染器进程的通信:
- 利用
ipcMain
和ipcRenderer
模块进行 IPC 方式通信,它们是处理应用程序后端(ipcMain
)和前端应用窗口(ipcRenderer
)之间的进程间通信的事件触发。 - 利用
remote
模块进行 RPC 方式通信。
remote
模块返回的每个对象(包括函数),表示主进程中的一个对象(称为远程对象或远程函数)。当调用远程对象的方法时,调用远程函数、或者使用远程构造函数 (函数) 创建新对象时,实际上是在发送同步进程消息。
如图5,Electron 中从应用程序的后端部分到前端部分的任何状态共享(反之亦然),均通过ipcMain
和ipcRenderer
模块进行。这样,主进程和渲染器进程的 JavaScript 上下文将保持独立,但是可以在进程之间以显式方式传输数据。
VSCode 的通信机制
VSCode 基于 Electron 进行开发的,那么我们来看看 VSCode 里的相关设计吧。
VSCode 多进程架构
VSCode 采用多进程架构,VSCode 启动后主要有下面的几个进程:
- 主进程
- 渲染进程,多个,包括 Activitybar、Sidebar、Panel、Editor 等等
- 插件宿主进程
- Debug 进程
- Search 进程
这些进程间的关系如图6:
而在 VSCode 中,这些进程的通信方式同样包括 IPC 和 RPC 两种,如图7:
IPC 通信
我们能看到,主进程和渲染进程的通信基础还是 Electron 的webContents.send
、ipcRender.send
、ipcMain.on
。
我们来看看 VSCode 中具体的 IPC 通信机制设计,包括:协议、频道、连接等。
协议
IPC 通信中,协议是最基础的。就像我们人和人之间的交流,需要使用约定的方式(语言、手语),在 IPC 中协议可看做是约定。
作为通信能力,最基本的协议范围包括发送和接受消息:
1 | export interface IMessagePassingProtocol { |
至于具体协议内容,可能包括连接、断开、事件等等:
1 | export class Protocol implements IMessagePassingProtocol { |
我们能看到,IPC 的通信也使用了 VSCode 中的Event
/Emitter
事件机制,关于事件的更多可以参考《VSCode源码解读:事件系统设计》。
IPC 实际上就是发送和接收信息的能力,而要能准确地进行通信,客户端和服务端需要在同一个频道上。
频道
作为一个频道而言,它会有两个功能,一个是点播call
,一个是收听,即listen
。
1 | /** |
客户端与服务端
一般来说,客户端和服务端的区分主要是:发起连接的一端为客户端,被连接的一端为服务端。在 VSCode 中,主进程是服务端,提供各种频道和服务供订阅;渲染进程是客户端,收听服务端提供的各种频道/服务,也可以给服务端发送一些消息(接入、订阅/收听、离开等)。
不管是客户端和服务端,它们都会需要发送和接收消息的能力,才能进行正常的通信。
在 VSCode 中,客户端包括ChannelClient
和IPCClient
,ChannelClient
只处理最基础的频道相关的功能,包括:
- 获得频道
getChannel
。 - 发送频道请求
sendRequest
。 - 接收请求结果,并处理
onResponse/onBuffer
。
1 | // 客户端 |
同样的,服务端包括ChannelServer
和IPCServer
,ChannelServer
也只处理与频道直接相关的功能,包括:
- 注册频道
registerChannel
。 - 监听客户端消息
onRawMessage/onPromise/onEventListen
。 - 处理客户端消息并返回请求结果
sendResponse
。
1 | // 服务端 |
我们能看到,作为频道的直接连接对象,ChannelClient
和ChannelServer
的发送和接收基本上是一一对应的,像sendRequest
和sendResponse
等等。但ChannelClient
只能发送请求,而ChannelServer
只能响应请求,在阅读完整篇文章后,可以思考一下:如果我们想要实现双向通信的话,可以怎么做呢?
我们还发现,对消息的发送和接受,ChannelClient
和ChannelServer
会进行序列化(serialize
)和反序列化(deserialize
):
1 | // 此处篇幅关系,以 deserialize 举例: |
那么,IPCClient
和IPCServer
又起到什么作用呢?
连接
现在有了频道直接相关的客户端部分ChannelClient
和服务端部分ChannelServer
,但是它们之间需要连接起来才能进行通信。一个连接(Connection
)由ChannelClient
和ChannelServer
组成。
1 | interface Connection<TContext> extends Client<TContext> { |
而连接的建立,则由IPCServer
和IPCClient
负责。其中:
IPCClient
基于ChannelClient
,负责简单的客户端到服务端一对一连接IPCServer
基于channelServer
,负责服务端到客户端的连接,由于一个服务端可提供多个服务,因此会有多个连接
1 | // 客户端 |
前面也说过,客户端可理解为渲染进程,服务端可理解为主进程。
而连接的详细建立过程,可以参考《vscode-通信机制设计解读(Electron)》一文。这里借用里面的一张图:
参考
- vscode 定制开发 —— Workbench 源码解读及实战前言
- vscode 定制开发 —— 基础准备
- 【译】探索NW.js和Electron的内部
- vscode-通信机制设计解读(Electron)
- 你不知道的 Electron (一):神奇的 remote 模块
结束语
IPC 和 RPC 通信是由于 Electron 的跨进程通信出现的。那么,我们还可以思考下,在一般的前端开发场景下,除了跨进程以外是否还有其他场景可以参考呢?
至于 RPC 的部分,由于目前也没有强业务相关,有空我们下次再约。
码生艰难,写文不易,给我家猪囤点猫粮了喵~
查看Github有更多内容噢:https://github.com/godbasin
更欢迎来被删的前端游乐场边撸猫边学前端噢
如果你想要关注日常生活中的我,欢迎关注“牧羊的猪”公众号噢