如何用pkg工具实现nodejs应用的打包与跨平台运行?

2026-05-17 10:001阅读0评论SEO资源
  • 内容介绍
  • 文章标签
  • 相关推荐

本文共计1004个文字,预计阅读时间需要5分钟。

使用 `pkg` 可以将 Node.js 项目打包为可执行文件,即便在没有安装 Node.js 的设备上也能运行。实验环境:操作系统 Windows,Node.js 版本 16.14.2。操作步骤:下载 PKG,选择全局安装,在任意目录执行。

使用pkg可以将Node.js项目打包为可执行文件,甚至可以在未安装Node.js的设备上运行。

实验环境
  • 操作系统:windows
  • node版本: 16.14.2
操作过程 下载PKG

咱们可以选择全局安装,在任意目录执行:

$ npm install -g pkg 打包程序

先写一个简单的程序,比如server.js内容

const express = require('express'); const app = express(); app.get('/', (req, res) => { res.send('Hello World!'); }); app.listen(3000, () => { console.log('Express web app on localhost:3000'); });

进入nodejs项目根目录,执行如下命令

$ pkg server.js 第一次报错

这时候会报错

$ pkg server.js > pkg@5.6.0 > Targets not specified. Assuming: node16-linux-x64, node16-macos-x64, node16-win-x64 > Fetching base Node.js binaries to PKG_CACHE_PATH fetched-v16.14.2-linux-x64 [ ] 0%> Not found in remote cache: {"tag":"v3.3","name":"node-v16.14.2-linux-x64"} > Building base binary from source: built-v16.14.2-linux-x64 > Error! Not able to build for 'linux' here, only for 'win'

大意是,当前环境只支持编译为windows系统的可执行文件,也就是win

调整指令为:

$ pkg -t win server.js

其中-t win等同于--targets win,也就是说只为windows编译文件。

第二次报错

编译时候再次报错:

$ pkg -t win server.js > pkg@5.6.0 > Fetching base Node.js binaries to PKG_CACHE_PATH fetched-v16.14.2-win-x64 [ ] 0%> Not found in remote cache: {"tag":"v3.3","name":"node-v16.14.2-win-x64"} > Building base binary from source: built-v16.14.2-win-x64 > Fetching Node.js source archive from nodejs.org... > Error! AssertionError [ERR_ASSERTION]: The expression evaluated to a falsy value:

大意是缓存里缺少相应的二进制文件fetched-v16.14.2-win-x64,咱们只要下载到相应的文件,放到相应的缓存目录就好。

  • 去官网下载相应版本文件,比如我的是node-v16.14.2-win-x64

  • 将上一步下载的文件node-v16.14.2-win-x64重命名为fetched-v16.14.2-win-x64,放到当前用户的缓存目录中。

比如我的缓存目录是C:\Users\MangoDowner\.pkg-cache,拼接上fetch的tag就变成了最终的目录,参照报错中的信息,可以得到tagv3.3

{"tag":"v3.3","name":"node-v16.14.2-win-x64"}

当然,你的tag可能和我不一样,看你自己的报错信息把。

咱们可以得到最终的父目录为C:\Users\MangoDowner\.pkg-cache\v3.3
所以最终的文件地址为C:\Users\MangoDowner\.pkg-cache\v3.3\fetched-v16.14.2-win-x64

再次编译,成功!

$ pkg -t win server.js > pkg@5.6.0

将生成的exe拿到任意目录,甚至是未安装node的机器上,都可以正常运行

可能遇到其他问题 试图新建目录

会遇到报错如下,大意是不能在snapshot里面新建目录,要用目录挂载方式。

pkg/prelude/bootstrap.js:1593 new Error('Cannot mkdir in a snapshot. Try mountpoints instead.') ^ Error: Cannot mkdir in a snapshot. Try mountpoints instead. at mkdirFailInSnapshot (pkg/prelude/bootstrap.js:1593:7) at Object.mkdir (pkg/prelude/bootstrap.js:1616:5) ...

google了一圈,发现国际友人也遇到过类似问题,暂时还未解决...

可能找到答案的地方:官方文档

参考
  • Pkg 将 Node.js 项目打包为可执行文件
  • nodejs打包成桌面程序
  • 如何Node.js项目打包为一个可执行文件
  • pkg学习--使用pkg打包应用

