应用打包

为舒缓 Windows 下路径名过长的问题issues， 也略对require加速以及简单隐匿你的源代码，你可以通过极小的源代码改动将你的应用打包成asar。

生成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')

列出asar包中根目录下的所有文件：

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

使用asar包中的一个模块：

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

你也可以使用BrowserWindow来显示一个asar包里的 web 页面：

const BrowserWindow = require('electron').BrowserWindow
var win = new BrowserWindow({width: 800, height: 600})
win.loadURL('file:///path/to/example.asar/static/index.html')

Web API

在 Web 页面里，用file:协议可以获取asar包中文件。和 Node API 一样，视asar包如虚拟文件夹。

例如，用$.get获取文件:

<script>
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一样的 API）模块来读取asar包的真实信息。

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

Node API 缺陷

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

asar包是只读的

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

Working Directory 在asar包中无效

尽管asar包是虚拟文件夹，但其实并没有真实的目录架构对应在文件系统里，所以你不可能将 working Directory 设置成asar包里的一个文件夹。将asar中的文件夹以cwd形式作为参数传入一些 API 中也会报错。

API 中的额外“开箱”

大部分fsAPI 可以无需解压即从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.exec，child_process.spawn和child_process.execFile等， 但只有execFile可以执行asar包中的程序。

因为exec和spawn允许command替代file作为输入，而command是需要在 shell 下执行的，目前没有 可靠的方法来判断command中是否在操作一个asar包中的文件，而且即便可以判断，我们依旧无法保证可以在无任何 副作用的情况下替换command中的文件路径。

打包时排除文件

如上所述，一些 Node API 会在调用时将文件解压到文件系统中，除了效率问题外，也有可能引起杀毒软件的注意！

为解决这个问题，你可以在生成asar包时使用--unpack选项来排除一些文件，使其不打包到asar包中， 下面是如何排除一些用作共享用途的 native 模块的方法：

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

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

results matching ""

    No results matching ""