Node.js NativeAddon 構建工具：node-gyp 安裝與配置完全指南

node-gyp Node.js native addon build tool [這里是圖片001] 項目地址: https://gitcode.com/gh_mirrors/no/node-gyp

項目基礎介紹及主要編程語言

Node.js NativeAddon 構建工具（node-gyp） 是一個基于 Node.js 的跨平臺命令行工具，專用于編譯 Node.js 的原生插件模塊。它內部封裝了源自Chromium團隊使用的 gyp-next 項目，并針對 Node.js 模塊開發進行了擴展。值得注意的是，node-gyp 不用來構建 Node.js 自身，而是專注于讓開發者能夠輕松地在不同的操作系統上編譯原生模塊。這個工具支持多種版本的 Node.js，并自動匹配對應版本的開發文件。

主要編程語言: JavaScript 和 C/C++

關鍵技術和框架

• GYP (Generate Your Projects)：由Google開發，用于生成構建文件，如Makefiles或Visual Studio解決方案。
• Node.js API：利用Node.js的進程環境來配置構建過程。
• Python (>= v3.12 for node-gyp >= v10)：作為輔助工具，在編譯過程中用于執行部分腳本。
• Make (Unix/Linux) 和 Visual Studio 工具鏈 (Windows)：實際執行編譯任務的系統工具。

安裝與配置詳細步驟

準備工作

系統需求

確保你的系統中已安裝以下組件：

• Node.js: 最新或目標版本的Node.js。
• Python: 對于node-gyp >= v10，推薦安裝Python 3.12及以上版本。
• 開發工具包：
  • Unix/Linux: Python, make工具，以及GCC/G++編譯器。
  • macOS: Python, Xcode Command Line Tools（包含clang等）。
  • Windows: Python, Visual Studio Build Tools含C++工具集或Visual Studio 2019/2022（帶有桌面開發C++的工作負載）。

全球安裝node-gyp

通過npm全局安裝node-gyp，確保你的Node.js已正確設置PATH環境變量。

npm install -g node-gyp

配置Python路徑

如果你有多個Python版本，需指定node-gyp應使用的版本：

• Linux/macOS:

  export npm_config_python=“/path/to/python”

• Windows CMD:

  set npm_config_python=C:path opython.exe

• Windows PowerShell:

  $Env:npm_config_python=“C:path opython.exe”

或者，直接在命令行調用時指定--python參數。

在特定平臺上完成配置

Unix/Linux

確保Python和make工具已就位，還需安裝gcc/g++。

macOS

安裝Xcode Command Line Tools或單獨安裝如果已經擁有Xcode。

xcode-select --install

Windows

使用Chocolatey或手動下載安裝Python和Visual Studio Build Tools（選擇Desktop development with C++ workload）。

• Chocolatey方式:

  choco install python visualstudio2022-workload-vctools -y

手動配置可能涉及更多的環境變量設置和組件選擇。

使用node-gyp編譯模塊

假設你已經有了一個包含binding.gyp的原生模塊項目，基本流程如下：

1. 進入模塊目錄：

   cd your-native-module
   

2. 配置項目（通常不需要額外參數，除非特別指定Python版本或其他編譯選項）：

   node-gyp configure
   

   對于特定編譯環境（如Visual C++ Build Tools 2015），可能需要指定--msvs_version=2015。

3. 編譯模塊：

   node-gyp build
   

若要創建調試版本，添加--debug或-d標志。

至此，你就成功完成了node-gyp的安裝與配置，可以在Node.js應用中通過require()調用編譯后的原生模塊了。

---

此指南提供了清晰的步驟以幫助新手快速入門node-gyp，但具體細節可能隨Node.js版本或系統更新而變化，請參考官方文檔獲取最新信息。

node-gyp Node.js native addon build tool [這里是圖片002] 項目地址: https://gitcode.com/gh_mirrors/no/node-gyp