快捷導(dǎo)航

如何將node服務(wù)打包成可執(zhí)行文件PKG

更新時間：2023年10月31日 08:51:32 作者：問白

這篇文章主要介紹了如何將node服務(wù)打包成可執(zhí)行文件PKG問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

背景

有時我們需要寫一些node的服務(wù)或者是工具，但這些工具&服務(wù)可以運(yùn)行的前提條件是當(dāng)前環(huán)境需要安裝好node，有時候我們把這些工具&服務(wù)發(fā)送給別人，在別人的電腦中未必有安裝好的node版本，即便有也可能不是期望的指定的Node版本，在這樣的場景下我們可以把寫好的node 服務(wù) & 工具打包成一個可執(zhí)行文件發(fā)送給對方，將程序需要依賴的所有的東西，比如node環(huán)境，再比如跑RPA需要的瀏覽器環(huán)境也可以打包到我們自己的可執(zhí)行文件中。

PKG

我們可以借助pkg這個工具將我們的應(yīng)用打包成一個可執(zhí)行文件在mac、linux 、windows中執(zhí)行。

安裝

可以全局安裝可以以在當(dāng)前項(xiàng)目中安裝

npm install -g pkg

使用

一般兩種方式，簡單一點(diǎn)的我們可以通過命令行的參數(shù)來打包，更加推薦一種方式是把相應(yīng)的參數(shù)寫在package.json文件中，其中bin字段就是打包的入口，pkg字段就是打包時的一些配置參數(shù)。

比如看下面的配置

"scripts": {
    "build": "rm -rf dist && tsc && tsc-alias && cp package.json ./dist",
    "pkg": "npm run build && rm -rf package && pkg ."
  },
  "bin": "dist/index.js",
  "pkg": {
    "targets": [
      "node16-macos-arm64"
    ],
    "outputPath": "package"
  },

在命令行中執(zhí)行npm run pkg就會將當(dāng)前的ts工程的node服務(wù)應(yīng)用先打包到dist目錄下，然后再以dist/index.js為入口文件打包這個node服務(wù)為一個可執(zhí)行的文件。

打包出的可執(zhí)行文件是可以在mac中運(yùn)行的，其出口是在outputPath目錄下。

效果如下所示：

將chromium也打包進(jìn)二進(jìn)制執(zhí)行文件

在我們的業(yè)務(wù)代碼中提供一個接口可以在本地使用chromium運(yùn)行RPA，這就需要我們在打包時也需要將chromium也一起打包進(jìn)我們的可執(zhí)行文件，這樣才能在運(yùn)行RPA時可以找到對應(yīng)的環(huán)境。

比如下面這個例子，我們使用pupputeer來做RPA，當(dāng)程序執(zhí)行時，用戶可以通過調(diào)用http://localhost:3012/rpa來運(yùn)行本地的RPA操作。

這里就以打開百度網(wǎng)站輸入天氣并搜索為例子說明。

如果我們按照上面的配置直接進(jìn)行打包的話，在電腦中運(yùn)行這個文件時會拋出以下的錯誤：

大意是需要將node_modules/vm2/lib/setup-sandbox.js顯示的指定需要加入到打包文件中。

完整的配置如下：

"bin": "dist/index.js",
  "pkg": {
    "scripts": [
      "./node_modules/vm2/lib/setup-sandbox.js"
    ],
    "targets": [
      "node16-macos-arm64"
    ],
    "outputPath": "package"
  },

然后再執(zhí)行打包命令，運(yùn)行效果如下所示：