IM跨平台技术学习(三)：vivo的Electron技术栈选型、全方位实践总结

本文由vivo技术团队Yang Kun分享，原题“ 应用开发优秀实践”，本文有修订。

在上篇《》的分享中，我们已经对Electron跨端的开发有了大概的了解。

本篇将基于vivo技术团队的技术实践，详细阐述了vivo在使用Electron进行跨端桌面开发时的选型考量，同时分享了在打包构建、版本更新、性能优化、质量保障、安全性等方面的实践方案和踩坑总结。

本文是系列文章中的第3篇，本系列总目录如下：

因业务发展，我们需要用到桌面端技术，技术特性涉及离线可用、调用桌面系统能力等要求。

那么什么是桌面端开发？一句话概括就是：以 Windows 、MacOS 和 Linux 为操作系统的桌面软件开发。

对此我们做了详细的技术调研：桌面端的开发方式主要有 Native 、 QT 、  、 NW 、  、  。

这些技术各自优劣势如下表格所示：

我们最终的桌面端技术选型是 Electron，Electron 是一个可以使用 Web 技术来开发跨平台桌面应用的开发框架。

其技术组成如下：

Electron = Chromium + Node.js + Native API

各技术能力如下图所示：

整体架构如下图所示：

Electron 是多进程架构，架构具有以下特点：

这里回顾一下 Electron 进程间通信技术原理。

electron 使用 IPC （interprocess communication） 在进程之间进行通信。

如下图所示：

其提供了 IPC 通信模块，主进程的 ipcMain 和渲染进程的 ipcRenderer。

从 electron 源码中可以看出， ipcMain 和 ipcRenderer 都是 EventEmitter 对象。

源码如下图所示：

看到源码实现，是不是觉得 IPC 不难理解了。知其本质，方可游刃有余。

限于篇幅，这里对Electron的基础知识就不再展开，有兴趣的读者可回顾一下本系列的前两篇《》、《)》（这篇中的“5、进程详解”特别介绍了Electron进程间的关系以及通信原理）。

4.1编程语言选型

我们最终选择的是Typescript，理由如下。

针对开发者：

针对工具：

社区支持：大量的社区的类型定义文件 提升开发效率。

4.2构建工具选型

我们选择的是 。

理由很充分：Electron-Forge简单而又强大，目前 electron 应用最好的构建工具之一。

这里提一下  其和  的介绍和区别。

看下图所示：

两者最大的区别在于自由度，两者在能力上基本没什么差异了，从官方组织中的排序看，有意优先推荐 electron-forge 。

4.3Web方案选型

我们采用的是  ，同时使用  作为构建工具，具体优点，大家可以查看官网介绍，这套组合是目前主流的 Web 开发方案。

4.4monorepo方案选型

目前的 monorepo 生态百花齐放，正确的实践方法应该是集大成法，也就是取各家之长，目前的趋势也是如此，各开源 monorepo 工具达成默契，专注自己擅长的能力。

如 pnpm 擅长依赖管理， turbo 擅长构建任务编排。遂在 monorepo 技术选型上，我选择了  和  。

以下是pnpm的：

pnpm 理由如下：

相比于 vue 官网，在使用 pnpm 上，我加了 workspace 。

 理由如下：

4.5本地数据库选型

Electron 应用数据库有非常多的选择如  、  、 electron-store 、 pouchdb 、 dedb 、 rxdb 、 dexie 、 ImmortalDB 等。

这些数据库都有一个特性，那就是无服务器。

Electron本地数据库技术选型考虑因素主要有：

我们通过以下渠道进行了相关调研：

给出四个最优选择，分别是 lowdb 、 sqlite3 、 nedb 、 electron-store 。

我们的理由如下：

我们使用的数据库最终选型是  方案。

PS：提一下  ，如果需要将本地数据同步到远端数据库，可以使用 pouchdb ，其和  可以轻松完成同步。

4.6脚本工具选型

软件开发过程中，将一些流程和操作通过脚本来完成，可以有效地提高开发效率和幸福度。

依赖 node runtime 的优秀选择就两个： 和  。

选择 zx 的理由如下：

至此，技术选型就介绍完了。

5.1应用图标生成

不同尺寸图标的生成有以下方法。

Windows：

MacOS：

5.2二进制文件构建

本章节内容是基于 electron-forge 阐述的，不过原理是一样的。

在开发桌面端应用时，会有场景要用到第三方的二进制程序，比如 ffmpeg 这种。

在构建二进制程序时，要关注以下两个注意项。

