CMake.js 使用教程

1. 项目介绍

CMake.js 是一个基于 CMake 的 Node.js 原生插件构建工具。它与 node-gyp 类似，但使用 CMake 作为构建系统，而不是 gyp。CMake.js 支持以下运行时：

• Node.js 14、15+（自 CMake.js v7.0.0 起）
• NW.js：所有基于 CMake.js 的原生模块都与 NW.js 兼容，无需额外的 nw-gyp 魔法。
• Electron：支持开箱即用的构建，无需后续构建步骤。

2. 项目快速启动

安装

首先，确保你已经安装了 CMake 和适当的 C/C++ 编译器工具链。然后，通过 npm 安装 CMake.js：

npm install cmake-js

创建 CMakeLists.txt

在你的模块根目录下创建一个 CMakeLists.txt 文件，内容如下：

cmake_minimum_required(VERSION 3.15)
cmake_policy(SET CMP0091 NEW)
cmake_policy(SET CMP0042 NEW)
project(your-addon-name-here)

add_definitions(-DNAPI_VERSION=4)
include_directories(${CMAKE_JS_INC})

file(GLOB SOURCE_FILES "your-source files-location-here")
add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES} ${CMAKE_JS_SRC})

set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
target_link_libraries(${PROJECT_NAME} ${CMAKE_JS_LIB})

if(MSVC AND CMAKE_JS_NODELIB_DEF AND CMAKE_JS_NODELIB_TARGET)
    execute_process(COMMAND ${CMAKE_AR} /def:${CMAKE_JS_NODELIB_DEF} /out:${CMAKE_JS_NODELIB_TARGET} ${CMAKE_STATIC_LINKER_FLAGS})
endif()

配置 package.json

在你的 package.json 文件中添加以下内容：

{
  "scripts": {
    "install": "cmake-js compile"
  },
  "binary": {
    "napi_versions": [7]
  }
}

构建项目

运行以下命令来构建你的项目：

npm install

3. 应用案例和最佳实践

应用案例

• @julusian/jpeg-turbo：这是一个使用 libjpeg-turbo 的 Node-API 包装器。CMake.js 在这里是一个很好的选择，因为 libjpeg-turbo 提供了可以使用的 CMake 文件，并且很难在 node-gyp 中正确复制。
• node-datachannel：这是一个易于使用的 WebRTC 数据通道和媒体传输库。

最佳实践

• 使用 Node-API：建议在新项目中使用 Node-API 而不是 NAN，因为它提供了 ABI 稳定性，简化了使用并减少了维护工作。
• 配置 CMakeLists.txt：确保你的 CMakeLists.txt 文件配置正确，特别是 add_definitions(-DNAPI_VERSION=4) 和 include_directories(${CMAKE_JS_INC})。

4. 典型生态项目

• aws-iot-device-sdk-v2：AWS IoT Device SDK for JavaScript v2。
• node-addon-api：Node.js 原生插件 API。

通过这些步骤，你可以快速上手并使用 CMake.js 构建你的 Node.js 原生插件。