跳转到主要内容

ASAR 存档

在创建了应用程序分发后,应用的源代码通常会被打包成一个ASAR 存档,这是一种专为 Electron 应用设计的简单扩展存档格式。通过打包应用,我们可以缓解 Windows 上长路径名问题,加快 require 速度,并能从粗略的检查中隐藏你的源代码。

打包的应用运行在一个虚拟文件系统中,大多数 API 都能正常工作,但由于一些细微差别,在某些情况下你可能需要显式地处理 ASAR 存档。

使用 ASAR 存档

在 Electron 中,有两种 API:Node.js 提供的 Node API 和 Chromium 提供的 Web API。这两种 API 都支持从 ASAR 存档中读取文件。

Node API

通过 Electron 中的特殊补丁,像 fs.readFilerequire 这样的 Node API 会将 ASAR 存档视为虚拟目录,并将其中的文件视为文件系统中的普通文件。

例如,假设在 /path/to 下有一个 example.asar 存档

$ asar list /path/to/example.asar
/app.js
/file.txt
/dir/module.js
/static/index.html
/static/main.css
/static/jquery.min.js

读取 ASAR 存档中的文件

const fs = require('node:fs')
fs.readFileSync('/path/to/example.asar/file.txt')

列出存档根目录下的所有文件

const fs = require('node:fs')
fs.readdirSync('/path/to/example.asar')

使用存档中的模块

require('./path/to/example.asar/dir/module.js')

你还可以使用 BrowserWindow 在 ASAR 存档中显示网页

const { BrowserWindow } = require('electron')
const win = new BrowserWindow()

win.loadURL('file:///path/to/example.asar/static/index.html')

Web API

在网页中,可以使用 file: 协议请求存档中的文件。与 Node API 类似,ASAR 存档被视为目录。

例如,使用 $.get 获取文件

<script>
let $ = require('./jquery.min.js')
$.get('file:///path/to/example.asar/file.txt', (data) => {
console.log(data)
})
</script>

将 ASAR 存档视为普通文件

在某些情况下,例如验证 ASAR 存档的校验和,我们需要将 ASAR 存档的内容作为文件读取。为此,你可以使用内置的 original-fs 模块,它提供了原始的 fs API,并且不支持 asar

const originalFs = require('original-fs')
originalFs.readFileSync('/path/to/example.asar')

你还可以将 process.noAsar 设置为 true 来禁用 fs 模块中对 asar 的支持。

const fs = require('node:fs')
process.noAsar = true
fs.readFileSync('/path/to/example.asar')

Node API 的限制

尽管我们尽力使 Node API 中的 ASAR 存档尽可能像目录一样工作,但由于 Node API 的底层特性,仍然存在一些限制。

存档是只读的

存档无法被修改,因此所有可以修改文件的 Node API 都无法与 ASAR 存档一起使用。

工作目录不能设置为存档中的目录

尽管 ASAR 存档被视为目录,但文件系统中没有实际的目录,因此你永远无法将工作目录设置为 ASAR 存档中的目录。将它们作为某些 API 的 cwd 选项传递也会导致错误。

某些 API 的额外解压

大多数 fs API 可以在不解压的情况下从 ASAR 存档中读取文件或获取文件信息,但对于一些依赖于将真实文件路径传递到底层系统调用的 API,Electron 会将所需文件提取到一个临时文件中,并将临时文件的路径传递给 API 以使其正常工作。这会为这些 API 增加一些开销。

需要额外解压的 API 有:

  • child_process.execFile
  • child_process.execFileSync
  • fs.open
  • fs.openSync
  • process.dlopen - require 在使用原生模块时会调用它。

fs.stat 的虚假统计信息

在 ASAR 存档中的文件上,由 fs.stat 及其相关函数返回的 Stats 对象是通过猜测生成的,因为这些文件在文件系统中并不存在。因此,除了获取文件大小和检查文件类型之外,你不应该信任 Stats 对象。

执行 ASAR 存档内的二进制文件

有一些 Node API 可以执行二进制文件,例如 child_process.execchild_process.spawnchild_process.execFile,但只有 execFile 支持执行 ASAR 存档内的二进制文件。

这是因为 execspawn 接受 command 而不是 file 作为输入,并且 command 是在 shell 下执行的。没有可靠的方法来确定一个命令是否使用了 ASAR 存档中的文件,即使我们能做到,也不能确定是否可以在不产生副作用的情况下替换命令中的路径。

将未打包文件添加到 ASAR 存档

如上所述,一些 Node API 在被调用时会将文件解压到文件系统。除了性能问题外,这种行为还可能触发各种防病毒扫描程序。

作为一种变通方法,你可以使用 --unpack 选项将各种文件保持未打包状态。在以下示例中,原生 Node.js 模块的共享库将不会被打包:

$ asar pack app app.asar --unpack *.node

运行命令后,你会注意到与 app.asar 文件一起创建了一个名为 app.asar.unpacked 的文件夹。它包含未打包的文件,并且应该与 app.asar 存档一起分发。