🌐 Getting Started with Node-API
本节将带你了解开始使用 Node-API 构建原生 Node.js 插件所需的一切。它专为对原生插件开发不熟悉且希望从零到完成一个工作模块的开发者设计。
🌐 This section walks you through everything you need to begin building native Node.js addons with Node-API. It is designed for developers who are new to native addon development and want a guided path from zero to a working module.
🌐 What you will learn
- 前提条件 - 你在深入学习之前需要的 C/C++ 和 JavaScript 知识
- 你需要的工具 - 如何在 Windows、macOS 和 Linux 上安装 Node、npm、Git 以及 C/C++ 工具链
- Node-API 项目的结构 - 常见目录布局，
package.json条目，binding.gyp，以及每个node-addon-api项目共享的 JavaScript 封装层 - 你的第一个项目 - 构建并运行你的第一个 Node-API 模块
- ObjectWrap - 使用
node-addon-api的ObjectWrap类将 C++ 对象暴露为 JavaScript 对象 - 从 NAN 迁移 - 将现有的基于 NAN 的插件转换为 Node-API
🌐 Which API level should I use?
Node-API 在两个层面上运行：
🌐 Node-API operates at two levels:
- C API - 直接内置于 Node.js 中，并在 Node.js API 页面 上有文档说明。为你提供最大控制权且无需额外依赖。
- C++ 封装器（
node-addon-api） - 一个 npm 包，将 C API 封装到更友好的 C++ 对象模型中。推荐用于大多数项目，因为它显著减少了样板代码，同时保持完全的 ABI 稳定性。
本节中的例子使用 node-addon-api。
🌐 The examples in this section use node-addon-api.