将node服务打包成可执行文件-PKG

news2024/12/24 20:59:15

背景

有时我们需要写一些node的服务或者是工具，但这些工具&服务可以运行的前提条件是当前环境需要安装好node，有时候我们把这些工具&服务发送给别人，在别人的电脑中未必有安装好的node版本，即便有也可能不是期望的指定的Node版本，在这样的场景下我们可以把写好的node 服务 & 工具打包成一个可执行文件发送给对方，将程序需要依赖的所有的东西，比如node环境，再比如跑RPA需要的浏览器环境也可以打包到我们自己的可执行文件中。

PKG

我们可以借助pkg这个工具将我们的应用打包成一个可执行文件在mac、linux 、windows中执行。

安装

可以全局安装可以以在当前项目中安装

npm install -g pkg

使用

一般两种方式，简单一点的我们可以通过命令行的参数来打包，更加推荐一种方式是把相应的参数写在package.json文件中，其中bin字段就是打包的入口，pkg字段就是打包时的一些配置参数。比如看下面的配置

"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"
  },

在命令行中执行npm run pkg就会将当前的ts工程的node服务应用先打包到dist目录下，然后再以dist/index.js为入口文件打包这个node服务为一个可执行的文件。打包出的可执行文件是可以在mac中运行的，其出口是在outputPath目录下。
效果如下所示:
在这里插入图片描述

将chromium也打包进二进制执行文件

在我们的业务代码中提供一个接口可以在本地使用chromium运行RPA，这就需要我们在打包时也需要将chromium也一起打包进我们的可执行文件，这样才能在运行RPA时可以找到对应的环境。比如下面这个例子，我们使用pupputeer来做RPA，当程序执行时，用户可以通过调用http://localhost:3012/rpa来运行本地的RPA操作。这里就以打开百度网站输入天气并搜索为例子说明。
如果我们按照上面的配置直接进行打包的话，在电脑中运行这个文件时会抛出以下的错误：
在这里插入图片描述
大意是需要将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"
  },

然后再执行打包命令，运行效果如下所示：
在这里插入图片描述