本文共计1004个文字,预计阅读时间需要5分钟。

使用 `pkg` 可以将 Node.js 项目打包为可执行文件,即便在没有安装 Node.js 的设备上也能运行。实验环境:操作系统 Windows,Node.js 版本 16.14.2。操作步骤:下载 PKG,选择全局安装,在任意目录执行。

使用pkg可以将Node.js项目打包为可执行文件,甚至可以在未安装Node.js的设备上运行。

实验环境
  • 操作系统:windows
  • node版本: 16.14.2
操作过程 下载PKG

咱们可以选择全局安装,在任意目录执行:

$ npm install -g pkg 打包程序

先写一个简单的程序,比如server.js内容

const express = require('express'); const app = express(); app.get('/', (req, res) => { res.send('Hello World!'); }); app.listen(3000, () => { console.log('Express web app on localhost:3000'); });

进入nodejs项目根目录,执行如下命令

$ pkg server.js 第一次报错

这时候会报错

$ pkg server.js > pkg@5.6.0 > Targets not specified. Assuming: node16-linux-x64, node16-macos-x64, node16-win-x64 > Fetching base Node.js binaries to PKG_CACHE_PATH fetched-v16.14.2-linux-x64 [ ] 0%> Not found in remote cache: {"tag":"v3.3","name":"node-v16.14.2-linux-x64"} > Building base binary from source: built-v16.14.2-linux-x64 > Error! Not able to build for 'linux' here, only for 'win'

大意是,当前环境只支持编译为windows系统的可执行文件,也就是win

调整指令为:

$ pkg -t win server.js

其中-t win等同于--targets win,也就是说只为windows编译文件。

第二次报错

编译时候再次报错:

$ pkg -t win server.js > pkg@5.6.0 > Fetching base Node.js binaries to PKG_CACHE_PATH fetched-v16.14.2-win-x64 [ ] 0%> Not found in remote cache: {"tag":"v3.3","name":"node-v16.14.2-win-x64"} > Building base binary from source: built-v16.14.2-win-x64 > Fetching Node.js source archive from nodejs.org... > Error! AssertionError [ERR_ASSERTION]: The expression evaluated to a falsy value:

大意是缓存里缺少相应的二进制文件fetched-v16.14.2-win-x64,咱们只要下载到相应的文件,放到相应的缓存目录就好。

  • 去官网下载相应版本文件,比如我的是node-v16.14.2-win-x64

  • 将上一步下载的文件node-v16.14.2-win-x64重命名为fetched-v16.14.2-win-x64,放到当前用户的缓存目录中。

比如我的缓存目录是C:\Users\MangoDowner\.pkg-cache,拼接上fetch的tag就变成了最终的目录,参照报错中的信息,可以得到tagv3.3

{"tag":"v3.3","name":"node-v16.14.2-win-x64"}

当然,你的tag可能和我不一样,看你自己的报错信息把。

咱们可以得到最终的父目录为C:\Users\MangoDowner\.pkg-cache\v3.3
所以最终的文件地址为C:\Users\MangoDowner\.pkg-cache\v3.3\fetched-v16.14.2-win-x64

再次编译,成功!

$ pkg -t win server.js > pkg@5.6.0

将生成的exe拿到任意目录,甚至是未安装node的机器上,都可以正常运行

可能遇到其他问题 试图新建目录

会遇到报错如下,大意是不能在snapshot里面新建目录,要用目录挂载方式。

pkg/prelude/bootstrap.js:1593 new Error('Cannot mkdir in a snapshot. Try mountpoints instead.') ^ Error: Cannot mkdir in a snapshot. Try mountpoints instead. at mkdirFailInSnapshot (pkg/prelude/bootstrap.js:1593:7) at Object.mkdir (pkg/prelude/bootstrap.js:1616:5) ...

google了一圈,发现国际友人也遇到过类似问题,暂时还未解决...

可能找到答案的地方:官方文档

参考
  • Pkg 将 Node.js 项目打包为可执行文件
  • nodejs打包成桌面程序
  • 如何Node.js项目打包为一个可执行文件
  • pkg学习--使用pkg打包应用