鸿蒙 Native API 的封装库 h2lib_arkbinder

h2lib_arkbinder

介绍

code： https://gitee.com/evanown/h2lib_arkbinder
本类库实现 C++ 代码到鸿蒙 Native API 的封装与转换。
现在鸿蒙生态还处于热火朝天的建设阶段，能否快速的将其他平台如IOS、Android的APP快速、高效、高质量的移植到鸿蒙系统，关系到鸿蒙的兴衰大业。在鸿蒙APP开发中，华为目前主推的是ArkTS语音，实际上就是Typescript的一种变体，除了UI等代码的迁移，很多APP的核心资产都是C++代码比如一些高效的图像处理算法等。鸿蒙提供了Native API相关接口，可以实现ArkTS调用C++代码。本类库arkbinder可以大幅度的提升鸿蒙Native API的易用性，如果你也移植APP的过程中要处理老的C++代码，那么本类库可能会极大的加速你的工作。
目前Native API的问题

• Native Api的使用手册和示例代码都不算健全。APP的开发者对自己的C++资产代码是熟悉的，但是要通过ArkTS调用，则需要通过Native API封装，属性Native API的概念、api接口参数等细节，即枯燥乏味又常常让人疑惑，比如垃圾回收如何触发类的析构，文档实际给出了比较模糊的指引，比如 https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/use-napi-object-wrap-V5 中使用垃圾回收是使用delete析构了对象，而 https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/use-sendable-napi-V5 中示例只调用类的析构函数，但是没用使用delete析构内存，而在https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/use-napi-about-class-V5中DerefItem确不调用delete。
  
• 文档的示例代码似乎从不处理函数传功来的类型和数量，比如文档中最入门的导出c++的AddNum示例函数的代码如下，本人立即ArkTS是脚本代码，类型是允许传入任意类型的，而且鸿蒙的示例代码变量几乎不初始化（推断鸿蒙的核心开发都是搞C程序），如果运行期ArkTS传入的类型不合法（比如更新了版本？），那么这里是有安全隐患的。
  

1. // 此模块是一个Node-API的回调函数
2. static napi_value Add(napi_env env, napi_callback_info info)
3. {
4.     // 接受传入两个参数
5.     size_t requireArgc = 2;
6.     size_t argc = 2;
7.     napi_value args[2] = {nullptr};
8.     napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);//没有处理参数少于2个的情况
10.     // 将传入的napi_value类型的参数转化为double类型
11.     double valueLeft;
12.     double valueRight;
13.     napi_get_value_double(env, args[0], &valueLeft);//!如果使用者不小心传入了字符串会怎样？
14.     napi_get_value_double(env, args[1], &valueRight);

复制代码

• 对于C++的多态、继承似乎也没有文档说明。这个可以理解，官方似乎还是希望你多用ArkTS，毕竟C++的概念太多很难跟ArkTS中的概念一一对应。但是如果C++的资产中存在类的继承已经多态函数（这很正常的对吧？），你肯定不想修改八百年不曾修改的老C++代码（导致其他平台不兼容？）。
  
• 如果自己编写Native API封装老的C++代码，对于开发者有很强的专业要求，既要对Typscript(实际上是javascript)的概念有了解，又要对NativeAPI的一些类型判断、引用计数等时刻谨慎，同时编写的代码还要高效安全，这无疑是费力难做好的工作，单似乎又要每个APP的开发者独立的做一遍。
  
• 本类库基于以上原因，开发了arkbinder，提供一个企业级、高效安全、教科书级的NativeAPI调用的封装。
  

arkbinder使用说明

arkbinder移动三个宏H2_DEF_CLASS定义类，H2_DEF_ITERFACE定义函数、类方法、类属性，最后H2_DEF_MODULE_FINISH(模块名);完成注册。
定义全局函数

如定义一个全局函数AddNum, 直接使用宏H2_DEF_ITERFACE注册，在所有注册完成后使用H2_DEF_MODULE_FINISH定义导出的模块名（必须和CMakeList中的so名一致），在ArkTS中就可以直接用了。

1. static double AddNum(double a, double  b){
2.     return a*100 + b;
3. }
4. extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
5. {
6.     H2_DEF_ITERFACE(&AddNum);
7.     H2_DEF_MODULE_FINISH("entry");//!一定要放在定义的最后
8. }
9. //ArkTS示例代码
10.     import cppExt from 'libentry.so';
11.     let a = cppExt.AddNum(2, 3);

复制代码

C++类全局函数

若要定义C++的静态函数，同样使用H2_DEF_ITERFACE宏，它会自动判断这个全局函数属于哪个类，并正确的注册到对应的类上

