三方库移植之NAPI开发—Hello OpenHarmony NAPI

{
  "subsystem": "mysubsys",
  "parts": {
    "hello": {
      "module_list": [
        "//mysubsys/hello/hellonapi:hellonapi"
      ],
      "inner_kits": [
      ],
      "system_kits": [
      ],
      "test_list": [
      ]
    }
  }
}

"subsystem": "mysubsys",

"parts": {
    "hello": {
   }
  }

"module_list": [
        "//mysubsys/hello/hellonapi:hellonapi"

"mysubsys": {
    "project": "hmf/mysubsys",
    "path": "mysubsys",
    "name": "mysubsys",
    "dir": ""
  }

mysubsys                    -- 子系统目录
├── hello                   -- 组件目录
│   └── hellonapi           
│       ├── BUILD.gn        -- 组件module目录 
│       └── hellonapi.cpp   
└── ohos.build

#include <string.h>
#include "napi/native_node_api.h"
#include "napi/native_api.h"
// 接口业务实现C/C++代码
// std::string 需要引入string头文件，#include <string>
// 该napi_module对外具体的提供的API接口是 getHelloString
static napi_value getHelloString(napi_env env, napi_callback_info info) {
  napi_value result;
  std::string words = "Hello OpenHarmony NAPI";
  NAPI_CALL(env, napi_create_string_utf8(env, words.c_str(), words.length(), &result));
  return result;
}
// 注册对外接口的处理函数napi_addon_register_func
// 2.指定NAPI模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// 模块对外接口注册函数为registerFunc
static napi_value registerFunc(napi_env env, napi_value exports)
{
    static napi_property_descriptor desc[] = {

        // 声明该napi_module对外具体的提供的API为getHelloString
        DECLARE_NAPI_FUNCTION("getHelloString", getHelloString),
    };
    NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));
    return exports;
}
// 注册NAPI模块
// 1.先定义NAPI模块，指定当前NAPI模块对应的模块名
// 以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: NAPI模块名称，对应eTS代码为import nm_modname from '@ohos.ohos_shared_library_name'
// 示例对应hap应用中eTS代码需要包含import hellonapi from '@ohos.hellonapi'
// 以下的出现的hellonapi都为注册的NAPI模块名
static napi_module hellonapiModule = {
    .nm_version = 1,
    .nm_flags = 0,
    .nm_filename = nullptr,
    // registerFunc是NAPI模块对外接口注册函数
    .nm_register_func = registerFunc, 
    .nm_modname = "hellonapi",  
    .nm_priv = ((void*)0),
    .reserved = { 0 },
};
// 3.NAPI模块定义好后，调用NAPI提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用此constructor函数，把定义的模块注册到OpenHarmony中。
// 以下出现的hellonapi都是注册的NAPI模块名
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()
{
    // napi_module_register是ohos的NAPI组件提供的模块注册函数
    napi_module_register(&hellonapiModule);
}

// 接口业务实现C/C++代码
// std::string 需要引入string头文件，#include <string>
// 该napi_module对外具体的提供的API接口是 getHelloString
static napi_value getHelloString(napi_env env, napi_callback_info info) {
  napi_value result;
  std::string words = "Hello OpenHarmony NAPI";
  NAPI_CALL(env, napi_create_string_utf8(env, words.c_str(), words.length(), &result));
  return result;
}

#include "napi/native_api.h"
#include "napi/native_node_api.h"

// 注册对外接口的处理函数napi_addon_register_func
// 2.指定NAPI模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// 模块对外接口注册函数为registerFunc
static napi_value registerFunc(napi_env env, napi_value exports)
{
    static napi_property_descriptor desc[] = {

        // 声明该napi_module对外具体的提供的API为getHelloString
        DECLARE_NAPI_FUNCTION("getHelloString", getHelloString),
    };
    NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));
    return exports;
}
// 注册NAPI模块
// 1.先定义NAPI模块，指定当前NAPI模块对应的模块名
// 以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: NAPI模块名称，对应eTS代码为import nm_modname from '@ohos.ohos_shared_library_name'
// 示例对应hap应用中eTS代码需要包含import hellonapi from '@ohos.hellonapi'
// 以下的出现的hellonapi都为注册的NAPI模块名
static napi_module hellonapiModule = {
    .nm_version = 1,
    .nm_flags = 0,
    .nm_filename = nullptr,
    // registerFunc是该自定义的NAPI模块对外接口注册函数
    .nm_register_func = registerFunc, 
    .nm_modname = "hellonapi",  
    .nm_priv = ((void*)0),
    .reserved = { 0 },
};
// 3.NAPI模块定义好后，调用ohos的NAPI组件提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用constructor函数，把定义的模块注册到OpenHarmony中。
// 以下出现的hellonapi都是注册的NAPI模块名
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()
{
    // napi_module_register(napi_module* mod)是ohos的NAPI组件提供的模块注册函数
    napi_module_register(&hellonapiModule);
}

import("//build/ohos.gni")
#ohos_shared_library（）中的hellonapi决定了生成动态库的名称，增量编译阶段生成动态库libhellonapi.z.so 
ohos_shared_library("hellonapi") {   
   include_dirs = [
   #NAPI头文件目录
   "//foundation/arkui/napi/interfaces/kits", 
   "//foundation/arkui/napi/interfaces/inner_api", 
   #根据增量编译阶段报错添加的头文件目录
   "//third_party/node/src"                       
  ]
   #根据增量编译时clang编译器报警，添加的cflag
  cflags_cc = [ 
   #编译时报错提示"-Werror"，则加上"-Wno-error"
          "-Wno-error", 
   #编译时报错提示"-Wunused-function"，则加上"-Wno-unused-function"
          "-Wno-unused-function", 
  ]  
  #编译需要的源文件
  sources = [
    "hellonapi.cpp"
  ]
  #指定编译依赖libace_napi.z.so动态库
  deps = [ "//foundation/arkui/napi:ace_napi" ] 
  #指定库生成的路径
  #libhellonapi.z.so会安装在rk3568开发板的system/lib/module目录下
  relative_install_dir = "module" 
  #子系统名称是mysubsys
  subsystem_name = "mysubsys" 
  #组件名称是hello
  part_name = "hello"
}

"parts":{
    ...
    "mysubsys:hello":{},
    ...
  }

"parts":{
        "部件所属子系统名:部件名":{}
    }

"mysubsys": {
    "project": "hmf/mysubsys",
    "path": "mysubsys",
    "name": "mysubsys"
}

{
      "subsystem": "mysubsys",
      "components": [
        {
          "component": "hello",
          "features": []
        }
      ]
    }

./build.sh --product-name rk3568 --ccache --build-target=hellonapi --target-cpu arm64

import prompt from '@system.prompt'
// 引入扩展的NAPI模块 
// 在hellonapi.cpp文件中定义nm_modname（模块名称）为hellonapi
// 在BUILD.gn文件中定义ohos_shared_library结构体名称为hellonapi
// 所以是import hellonapi from '@ohos.hellonapi'
import hellonapi from '@ohos.hellonapi'
@Entry
@Component
struct HelloNAPI {
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Button("NAPI: hellonapi.getHelloString()").margin(10).fontSize(24).onClick(() => {

        // hellonapi.cpp对外具体的提供的API是getHelloString
        let strFromNAPI = hellonapi.getHelloString()
        prompt.showToast({ message: strFromNAPI })
      })
    }
    .width('100%')
    .height('100%')
  }
}

declare namespace hellonapi {
    function getHelloString(): string;
    /**
     * 
     *
     * @since 9
     * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
     */

}
export default hellonapi;