应用打包

优质
小牛编辑
144浏览
2023-12-01

为解决Windows中路径过长的问题issues, 并且更快的 require以及简单的隐匿源码, 你可以将代码打包成 [asar][asar].

打包成 asar

[asar][asar]类似于 tar压缩包,它将全部文件打包至一个文件里,Electron可从中读取且无需解压整个文件.
打包成 asar 的两个步骤:

1. 安装 asar

1
$ npm install -g asar
Copied!

2. 用 asar pack打包

1
$ asar pack your-app app.asar
Copied!

使用 asar

在Electron中有两组API: 由Chromium提供的Node.js和Web API提供的Node API, 这两种API都支持从 asar中读取.

Node API

由于 Electron 中打了特别补丁, Node API 中如 fs.readFile 或者 require 之类的方法可以将 asar 当作虚拟文件夹,读取 asar 里面的文件就和从真实的文件系统中读取一样。
假设我们在 /path/to 文件夹下有个 example.asar 包:
1
$ asar list /path/to/example.asar
2
/app.js
3
/file.txt
4
/dir/module.js
5
/static/index.html
6
/static/main.css
7
/static/jquery.min.js
Copied!

asar 包读取一个文件:
1
const fs = require('fs')
2
fs.readFileSync('/path/to/example.asar/file.txt')
Copied!

列出 asar 包中根目录下的所有文件:
1
const fs = require('fs')
2
fs.readdirSync('/path/to/example.asar')
Copied!

使用 asar 包中的一个模块:
1
require('/path/to/example.asar/dir/module.js')
Copied!

您还可以使用 BrowserWindow 来显示一个 asar 包里的 web 页面:
1
const {BrowserWindow} = require('electron')
2
let win = new BrowserWindow({width: 800, height: 600})
3
win.loadURL('file:///path/to/example.asar/static/index.html')
Copied!

Web API

在 Web 页面里,用 file: 协议可以获取 asar 包中文件。和 Node API 一样,视 asar 包如虚拟文件夹。
例如,用 $.get 获取文件:
1
<script>
2
let $ = require('./jquery.min.js')
3
$.get('file:///path/to/example.asar/file.txt', (data) => {
4
console.log(data)
5
})
6
</script>
Copied!

asar当成普通文件

有些场景,如:核查 asar 包的校验值,我们需要像读取普通文件那样读取 asar 包的内容(而不是当成虚拟文件夹)。
你可以使用内置的 original-fs (提供和 fs 一样的 API)模块来读取 asar 包的真实信息:
1
const originalFs = require('original-fs')
2
originalFs.readFileSync('/path/to/example.asar')
Copied!

您也可以将 process.noAsar设置为 true,以禁用 fs模块中 asar的支持:
1
const fs = require('fs')
2
process.noAsar = true
3
fs.readFileSync('/path/to/example.asar')
Copied!

Node API 缺陷

尽管我们已经尽了最大努力使得 asar 包在 Node API 下的应用尽可能的趋向于真实的目录结构,但仍有一些底层 Node API 我们无法保证其正常工作。

asar 包是只读的

asar 包中的内容不可更改,所以 Node APIs 里那些可以用来修改文件的方法在对待 asar 包时都无法正常工作。

Working Directory 在 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 native模块时用到

fs.stat 获取的 stat 信息不可靠

asar 包中的文件取 fs.stat,返回的 Stats 对象不是精确值,因为这些文件不是真实存在于文件系统里。所以除了文件大小和文件类型以外,你不应该依赖 Stats 对象的值。

执行 asar 包中的程序

Node 中有一些可以执行程序的 API,如 child_process.execchild_process.spawnchild_process.execFile 等,但只有 execFile 可以执行 asar 包中的程序。
因为 execspawn 允许 command 替代 file 作为输入,而 command 是需要在 shell 下执行的,目前没有可靠的方法来判断 command 中是否在操作一个 asar 包中的文件,而且即便可以判断,我们依旧无法保证可以在无任何副作用的情况下替换 command 中的文件路径。

打包时排除文件

如上所述,一些 Node API 会在调用时将文件解压到文件系统中,除了效率问题外,也有可能引起杀毒软件的注意!
为解决这个问题,你可以在生成 asar 包时使用 --unpack 选项来排除一些文件,使其不打包到 asar 包中,下面是如何排除一些用作共享用途的 native 模块的方法:
1
$ asar pack app app.asar --unpack *.node
Copied!

经过上述命令后,除了生成的 app.asar 包以外,还有一个包含了排除文件的 app.asar.unpacked 文件夹,你需要将这个文件夹一起拷贝,提供给用户。
[asar]: https://github.com/electron/asar