文章出處

本文摘錄自《Nodejs學習筆記》,更多章節及更新,請訪問 github主頁地址。歡迎加群交流,群號 197339705

N-API簡介

Node.js 8.0 在2017年6月份發布,升級的特性中,包含了N-API。編寫過或者使用過 node擴展的同學,不少都遇到過升級node版本,node擴展編譯失敗的情況。因為node擴展嚴重依賴于V8暴露的API,而node不同版本依賴的V8版本可能不同,一旦升級node版本,原先運行正常的node擴展就編譯失敗了。

這種情況對node生態圈無疑是不利的,N-API的引入正是試圖改善這種情況的一種嘗試。它跟底層JS引擎無關,只要N-API暴露的API足夠穩定,那么node擴展的編寫者就不用過分擔憂node的升級問題。

如何使用N-API

先強調一點,N-API并不是對原有node擴展實現方式的替代,它只是提供了一系列底層無關的API,來幫助開發者編寫跨版本的node擴展。至于如何編寫、編譯、使用擴展,跟原來的差不多。

本文會從一個超級簡單的例子,簡單介紹N-API的使用,包括環境準備、編寫擴展、編譯、運行幾個步驟。

備注:當前N-API還處于試驗階段,官方文檔提供的例子都是有問題的,如用于生產環境需格外謹慎。

1、環境準備

首先,N-API是8.0版本引入的,首先確保本地安裝了8.0版本。筆者用的是nvm,讀者可自行選擇安裝方式。

nvm i 8.0
nvm use 8.0

然后,安裝node-gyp,編譯擴展會用到。

npm install -g node-gyp

創建項目目錄,并初始化package.json

mkdir hello & cd hello # 目錄名隨便起
npm init -f

2、編寫擴展

創建hello.cc作為擴展的源文件。

mkdir src
touch src/hello.cc

編輯hello.cc,輸入如下內容。

#include <node_api.h>

// 實際暴露的方法,這里只是簡單返回一個字符串
napi_value HelloMethod (napi_env env, napi_callback_info info) {
    napi_value world;
    napi_create_string_utf8(env, "world", 5, &world);
    return world;
}

// 擴展的初始化方法,其中 
// env:環境變量
// exports、module:node模塊中對外暴露的對象
void Init (napi_env env, napi_value exports, napi_value module, void* priv) {
    // napi_property_descriptor 為結構體,作用是描述擴展暴露的 屬性/方法 的描述
    napi_property_descriptor desc = { "hello", 0, HelloMethod, 0, 0, 0, napi_default, 0 };
    napi_define_properties(env, exports, 1, &desc);  // 定義暴露的方法
}

NAPI_MODULE(hello, Init);  // 注冊擴展,擴展名叫做hello,Init為擴展的初始化方法

3、編譯擴展

首先,創建編譯描述文件binding.gyp

{
  "targets": [
    {
      "target_name": "hello",
      "sources": [ "./src/hello.cc" ]
    }
  ]
}

然后,運行如下命令進行編譯。

node-gyp rebuild

4、調用擴展

未方便調用擴展,先安裝bindings

npm install --save bindings

然后,創建app.js,調用剛編譯的擴展。

var addon = require('bindings')('hello');

console.log( addon.hello() );  // world

運行代碼,由于N-API當前尚處于Experimental階段,記得加上--napi-modules標記。

node --napi-modules app.js

輸出如下

{"path":"/data/github/abi-stable-node-addon-examples/1_hello_world/napi/build/Release/hello.node"}
world
(node:6500) Warning: N-API is an experimental feature and could change at any time.

相關鏈接

N-API:https://nodejs.org/api/n-api.html

C++ Addons:https://nodejs.org/api/addons.html


文章列表


不含病毒。www.avast.com
arrow
arrow
    全站熱搜
    創作者介紹
    創作者 大師兄 的頭像
    大師兄

    IT工程師數位筆記本

    大師兄 發表在 痞客邦 留言(0) 人氣()