什么是 pkg？

pkg 是一個命令行工具，能將 Node.js 項目及其依賴打包成一個單獨的可執(zhí)行文件。用戶無需安裝 Node.js 環(huán)境即可運行你的程序。支持的操作系統(tǒng)包括：

• Windows (生成 .exe)

• macOS (生成二進制文件)

• Linux (生成二進制文件)

安裝 pkg

通過 npm 全局安裝或作為項目依賴安裝：

# 全局安裝（推薦）
npm install -g pkg

# 或作為項目開發(fā)依賴安裝
npm install pkg --save-dev

基本使用

步驟 1：準備你的 Node.js 項目

假設你有一個簡單的腳本 app.js：

// app.js
console.log("Hello from pkg!");

步驟 2：通過命令行打包

在終端運行以下命令：

pkg app.js --targets node18-win-x64,node18-macos-x64,node18-linux-x64 --output myapp

• --targets: 指定目標平臺和 Node.js 版本（例如 node18-win-x64 表示 Node.js 18 + Windows 64位）。

• --output: 輸出文件名（會根據(jù)平臺自動添加后綴，如 .exe）。

步驟 3：運行生成的可執(zhí)行文件

生成的 myapp.exe（Windows）或 myapp（macOS/Linux）可直接運行，無需 Node.js 環(huán)境。

配置 package.json

更推薦在 package.json 中配置 pkg 參數(shù)：

{
  "name": "myapp",
  "version": "1.0.0",
  "scripts": {
    "build": "pkg . --targets node18-win-x64,node18-macos-x64,node18-linux-x64 --output myapp"
  },
  "pkg": {
    "assets": ["public/**/*", "views/**/*"],  // 包含靜態(tài)資源
    "scripts": ["scripts/*.js"]  // 包含額外腳本
  }
}

運行 npm run build 即可打包。

處理資源文件

如果你的項目包含靜態(tài)文件（如圖片、HTML 模板），需注意：

• 相對路徑問題：使用 __dirname 或 path.resolve() 確保路徑正確。

• 在 pkg.assets 中聲明資源：

  {
    "pkg": {
      "assets": "public/**/*"
    }
  }

高級用法

指定 Node.js 版本和平臺

支持的平臺列表：

pkg -h  # 查看所有支持的 target 組合

打包整個項目

直接打包 package.json 的入口文件：

pkg .

處理環(huán)境變量

在代碼中通過 process.env.PKG 判斷是否在打包環(huán)境中運行：

if (process.env.PKG) {
  console.log("Running in packaged mode!");
}

常見問題

問題 1：動態(tài)導入模塊失敗

• 原因：pkg 無法處理動態(tài) require()（如 require(path.join(__dirname, file))）。

• 解決：在 pkg.scripts 中預聲明所有可能動態(tài)加載的文件。

問題 2：文件路徑錯誤

• 原因：打包后文件系統(tǒng)路徑變化。

• 解決：使用 path.dirname(process.execPath) 獲取可執(zhí)行文件所在目錄。

問題 3：缺少依賴

• 原因：未在 dependencies 中聲明依賴。

• 解決：確保所有依賴在 package.json 的 dependencies 中。

示例：打包 Express 應用

• 項目結(jié)構(gòu)：

  my-express-app/
  ├── app.js
  ├── public/
  │   └── index.html
  └── package.json

• app.js 代碼：

  const express = require('express');
  const path = require('path');
  const app = express();
  
  app.use(express.static(path.join(__dirname, 'public')));
  
  app.listen(3000, () => {
    console.log('Server running on port 3000');
  });

• package.json 配置：

  json

  {
    "pkg": {
      "assets": "public/**/*"
    }
  }

• 打包命令：

  pkg app.js --targets node18-win-x64 --output my-express-app

總結(jié)

• 使用 pkg 可輕松將 Node.js 項目轉(zhuǎn)換為可執(zhí)行文件。

• 注意處理靜態(tài)資源路徑和動態(tài)模塊加載。

• 通過 package.json 配置更便捷。

到此這篇關(guān)于將Javascript打包成exe可執(zhí)行文件的文章就介紹到這了,更多相關(guān)js打包成exe可執(zhí)行文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論