Node.js NativeAddon 构建工具：node-gyp 安装与配置完全指南

洪淼赞Tuesday

于 2024-09-13 22:00:54 发布

阅读量279

点赞数 3

本文链接：https://blog.csdn.net/gitblog_09356/article/details/142226827

版权

Node.js NativeAddon 构建工具：node-gyp 安装与配置完全指南

node-gyp Node.js native addon build tool 项目地址: 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\to\python.exe

Windows PowerShell:

$Env:npm_config_python="C:\path\to\python.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的原生模块项目，基本流程如下：

进入模块目录：
```
cd your-native-module
```
配置项目（通常不需要额外参数，除非特别指定Python版本或其他编译选项）：
```
node-gyp configure
```
对于特定编译环境（如Visual C++ Build Tools 2015），可能需要指定--msvs_version=2015。
编译模块：
```
node-gyp build
```

若要创建调试版本，添加--debug或-d标志。

至此，你就成功完成了node-gyp的安装与配置，可以在Node.js应用中通过require()调用编译后的原生模块了。

此指南提供了清晰的步骤以帮助新手快速入门node-gyp，但具体细节可能随Node.js版本或系统更新而变化，请参考官方文档获取最新信息。

node-gyp Node.js native addon build tool 项目地址: https://gitcode.com/gh_mirrors/no/node-gyp