1）二进制程序不能打包进 asar 中 可以在构建配置文件（forge.config.js）进行如下设置：

const os = require('os') const platform = os.platform() const config = {   packagerConfig: {     // 可以将 ffmpeg 目录打包到 asar 目录外面     extraResource: [`https://cloud.tencent.com/developer/article/src/main/ffmpeg/`]   } }

2）开发和生产环境，获取二进制程序路径方法是不一样的 可以采用如下代码进行动态获取：

import { app } from 'electron' import os from 'os' import path from 'path' const platform = os.platform() const dir = app.getAppPath() let basePath = '' if(app.isPackaged) basePath = path.join(process.resourcesPath) elsebasePath = path.join(dir, 'ffmpeg') const isWin = platform === 'win32' // ffmpeg 二进制程序路径 const ffmpegPath = path.join(basePath, `${platform}`, `ffmpeg${isWin ? '.exe':

5.3按需构建

如何对跨平台二进制文件进行按需构建呢？

比如桌面应用中用到了 ffmpeg ， 它需要有 windows 、 mac 和 linux 的下载二进制。

在打包的时候，如果不做按需构建，则会将 3 个二进制文件全部打到构建中，这样会让应用体积增加很多。

可以在 forge.config.js 配置文件中进行如下配置，即可完成按需构建。

代码如下：

const platform = os.platform() const config = {   packagerConfig: {     extraResource: [`https://cloud.tencent.com/developer/article/src/main/ffmpeg/${platform}`]   }, }

通过 platform 变量来把对应系统的二进制打到构建中，即可完成对二进制文件的按需构建。

5.4性能优化

主要是构建速度和构建体积优化，构建速度这块不好优化。这里重点说下构建体积优化，拿 mac 系统举例说明， 在 electron 应用打包后，查看应用包内容。

如下图所示：

可以看到有一个 app.asar 文件。

这个文件用 asar 解压后可以看到有以下内容：

可以看出 asar 中的文件，就是我们构建后的项目代码，从图中可以看到有 node_modules 目录， 这是因为在 electron 构建机制中，会自动把 dependencies 的依赖全部打到 asar 中。

结合上述分析，我们的优化措施有以下4点：

这里提下第 4） 点，如何对 node_modules 进行清理精简呢？

如果是 yarn 安装的依赖：我们可以在根目录使用下面命令进行精简：

yarn autoclean -I yarn autoclean -F

如果是 pnpm 安装的依赖：第 4）点应该不起作用了。我在项目中使用 yarn 安装依赖，然后执行上述命令后，发现打包体积减少了 6M ， 虽然不多，但也还可以。

6.1全量更新

全量更新就是通过下载最新的包或者 zip 文件，进行软件更新，需要替换所有的文件。

整体设计流程图如下：

按照流程图去实现，我们需要做以下事情：

6.2增量更新

增量更新是通过拉取最新的渲染层打包文件，覆盖之前的渲染层代码，完成软件更新，此方案只需替换渲染层代码，无需替换所有文件。

按照流程图去实现，我们需要做以下事情：

打包构建优化在上节内容中已经详细介绍过了，这里不再介绍，下面将介绍我们对“启动时优化”和“运行时优化”的实践。

7.1启动时优化

主要从以下几个方面着手：

7.1.1）使用 v8-compile-cache 缓存编译代码：

使用 V8 缓存数据，为什么要这么做呢？

因为 electorn 使用 V8 引擎运行 js ， V8 运行 js 时，需要先进行解析和编译，再执行代码。其中，解析和编译过程消耗时间多，经常导致性能瓶颈。而 V8 缓存功能，可以将编译后的字节码缓存起来，省去下一次解析、编译的时间。

主要使用 v8-compile-cache 来缓存编译的代码，做法很简单：在需要缓存的地方加一行。

1require('v8-compile-cache')

其他使用方法请查看此链接文档 ：

7.1.2）优先加载核心功能，非核心功能动态加载：

伪代码如下：

export functionshare() {   const kun = require('kun')   kun() }

7.2运行时优化

主要从以下几个方面着手：

7.2.1）对渲染进程 进行 Web 性能优化：

用一个思维导图来完整阐述如何进行 Web 性能优化，如下图所示：

上图基本包含了性能优化的核心关键点和内容，大家可以以此作为参考，去做性能优化。

7.2.2）对主进程进行轻量瘦身：

核心方案就是将运行时耗时、计算量大的功能交给新开的 node 进程去执行处理。

伪代码如下：

const { fork } = require('child_process') let { app } = require('electron') functioncreateProcess(socketName) {   process = fork(`xxxx/server.js`, [     '--subprocess',     app.getVersion(),     socketName   ]) } const initApp = async () => {   // 其他初始化代码...   let socket = await findSocket()   createProcess(socket) } app.on('ready', initApp)

通过以上代码，将耗时、计算量大的功能，放在 server.js ，然后再 fork 到新开 node 进程中进行处理。

至此，性能优化实践就介绍完了。

8.1概述

质量保障的全流程措施如下图所示：

本节主要从以下3个方面分享：

下面将会依次介绍上述内容。

8.2自动化测试

自动化测试是什么？

上图是做自动化测试一个完整步骤，大家可以看图领会。

自动化测试主要分为 单元测试、集成测试、端到端测试。

三者关系如下图所示：

一般情况下：作为软件工程师，我们做到一定的单元测试就可以了。而且从我目前经验来说，如果是写业务性质的项目，基本上不会编写测试相关的代码。

自动化测试主要是用来编写库、框架、组件等需要作为单独个体提供给他人使用的。

electron 的测试工具推荐  、 spectron 。具体用法参考官网文档即可，没什么特别的技巧。

8.3崩溃监控

对于 GUI 软件，尤其桌面端软件来说，崩溃率非常重要，因此需要对崩溃进行监控。

崩溃监控原理如下图所示：

崩溃监控技巧：

崩溃监控做好后，如果发生崩溃，该如何治理崩溃呢？

8.4崩溃治理

崩溃治理难点：

崩溃治理技巧：

9.1概述

俗话说的好，安全大于天，保证 electron 应用的安全也是一项重要的事情。

本章节将安全分为以下 5 个方面：

下面将会依次介绍上述内容。

9.2源码泄漏

目前 electron 在源码安全做的不好，官方只用 asar 做了一下很没用的源码保护，到底有多没用呢？

你只需要下载 asar 工具，然后对 asar 文件进行解压就可以得到里面的源码了。

如下图所示：

通过图中操作即可看到语雀应用的源码。上面提到的 asar 是什么呢？

9.3asar介绍

asar 是一种将多个文件合并成一个文件的类 tar 风格的归档格式。Electron 可以无需解压整个文件，即可从其中读取任意文件内容。

可以直接看 electron 源码，都是 ts 代码，容易阅读，源码如下图所示：

9.4源码保护

避免源码泄漏，按照从低到高的源码安全，可以分为几个程度。

具体如下：

其中：Language bindings 是最高的源码安全措施，其实使用 C++ 或 Rust 代码来编写 electron 应用代码，通过将 C++ 或 Rust 代码编译成二进制代码后，破译的难度会变高。

这里我说下如何使用 Rust 去编写 electron 应用代码。

方案是：使用 napi-rs 作为工具去编写，如下图所示：

我们采用 pnpm-workspace 去管理 Rust 代码，使用 napi-rs 。

比如我们写一个 sum 函数，rs代码如下：

fn sum(a: f64, b: f64) -> f64 {   a + b }

此时我们加上 napi 装饰代码，如下所示：

use napi_derive::napi; #[napi] fn sum(a: f64, b: f64) -> f64 {   a + b } 在通过 napi-cli 将上述代码编译成 node 可以调用的二进制代码。

编译后，在electron使用上述代码，如下所示：

import { sum as rsSum } from '@rebebuca/native' // 输出 7 console.log(rsSum(2, 5))

napi-rs 的使用请阅读官方文档，地址是：

至此，language bindings 的阐述就完成了。我们通过这种方式，可以完成对重要功能的源码保护。

9.5应用安全

目前熟知的一个安全问题是克隆攻击，此问题的主流解决方案是将用户认证信息和应用设备指纹进行绑定。

整体流程如如下图所示：

如上图所示：

9.6编码安全

主要有以下措施：

以上具体细节不再介绍，自行搜索上述方案。

除此之外，还有个官方推荐的最佳安全实践，有空可以看看，地址如下：。

至此，安全性这块实践就介绍完了。

本文介绍了我们对跨系统桌面端技术的调研、确定技术选型，以及用 electron 开发过程中，总结的实践经验及踩坑填坑过程，如构建、性能优化、质量保障、安全等。

希望对读者在开发跨端桌面应用过程中有所帮助，文章难免有不足和错误的地方，欢迎读者评论。

[1] 

[2] 》

[3] 

[4] 

[5] 

学习交流：

- 移动端IM开发入门文章：《》

- 开源IM框架源码：（）