一處打包,到處運行,用pkg打包nodejs應用!


使用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了一圈,發現國際友人也遇到過類似問題,暫時還未解決...

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

參考


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM