Node.js 新特性 SEA/单文件可执行应用尝鲜

#1 关于 SEA

单文件可执行应用（SEA，Singe Executable Applications），是 Node.js 新版本的特性，最初在 v19.7.0、v18.16.0 加入，并在 v20.x 得到扩展。而上个月发布的全家桶 Bun.js，就自带了 SEA 功能🙃。

此前，若需要把 JS 文件打包，通常会选择下面几种工具：

#2 实战 SEA

#2.1 尝鲜官方 SEA

开始前请先升级到 node v20+，否则后续的命令会报错：bad option --experimental-sea-config

首先我们写一个简单的脚本，实现在控制台用边框包裹参数文本的功能。

/**
 * @type {String}
 */
let name = process.argv[2]
if(!name || name.trim().length == 0){
    console.error("ERROR: 请输入名字")
    process.exit(-1)
}

console.log(`Hello, ${name}`)
1
2
3
4
5
6
7
8
9
10

接下来编辑 sea-config.json 文件，内容是

{
    "main": "index.js",
    "output": "index.blob"
}
1
2
3
4

执行命令node --experimental-sea-config sea-config.json后生成index.blob文件（可以用文本编辑器查看，其实就是之前的代码前加了一小段内容🙂）

接着执行:

# 将 node 环境包装成 exe 可执行文件（大小约为 68M）
node -e "require('fs').copyFileSync(process.execPath, 'hello.exe')" 
# 此时运行 ./hello.exe 与执行 node 命令效果一致😂

# 接下来就是把 blob 文件转载到 hello.exe 内
npx postject hello.exe NODE_SEA_BLOB index.blob --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 --overwrite
# 首次执行时，会提示安装 postject 包；增加 --overwrite 强制覆盖
1
2
3
4
5
6
7

运行效果

#2.2 PKG方案

# 请先安装 pkg：npm install -g pkg

# 执行打包
pkg -t node16-win-x64 index.js -o hello-pkg.exe
# 大概 2 秒即可完成，生成 34M 大小的可执行文件
# 注意：按照官方文档，目前 pkg 最新支持到 node19 的打包，详见 https://github.com/vercel/pkg-fetch/blob/main/patches/patches.json
1
2
3
4
5
6

#2.3 存在的问题

SEA 本质就是把 node 环境与我们自己的 JS 文件一同打包，所以得到的产物体积都偏大。实际情况下，个人首选 pkg。

另外，官方及 pkg 都只支持单文件打包，若存在第三方库、文件的依赖，在运行时就会报 module 找不到的异常。

此时，可以使用诸如 webpack、vite 等构建工具把项目编译成单文件，再进行 SEA 包装😄。