乐趣区

关于electron:Electron-应用打包

jiezi

为舒缓 Windows 下路径名过长的问题 issues，略微放慢 require 的速度以及简略隐匿源代码，咱们能够抉择把利用打包成 asar 档案文件，这只须要对源代码做一些很小的改变。大部分用户能够轻松实现这个性能，因为它在 electron-packager、electron-forge 和 electron-builder 中都失去了反对，开箱即用。

生成 asar 包

asar 是一种将多个文件合并成一个文件的类 tar 格调的归档格局。Electron 无需解压整个文件，就能够从其中读取任意文件内容。
能够按如下步骤来将利用打包成 asar：

  • 装置 asar：
$ npm install -g asar
  • 应用 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 包中的一个模块：

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 包文件。为此咱们能够应用内置的没有 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 咱们无奈保障其失常工作。

asar 包文件是只读的

asar 包中的内容不可更改，所以 Node APIs 里那些能够用来批改文件的办法在看待 asar 包时都无奈失常工作。

工作目录在 asar 包中有效

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

某些 API 须要额定解压的 asar 包

大部分 fs 能够无需解压即从 asar 包中读取文件或者文件的信息，然而在解决一些依赖实在文件门路的底层零碎办法时，Electron 会将所需文件解压到长期目录下，而后将长期目录下的实在文件门路传给底层零碎办法使其失常工作。对于这类 API，花销会略多一些。

以下是一些须要额定解压的 API：

  • child_process.execFile
  • child_process.execFileSync
  • fs.open
  • fs.openSync
  • process.dlopen

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 包

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

为解决这个问题，咱们能够在生成 asar 包时应用 --unpack 选项来排除一些文件，使其不打包到 asar 包中，上面是如何排除一些用作共享用处的 native 模块的办法：

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

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

退出移动版