- 应用程序打包
- 生成 asar 档案文件
- 1. 安装 asar 实用程序
- 2. 使用 asar pack 打包
- 使用 asar 档案文件
- Node API
- Web API
- 把 asar 档案当作一个普通的文件
- Node API 的局限性
- 档案文件是只读的
- 工作目录不能设置为档案文件里的目录
- 某些 API 需要额外解压档案包
- fs.stat 的不真实统计信息
- 执行asar档案内的二进制文件
- 添加未打包的文件到 asar 档案
- 生成 asar 档案文件
应用程序打包
为缓解 Windows 下路径名过长的 问题, 略微加快一下 require
的速度以及隐藏你的源代码,你可以选择把你的应用打包成 asar档案文件,这只需要对你的源代码做一些很小的改动。
大部分用户可以毫不费力地使用这个功能,因为它electron-packager
,、electron-forge
和electron-builder
中都得到了支持,开箱即用。 如果你没有使用这些工具中的任何一个,那么请继续阅读。
生成 asar 档案文件
asar 是一种将多个文件合并成一个文件的类 tar 风格的归档格式。 Electron 可以无需解压整个文件,即可从其中读取任意文件内容。
参照如下步骤将你的应用打包成 asar
归档文件。
1. 安装 asar 实用程序
$ npm install -g asar
2. 使用 asar pack 打包
$ asar pack your-app app.asar
使用 asar 档案文件
在 Electron 中有两类 APIs:Node.js 提供的 Node API 和 Chromium 提供的 Web API。 这两种 API 都支持从 asar
档案中读取文件。
Node API
由于 Electron 中打了特别补丁, Node API 中如 fs.readFile
或者 require
之类 的方法可以将 asar
视之为虚拟文件夹,读取 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('fs')
fs.readFileSync('/path/to/example.asar/file.txt')
列出档案根目录下的所有文件:
const fs = require('fs')
fs.readdirSync('/path/to/example.asar')
使用档案中的模块:
require('/path/to/example.asar/dir/module.js')
你也可以使用 BrowserWindow
来显示一个 asar
档案里的 web 页面:
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.loadURL('file:///path/to/example.asar/static/index.html')
Web API
在 Web 页面里,用 file:
协议可以获取 asar
包中文件。和 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
档案文件。 为此你可以使用内置的没有asar
功能的和原始fs
模块一模一样的original-fs
模块。
const originalFs = require('original-fs')
originalFs.readFileSync('/path/to/example.asar')
您也可以将 process.noAsar
设置为 true
以禁用 fs
模块中对 asar
的支持:
const fs = require('fs')
process.noAsar = true
fs.readFileSync('/path/to/example.asar')
Node API 的局限性
尽管我们已经尽了最大努力使得 asar
包在 Node API 下的应用尽可能的趋向于真实的目录结构,但仍有一些底层 Node API 我们无法保证其正常工作。
档案文件是只读的
档案文件中的内容不可更改,所以 Node APIs 里那些会修改文件的方法在使用asar
归档文件时都无法正常工作.
工作目录不能设置为档案文件里的目录
尽管 asar
档案是虚拟文件夹,但其实并没有真实的目录架构对应在文件系统里,所以你不可能将 working Directory 设置成 asar
包里的一个文件夹。 将 asar 中的文件夹以 cwd
形式作为参数传入一些 API 中也会报错。
某些 API 需要额外解压档案包
大部分 fs
API 可以无需解压即从 asar
档案中读取文件或者文件的信息,但是在处理一些依赖真实文件路径的底层系统方法时,Electron 会将所需文件解压到临时目录下,然后将临时目录下的真实文件路径传给底层系统方法使其正常工作。 对于这类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.exec
,child_process.spawn
和 child_process.execFile
等, 但只有 execFile
可以执行 asar
包中的程序。
因为 exec
和 spawn
允许 command
替代 file
作为输入,而 command
是需要在 shell 下执行的. 目前没有 可靠的方法来判断 command 中是否在操作一个 asar 包中的文件,而且即便可以判断,我们依旧无法保证可以在无任何 副作用的情况下替换 command 中的文件路径。
添加未打包的文件到 asar 档案
如上所述,一些节点APIs将在 调用时解压文件。除了性能问题之外,各种抗病毒扫描器可能会因此行为触发 。
有一个解决方法,您可以使用 —unpack
选项保持各种文件不被压缩。 在下面这个例子中,原生 Node.js 模块的共享库将不会被打包:
$ asar pack app app.asar --unpack *.node
运行命令后,您将会看到 app.asar.unpacked
文件夹与 app.asar
文件一起被创建了。 没有被打包的文件和 app.asar
会一起存档发布。