1. class Animal
2. {
3. public:
4.     static std::string PrintTypeName(){ return typeid(Animal).name();}
5. //注册代码如下
6.     H2_DEF_ITERFACE(&Animal::PrintTypeName);//仍然使用宏注册
7. //ArkTS示例代码
8.     cppExt.Animal.PrintTypeName();

复制代码

注册C++类

定义构造函数使用H2_DEF_CLASS，支持多态，定义的时候需要显示的标明构造函数的类型

1. class Animal
2. {
3. public:
4.     Animal(std::string s=""):name(s),color(0){}
5.     Animal(std::string s, int c):name(s),color(c){}
6. //注册代码如下
7.     H2_DEF_CLASS(Animal(const std::string&));
8.     H2_DEF_CLASS(Animal(const std::string&, int));
9. //ArkTS示例代码
10.     let dog = new cppExt.Animal("dog");
11.     let dog2 = new cppExt.Animal("dog", 1);

复制代码

定义C++类继承父类

如果C++的类是继承于父类，并且父类已经使用H2_DEF_CLASS定义，那么子类定义是使用H2_DEF_CLASS2显示的标明父类。

1. class  Bird:public Animal{
2. public:
3.     Bird(std::string strName=""):Animal(strName){}
4.     virtual  int Fly(int nHeight){
5.         return nHeight;
6.     }
7. //注册代码如下
8.     H2_DEF_CLASS2(Bird(std::string), Animal);
9. //ArkTS示例代码
10.     let eagle = new cppExt.Bird("eagle");
11. };

复制代码

C++类属性

H2_DEF_ITERFACE用来定义类中的属性字段，数值类型、字符串、已经注册过的类、指针等都支持。

1. struct Pos{
2.     Pos(int a = 0, int b = 0):x(a),y(b){}
3.     int x;
4.     int y;
5. };
6. //注册代码如下
7.     H2_DEF_CLASS(Pos(int, int));
8.     H2_DEF_ITERFACE(&Pos::x);
9.     H2_DEF_ITERFACE(&Pos::y);
10. //ArkTS示例代码
11.     let pos = new cppExt.Pos(50, 60);

复制代码

C++类方法

H2_DEF_ITERFACE一键定义类中的方法，支持所有标准数值、字符串、注册过的类，以及各种函数的const、引用的使用。你如果对C++模板编程感兴趣，不妨可以看看类库是如何用模板特化机制来实现对Native API的封装的。

1. class Animal
2. {
3.     virtual  int Fly(int nHeight);
4.     void SetColor(int c);
5.     int GetColor() const;
6.     const std::string& GetName() const;
7.     void SetName(const char* s);
8.     const Pos& GetPos() const;
9. //注册代码如下
10.     H2_DEF_ITERFACE(&Animal::GetColor);
11.     H2_DEF_ITERFACE(&Animal::SetColor);
12.     H2_DEF_ITERFACE(&Animal::SetName);
13.     H2_DEF_ITERFACE(&Animal::GetName);
14.     H2_DEF_ITERFACE(&Animal::GetPos);
15. //ArkTS示例代码
16.     dog.SetColor(66);
17.     let c = dog.GetColor();
18.     let n = dog2.GetName();

复制代码

C++类多态

示例代码中Go函数是多态的，注册的时候要显示的标明注册的函数类型，其实就是转成函数指针，这样编译器就知道你要注册哪个了。

1. class Animal
2. {
3.     virtual void Go(int x, int y);
4.     virtual void Go(const Pos& p);
5. //注册代码如下
6.     H2_DEF_ITERFACE((void(Animal::*)(int, int))(&Animal::Go));
7.     H2_DEF_ITERFACE((void(Animal::*)(const Pos&))&Animal::Go);
8. //ArkTS示例代码
9.     dog.Go(100, 200);
10.     let pos = new cppExt.Pos(50, 60);
11.     dog.Go(pos);

复制代码

嵌套支持STL容器

arkbinder通过泛型模版编程嵌套的支持vector、list、set、map，所有这四个类型的任意组合和嵌套，全部支持。
容器的元素类型支持标准数值、字符串、string、注册的类对象、指针以及嵌套的这四个容器类型。

1. class Animal
2. {
3.     std::map<std::string, std::string> Dump(){
4.         std::map<std::string, std::string> ret;
5.         ret["name"] = name;
6.         ret["color"] = std::to_string(color);
7.         ret["pos"] = "["+std::to_string(pos.x)+","+std::to_string(pos.y)+"]";
8.         return ret;
9.     }
10. //注册代码如下
11.     H2_DEF_ITERFACE(&Animal::Dump);
12. //ArkTS示例代码
13.     let m = dog.Dump([1, 2, 3, 4, 5]);
14.     let ms = JSON.stringify(m, null, 4);
15.     hilog.info(DOMAIN, 'testTag', 'stl = %{public}s', ms);

复制代码

支持将C++类对象、引用、值对象传入ArkTS

已经定义的C++类指针和引用以及const引用都可以传入ArkTS，实际上以临时类指针的方式传入ArkTs，这种情况，ArkTS是不负责垃圾回收的，对象的生命周期管理仍然由C++负责，如果函数参数或者函数返回值为类对象的值对象，那么实际上arkbinder内部会new一个对象给arkTS，这样的临时对象是由artTS的垃圾回收负责的。

1. class Animal
2. {
3.     virtual const Animal* GetSelf() {
4.         return this;
5.     }
6.     bool IsSame(const Animal& p) const{
7.         return &p == this;
8.     }
9.     Pos AllocPos();
10. //注册代码如下
11.     H2_DEF_ITERFACE(&Animal::GetSelf);
12.     H2_DEF_ITERFACE(&Animal::IsSame);//上面两个接口指针都是临时的，arkTS垃圾回收不会触发对象析构
13.     H2_DEF_ITERFACE(&Animal::AllocPos);//!这里返回的Pos对象垃圾回收是ArkTs负责的。
14. //ArkTS示例代码
15.     let dog2 = dog.GetSelf();
16.     dog.IsSame(dog2)

复制代码

支持将std::function和ArkTS的function进行互相映射

如果将ArkTs的function作为函数参数，自动转换成C++的std::function。
如果将std::function转入到ArkTS中，std::function会转换成ArkTS的一个类对象CppLambdaFunc，调用
call回调c++的函数，参数为任意参数类型的一个列表。

1. export class CppLambdaFunc{
2.   call: (a: Array) => string;
3. }

复制代码

1. class Animal
2. {
3.     int Touch(std::function<int(double)> cb){
4.         return cb(66.99)+100;
5.     }
6.     std::function<std::string(int)> GenFunc(){
7.         return [](int v)->std::string{
8.             std::string ret = "GenFunc:"+std::to_string(v);
9.             return ret;
10.         };
11.     }
12. //注册代码如下   
13.     H2_DEF_ITERFACE(&Animal::Touch);
14.     H2_DEF_ITERFACE(&Animal::GenFunc);
15. //ArkTS示例代码
16.     let tret = dog.Touch((a:number)=>{
17.         return a+2000;
18.     });
19.     let cppcb = dog.GenFunc();
20.     let cppcb_ret = cppcb.call([199]);

复制代码

附加说明

高度可扩展

如果你使用了其他类型，在arkbinder中没有支持导致编译不过，自己可以通过模板特化实现扩展，因为arkbinder只有一个头文件完全模板代码，所以可以在编译器扩展。支持新类型只需要对ScriptCppTypeTraits类进行特化，编写两个函数，static void Script2CppType(napi_env env, napi_value nv, T& ret)函数将ArkTS中的类型转换为C++的类型，而static void Cpp2ScriptType(napi_env env, napi_value& ret, const T& val){则相反，将c++的类型转换成ArkTS类型。如std::string 的特化代码如下

1. template struct ScriptCppTypeTraits{        static int TypeVal() { return napi_string;}    static void Script2CppType(napi_env env, napi_value nv, std::string& ret){        if (!nv){            return;        }        napi_valuetype valuetype0;        napi_typeof(env, nv, &valuetype0);        switch (valuetype0){            case napi_number:{                double tmpv = 0.0;                napi_get_value_double(env, nv, &tmpv);                ret = std::to_string(tmpv);            }break;            case napi_bigint:{                int64_t tmpv = 0;                napi_get_value_int64(env, nv, &tmpv);                ret = std::to_string(tmpv);             }break;            case napi_string:{                size_t length = 0;                napi_status status = napi_get_value_string_utf8(env, nv, nullptr, 0, &length);                // 传入一个非字符串 napi_get_value_string_utf8接口会返回napi_string_expected                if (status != napi_ok) {                    return;                }                ret.reserve(length+1);                ret.resize(length, 0);                (void)ret.c_str();                napi_get_value_string_utf8(env, nv, &ret[0], length + 1, &length);            }break;            default:{            }break;        }    }    static void Cpp2ScriptType(napi_env env, napi_value& ret, const std::string& val){        napi_create_string_utf8(env, val.c_str(), val.size(), &ret);    }    static void Cpp2ScriptType(napi_env env, napi_value& ret, const char* val){        napi_create_string_utf8(env, val, NAPI_AUTO_LENGTH, &ret);    }    template    static void Cpp2ScriptType(napi_env env, napi_value& ret, R val){        std::ostringstream oss;        oss  number;export class Pos {  constructor(x?: number, y?:number);  x:number;  y:number;}export class CppLambdaFunc{
2.   call: (a: Array) => string;
3. }export class Animal {  constructor(name: string, c?:number);  static PrintTypeName():string;  Go: (a: number|Pos, b?:number) => void;  GetColor: () => number;  SetColor: (a: number) => void;  SetName: (a: string) => void;  GetName: () => string;  GetSelf:()=>Animal;  IsSame:(a:Animal)=>boolean;  Fly: (a: number) => number;  Dump:(a:number[])=>object;  GetPos:()=>Pos;  Touch:(cb:any)=>number;  GenFunc:()=>CppLambdaFunc;}export class Bird extends Animal{  constructor(arg: string);}

复制代码

以上。


来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！