Node.js v20.2.0 文档

单个可执行应用程序#

源代码: lib/internal/main/single_executable_application.js

此功能允许将 Node.js 应用程序方便地分发到未安装 Node.js 的系统。

Node.js 通过允许将由 Node.js 准备的 blob 注入 node 二进制文件来支持 单个可执行应用程序 的创建，其中可以包含捆绑脚本。 在启动过程中，程序会检查是否注入了任何东西。 如果找到 blob，它会执行 blob 中的脚本。 否则 Node.js 会像往常一样运行。

单个可执行应用程序功能目前仅支持使用 CommonJS 模块系统运行单个嵌入式脚本。

用户可以使用 node 二进制文件本身和任何可以将资源注入二进制文件的工具从他们的捆绑脚本创建单个可执行应用程序。

以下是使用此类工具 postject 创建单个可执行应用程序的步骤：

1. 创建一个 JavaScript 文件：

   $ echo 'console.log(`Hello, ${process.argv[2]}!`);' > hello.js 拷贝

2. 创建一个配置文件，构建一个可以注入单个可执行应用程序的 blob（有关详细信息，请参阅 生成单个可执行准备 blob）：

   $ echo '{ "main": "hello.js", "output": "sea-prep.blob" }' > sea-config.json 拷贝

3. 生成要注入的 blob：

   $ node --experimental-sea-config sea-config.json 拷贝

4. 创建 node 可执行文件的副本并根据需要命名：

   • 在 Windows 以外的系统上：

   $ cp $(command -v node) hello 拷贝

   • 在 Windows 上：

   使用 PowerShell：

   $ cp (Get-Command node).Source hello.exe 拷贝

   使用命令提示符：

   $ for /F "tokens=*" %n IN ('where.exe node') DO @(copy "%n" hello.exe) 拷贝

   .exe 扩展名是必需的。

5. 删除二进制文件的签名（仅限 macOS 和 Windows）：

   • 在 macOS 上：

   $ codesign --remove-signature hello 拷贝

   • 在 Windows 上（可选）：

   signtool 可以从已安装的 Windows SDK 使用。 如果跳过此步骤，请忽略来自 postject 的任何与签名相关的警告。

   $ signtool remove /s hello.exe 拷贝

6. 通过使用以下选项运行 postject 将 blob 注入到复制的二进制文件中：

   • hello / hello.exe - 在步骤 4 中创建的 node 可执行文件副本的名称。
   • NODE_SEA_BLOB - 二进制文件中将存储 blob 内容的资源/注释/部分的名称。
   • sea-prep.blob - 在步骤 1 中创建的 blob 的名称。
   • --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 - Node.js 项目用来检测文件是否被注入的 fuse。
   • --macho-segment-name NODE_SEA（仅在 macOS 上需要）- 二进制文件中将存储 blob 内容的段的名称。

   总而言之，这是每个平台所需的命令：

   • 在 Linux 上：

     $ npx postject hello NODE_SEA_BLOB sea-prep.blob \
         --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 拷贝

   • 在 Windows 上：

     $ npx postject hello.exe NODE_SEA_BLOB sea-prep.blob \
         --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 拷贝

   • 在 macOS 上：

     $ npx postject hello NODE_SEA_BLOB sea-prep.blob \
         --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 \
         --macho-segment-name NODE_SEA 拷贝

7. 签署二进制文件（仅限 macOS 和 Windows）：

   • 在 macOS 上：

   $ codesign --sign - hello 拷贝

   • 在 Windows 上（可选）：

   需要有证书才能工作。 但是，未签名的二进制文件仍然可以运行。

   $ signtool sign /fd SHA256 hello.exe 拷贝

8. 运行二进制文件：

   • 在 Windows 以外的系统上

   $ ./hello world
   Hello, world! 拷贝

   • 在 Windows 上

   $ .\hello.exe world
   Hello, world! 拷贝

{
  "main": "/path/to/bundled/script.js",
  "output": "/path/to/write/the/generated/blob.blob",
  "disableExperimentalSEAWarning": true // Default: false
} 拷贝

const { createRequire } = require('node:module');
require = createRequire(__filename); 拷贝