向导 - 打包应用
asar是一种将多个文件合并成一个文件的类tar风格的归档格式。 Electron可以无需解压,即从其中读取任意文件内容。
参照如下步骤将你的应用打包成asar
:
2. 用asar pack
打包
$ asar pack your-app app.asar
在Electron中有两类APIs:Node.js提供的Node APIs和Chromium提供的Web APIs。这两种APIs都支持从asar
包中读取文件。
Node API
由于Electron中打了特别补丁, Node APIs中如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
包读取一个文件:
列出asar
包中根目录下的所有文件:
const fs = require('fs');
fs.readdirSync('/path/to/example.asar');
你也可以使用BrowserWindow
来显示一个asar
包里的web页面:
在Web页面里,用file:
协议可以获取asar
包中文件。和Node API一样,视asar
包如虚拟文件夹。
例如,用$.get
获取文件:
var $ = require('./jquery.min.js');
$.get('file:///path/to/example.asar/file.txt', function(data) {
console.log(data);
});
</script>
像“文件”那样处理asar
包
有些场景,如:核查asar
包的校验和,我们需要像读取“文件”那样读取asar
包的内容(而不是当成虚拟文件夹)。你可以使用内置的original-fs
(提供和fs
一样的APIs)模块来读取asar
包的真实信息。
var originalFs = require('original-fs');
originalFs.readFileSync('/path/to/example.asar');
尽管我们已经尽了最大努力使得asar
包在Node API下的应用尽可能的趋向于真实的目录结构,但仍有一些底层Node API我们无法保证其正常工作。
asar
包是只读的
asar
包中的内容不可更改,所以Node APIs里那些可以用来修改文件的方法在对待asar
包时都无法正常工作。
尽管asar
包是虚拟文件夹,但其实并没有真实的目录架构对应在文件系统里,所以你不可能将working Directory设置成asar
包里的一个文件夹。将asar
中的文件夹以cwd
形式作为参数传入一些API中也会报错。
API中的额外“开箱”
以下是一些需要额外解压的APIs:
child_process.execFileSync
fs.open
fs.openSync
process.dlopen
-require
native模块时用到
fs.stat
获取的stat信息不可靠
对asar
包中的文件取fs.stat
,返回的Stats
对象不是精确值,因为这些文件不是真实存在于文件系统里。所以除了文件大小和文件类型以外,你不应该依赖Stats
对象的值。
Node中有一些可以执行程序的API,如child_process.exec
,child_process.spawn
和child_process.execFile
等,但只有execFile
可以执行asar
包中的程序。
因为exec
和spawn
允许command
替代file
作为输入,而command
是需要在shell下执行的,目前没有可靠的方法来判断command
中是否在操作一个asar
包中的文件,而且即便可以判断,我们依旧无法保证可以在无任何副作用的情况下替换command
中的文件路径。
如上所述,一些Node API会在调用时将文件解压到文件系统中,除了效率问题外,也有可能引起杀毒软件的注意!
为解决这个问题,你可以在生成asar
包时使用--unpack
选项来排除一些文件,使其不打包到asar
包中,下面是如何排除一些用作共享用途的native模块的方法:
经过上述命令后,除了生成的app.asar
包以外,还有一个包含了排除文件的app.asar.unpacked
文件夹,你需要将这个文件夹一起拷贝,提供给用户。