从C++ Addon看Napi的实现

开发 后端
Node.js的napi极大地方便了c++ addon的编写,使得用户不再那么需要面对复杂的v8。本文通过一个例子来分析一下napi的使用和napi到底做了什么。

 [[397577]]

本文转载自微信公众号「编程杂技」,作者theanarkh。转载本文请联系编程杂技公众号。

Node.js的napi极大地方便了c++ addon的编写,使得用户不再那么需要面对复杂的v8。本文通过一个例子来分析一下napi的使用和napi到底做了什么。

1 导出给js使用的功能

  1. #include <node_api.h> 
  2. NAPI_MODULE(NODE_GYP_MODULE_NAME, Init) 

上面的代码是使用napi时的通用模式,我们只需要实现Init函数就行(当然也可以叫其他名字)。接下来我们看看Init的实现。

  1. napi_value Init(napi_env env, napi_value exports) { 
  2.   napi_value func; 
  3.   // 创建一个函数并且设置为exports对象的getArray属性的值 
  4.   napi_create_function(env, 
  5.                       NULL
  6.                       NAPI_AUTO_LENGTH, 
  7.                       newArray, 
  8.                       NULL
  9.                       &func); 
  10.   napi_set_named_property(env, exports, "getArray", func); 
  11.   return exports; 

napi_create_function也是napi提供的api,他的作用是创建一个函数,具体可以参考napi的文档。接着把这个函数导出给js使用,名字是getArray。当js执行getArray的时候就会执行newArray函数。

2 newArray的实现

  1. static napi_value newArray(napi_env env, napi_callback_info info) { 
  2.    size_t argc = 1; 
  3.    napi_value args[1]; 
  4.    // 拿到js层的入参,这里是一个 
  5.    napi_get_cb_info(env, info, &argc, args, NULLNULL); 
  6.    int len; 
  7.    // js传入的是一个数字,v8转成了对象,这里再次把入参转成int型 
  8.    napi_get_value_int32(env, args[0], &len); 
  9.    napi_value ret; 
  10.    // 创建一个数组 
  11.    napi_create_array(env, &ret); 
  12.    // 根据js入参设置数组的初始值 
  13.    for (int i = 0; i < len; i++) { 
  14.      napi_value num; 
  15.      napi_create_int32(env, i, &num); 
  16.      napi_set_element(env, ret, i, num); 
  17.    } 
  18.  
  19.   return ret; 

3 使用c++ addon

  1. const { getArray } = require('./build/Release/test.node'); 
  2. console.log(getArray(20)); 

执行上面代码最后输出

  1.    0,  1,  2,  3,  4,  5,  6, 
  2.    7,  8,  9, 10, 11, 12, 13, 
  3.   14, 15, 16, 17, 18, 19 

4 分析

上面的代码并不复杂,本文主要是分析napi提供的api,看看napi到底做了什么。很多api的原理是类似的,这里只以数组的api为例子。因为v8的api中,使用的参数基本都是v8提供的对象。napi做的事情其实就是帮我们处理这些对象的转换。我们首先看看napi_create_array的实现。

  1. // 创建一个数组,对应js的数组 
  2. napi_status napi_create_array(napi_env env, napi_value* result) { 
  3.   // 调用v8接口v8::Array::New创建一个数组对象,然后转成napi的类型,并设置返回值 
  4.   *result = v8impl::JsValueFromV8LocalValue(v8::Array::New(env->isolate)); 
  5.   return napi_clear_last_error(env); 

我们看到napi_create_array的实现非常简单,就是对v8接口的封装,然后转换成napi的类型,最后清除错误信息。这是napi典型的api使用方式。主要包括下面几个

1 入参需要传入env对象,并传入一个二级指针napi_value *,用于保存接口返回值。napi的返回值不是通过函数体的return返回的,return返回的是api的执行状态(成功或失败)。

2 处理v8的api

3 清除或返回错误信息 每次执行napi提供的api时,如果执行出错则通过napi_set_last_error设置到env中并返回错误码,如果没有则通过napi_clear_last_error清除错误信息并返回napi_ok。我们看一下实现

  1. // 设置当前函数调用的错误信息 
  2. static inline napi_status napi_set_last_error(napi_env env, napi_status error_code, 
  3.                                 uint32_t engine_error_code = 0, 
  4.                                 void* engine_reserved = nullptr) { 
  5.   env->last_error.error_code = error_code; 
  6.   env->last_error.engine_error_code = engine_error_code; 
  7.   env->last_error.engine_reserved = engine_reserved; 
  8.   return error_code; 
  9.  
  10. // 清除上次调用的错误信息 
  11. static inline napi_status napi_clear_last_error(napi_env env) { 
  12.   env->last_error.error_code = napi_ok; 
  13.  
  14.   // TODO(boingoing): Should this be a callback? 
  15.   env->last_error.engine_error_code = 0; 
  16.   env->last_error.engine_reserved = nullptr; 
  17.   return napi_ok; 

调用方在调用完api后,如果产生了错误,则可以通过napi_get_last_error_info接口获取执行api的错误信息。

  1. // 获取上一个调用函数的错误信息 
  2. napi_status napi_get_last_error_info(napi_env env, 
  3.                                      const napi_extended_error_info** result) { 
  4.   // 初始化为非法值 
  5.   const int last_status = napi_detachable_arraybuffer_expected; 
  6.   // 根据错误码设置错误描述信息(每次调用api后调用结果存到env中) 
  7.   env->last_error.error_message = 
  8.       error_messages[env->last_error.error_code]; 
  9.  
  10.   *result = &(env->last_error); 
  11.   return napi_ok; 

言归正传,调用napi_create_array后,我们拿到一个返回值,比如下面的ret。

  1. napi_value ret; 
  2. napi_create_array(env, &ret); 

之前分析过napi_value本质上是一个一级指针。接着我们看如何使用从napi中拿到的数组。我们可以通过napi_set_element设置数组的内容。

  1. // ret是数组,i是索引,num是一个napi_value变量,本质是一个v8对象,即索引对应的值 
  2. napi_set_element(env, ret, i, num); 

下面我们看看napi_set_element的实现。

  1. // 设置key对应的值,key是数字 
  2. napi_status napi_set_element(napi_env env, 
  3.                              napi_value object, 
  4.                              uint32_t index
  5.                              napi_value value) { 
  6.   v8::Local<v8::Context> context = env->context(); 
  7.   v8::Local<v8::Object> obj; 
  8.   // 把napi_value object转成v8的Object,数组继承Object 
  9.   CHECK_TO_OBJECT(env, context, obj, object); 
  10.   // 把值napi_value value转成v8对象 
  11.   v8::Local<v8::Value> val = v8impl::V8LocalValueFromJsValue(value); 
  12.   // 调用v8 Object对象的Set方法设置对象的属性,即数组的元素 
  13.   auto set_maybe = obj->Set(context, index, val); 
  14.   // 执行结果处理 
  15.   RETURN_STATUS_IF_FALSE(env, set_maybe.FromMaybe(false), napi_generic_failure); 
  16.  
  17.   return GET_RETURN_STATUS(env); 

从上面的分析中,我们大致可以看到napi实现中的一些规律,get的api的逻辑是调用v8接口拿到v8类型的对象,然后转成napi_value类型返回给调用方,set的api是传入napi_value类型,然后转成v8类型的对象。

napi的实现几乎都在js_native_api_v8.cc中,有兴趣的同学可以看一下,大多数api的实现并不复杂,了解js_native_api_v8.cc的实现,不仅让我们更好地使用napi,也让我们更加了解v8的使用和原理。

 

责任编辑:武晓燕 来源: 编程杂技
相关推荐

2009-08-27 16:03:31

从c#到c++

2021-06-26 07:04:24

Epoll服务器机制

2022-07-19 20:04:31

NAPI模块鸿蒙

2017-04-05 20:00:32

ChromeObjectJS代码

2009-09-04 17:34:11

C#CC++

2021-12-06 23:00:36

CC++编程语言

2015-06-25 11:21:33

C++Objective-C

2010-01-28 16:58:32

学习C++感想

2011-07-13 17:42:32

CC++

2011-07-13 16:48:55

CC++

2011-07-13 17:08:02

CC++

2021-07-16 04:56:03

NodejsAddon

2023-10-30 10:29:50

C++最小二乘法

2021-07-07 23:38:05

内核IOLinux

2014-04-22 09:51:24

LongAdderAtomicLong

2009-09-15 18:27:59

equals实现canEqualScala

2010-01-13 18:44:03

C++编译

2021-06-18 06:02:24

内核文件传递

2020-08-26 14:00:37

C++string语言

2022-10-20 16:18:37

JS类型C/C++数据类型
点赞
收藏

51CTO技术栈公众号