应用包装 | Application Packaging

Application Packaging

为了缓解Windows上长路径名称的问题，稍微加快速度require并隐藏您的源代码以免粗略检查，您可以选择将应用程序打包到asar存档中，而对源代码进行很少的更改。

生成asar档案

一个ASAR归档是一个简单的焦油状的格式，串接文件合并为一个文件。电子可以从它读取任意文件，而无需解包整个文件。

将应用程序打包到asar存档中的步骤：

1.安装asar Utility

$ npm install -g asar

2.包装 asar pack

$ asar pack your-app app.asar

使用asar档案

在Electron中，有两套API：由Node.js提供的节点API和由Chromium提供的Web API。这两个API都支持从asar档案中读取文件。

节点API

随着Electron专用补丁，节点API就像fs.readFile和require对待asar档案的虚拟目录，并作为文件系统中的正常文件中的文件。

例如，假设我们有一个example.asar档案在/path/to：

$ 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')

您还可以在asar存档中显示网页BrowserWindow：

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

WebAPI

在网页中，档案中的文件可以通过file:协议请求。像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存档的内容作为文件读取。为此，您可以使用original-fs提供原始fsAPI而无需asar支持的内置模块：

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

您还可以设置process.noAsar到true禁用的支持asar中fs模块：

const fs = require('fs')
process.noAsar = true
fs.readFileSync('/path/to/example.asar')

Node API的局限性

尽管我们尽可能努力使asarNode API中的存档尽可能地像目录一样工作，但由于Node API的低级特性，仍然存在限制。

档案是只读的

无法修改档案，因此所有可修改文件的节点API都不适用于asar档案。

虽然asar档案被视为目录，但是文件系统中没有实际的目录，所以你不能将工作目录设置为asar档案中的目录。将它们作为cwd某些API 的选项传递也会导致错误。

对某些API进行额外解压缩

大多数fsAPI可以读取文件或从asar档案中获取文件信息而无需解包，但对于某些依赖将实际文件路径传递到底层系统调用的API，Electron会将所需文件提取到临时文件中并传递临时路径文件到API以使其工作。这为这些API增加了一点开销。

需要额外解包的API是：

child_process.execFile

child_process.execFileSync

fs.open

fs.openSync

process.dlopen-被require关于本机模块

虚假的统计信息 fs.stat

通过猜测生成归档文件中由其及其朋友Stats返回的对象，因为这些文件不存在于文件系统中。所以除了获取文件大小和检查文件类型之外，您不应该相信该对象。fs.statasarStats

在asar存档中执行二进制文件

有一些Node API可以执行二进制文件child_process.exec，child_process.spawn并且child_process.execFile只能execFile在asar归档文件内执行二进制文件。

这是因为，exec和spawn接受command的，而不是file作为输入，和commands的下壳执行。没有可靠的方法来确定命令是否在asar归档中使用文件，即使我们这样做，我们也无法确定是否可以替换命令中的路径而没有副作用。

在asar存档中添加解压缩的文件

如上所述，一些节点API在调用时会将文件解压缩到文件系统，除了性能问题之外，它还可能导致病毒扫描器的错误警报。

要解决此问题，可以使用该--unpack选项解压创建存档的某些文件，排除本机模块的共享库的示例为：

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

运行该命令后，除了该命令之外app.asar，还会app.asar.unpacked生成一个包含解压缩文件的文件夹，您应该在将其app.asar发送给用户时将其复制到一起。