Node和Electron环境下集成第三方原生SDK

NodeJs Addons是为了能让nodejs调用原生模块而设计的机制，之前对一些常见原生模块的重编译做过梳理。但那都是Git上已经封装好的nodejs Addons库， 但若项目需要集成第三方提供的原生SDK，如何使用Nodejs去调用，以及如何打包到Electron项目中？

背景

项目中需要集成第三方投屏功能，合作厂商扔过来Mac和Windows SDK。文档看了后，接口确实设计的比较简单易用，但SDK是为原生框架设计的，没有现成的Node集成方案。

Mac SDK是Framework形式，Mac开发基于OC，所以我们选用 NodObjC 尝试调用SDK。NodObjC能让Node直接调用Framework暴露的接口。其本身也基于ffi和ref这两个库。

Windows SDK比较复杂，SDK申明的接口全放置在一个头文件中，在常规VC项目里，我们只需引入头文件和核心.lib文件，即可实现调用。这里，我们看了接口封装形式，感觉不适合使用ffi这类JS库，决定自己写一个Addons来实现调用。

Mac

环境

下载NodObjc，npm install nodobjc

NodObjc依赖的ffi和ref两个库属于Addons，需要根据运行环境去重编译。需要先全局安装好node-gyp，然后根据当前是在node环境还是Electron环境调试去重编译。

这里遇到一个Node版本导致的问题，nodobjc在依赖库的版本号上似乎有些问题，导致依赖ref无法在node 10下编译成功。通过n安装node 8，重新下载和编译。

API

• 引用

  const $ = require('nodobjc');
  
  $.import(frameworkPath);
  $.framework('Foundation');
  

• JS与OC的类型转换

  字符串： String -> NSString，var str = $('abc');

  Number类型： Number -> NSNumber， var num = 123;

  Boolean： bool -> Bool，var isTrue = $.Yes;

  回调函数： callback -> Block：

  OC接口:

  [[Test commonTest] startTest:@"123456" completeBlock:^(BOOL succeed, NSError *error) {
  
  }];
  

  通过NodObjc调用该OC接口：

  const startTest = (data) => {
    const param = $(data);
    const completeBlock = $(function(self, success, err) {
      console.log('test result', success, err);
    }, ['v', ['?', 'B', '@']]);
    commonTest('startTest', param, 'completeBlock', completeBlock);
  }
  

  NodObjc的文档并不是很详细，需要一定的OC语法基础。当然，花点时间看下NodObjc的源码也能知道具体调用方式。

• 编译与打包

  打包有两个注意点，一是需要通过node-gyp将ffi和ref库重编译生成Electron环境下可用的.node。二是适应electron-builder的打包规则。

  有问题的打包方案：

  1. 直接打包到app.asar，打完包会发现js无法引用Framework

  2. 通过配置electron-builder打包规则，将Framework所有文件打包到app.asar.unpack目录。讲道理，按之前的经验，这样应该就可以了。结果直接在打包的签名这步GG了。看上去electron-builder无法对二进制文件进去签名：

     ***.framework, bundle format unrecognized, invalid, or unsuitable
     

  解决方案

  最后，选择用extraResources字段，将Framework从打包文件中抽出来，直接复制到Mac应用的Resources目录下，然后在调用的js文件中，根据运行环境动态选择调用路径：

  const path = require('path');
  
  const isDev = process.env.NODE_ENV == 'dev';
  
  const devPath = path.resolve(__dirname, 'Test.framework');
  const prodPath = path.resolve(__dirname, 'Test.framework').replace('app.asar/src', 'src');
  // const frameworkPath = path.resolve(__dirname, 'HPOfficeCastWork.framework');
  const path = isDev ? devPath : prodPath;
  const frameworkPath = require(path);
  

Windows

windows方面，我们先自己按照Node Addons的开发规则来实现一个.node文件，后面直接调用.node来实现功能。

环境

首先配好windows的node-gyp编译环境。先下载安装python2.7和windows-build-tools。将python路径配置到系统环境。

因为要编译C++程序，需要保证系统已安装好C++相关的组件。C++组件缺失会在Addons模块编译的时候报错，根据具体错误内容，下载对应缺失组件即可。

在node环境下写模块demo的时候，编译报错：无法解析外部符号。这个错一开始以为是某一块的语法有问题，其实是因为SDK提供的lib是32位，而我们编译的node环境是64位。重新安装和配置32位的Node环境即能解决这个问题。

binding.gyp

node-gyp通过binding.gyp文件配置模块的编译，因此，先了解好.gyp的属性很有必要：gyp3.org

{
    "targets": [
    "target_name": "test",
    "sources": ["test.cc"],
    "include_dirs": [
      "inc",
      "<!(node -e \"require('nan')\")",
    ],
    "libraries": [
      "../lib/sdk.lib"
    ],
    "conditions": [
        [
        "OS='win'", {
          "copies": [
            {
              "destination": "<(PRODUCT_DIR)",
              "files": [
                "<(DLL_ROOT)/dnssd.dll",
                "<(DLL_ROOT)/avutil.dll",
                ...
              ]
            }
          ]
        }
      ]
    ]
  ]
}

结合实际开发，介绍几个常用字段：

include_dirs: 要用到的头文件所在目录，<!(node -e \"require('nan')\")用于引入nan的头文件，<!是命令行扩展，gyp会将后面的字符通过shell执行。

conditions，自然是判断条件，通常我们通过OS字段来判断当前的操作系统环境，对应的值是win，mac和linux。

copies是为了执行文件的拷贝。起初，没有加这段配置，编译成功后，我们引用生成的.node会报the specified module could not be found错误。这里可以通过工具dependency walker分析.node文件，查看缺失的依赖。一般这种情况，将相关dll文件放到.node同级目录即可。 于是，通过copies可以在编译后将指定文件复制到目标目录。<(PRODUCT_DIR)即表示.node生成后的目录。

Addons开发

Addonss是Node提供的动态链接共享对象，具有C/C++类库的调用能力。bingding.gyp中，我们配置了sources字段的值test.cc。在test.cc中，我们通过引入v8.h, node.h , SDK提供的头文件等来实现对C++接口的调用。

#include <node.h>
#include <nan.h>
#include "inc/test.h"

namespace test
{

    using namespace v8;
    using namespace test; 
  
  static IMirror *pobMirror = 0;
  
  void initSdk(const FunctionCallbackInfo<Value>& args)
  {
    Isolate* isolate = args.GetIsolate();

    std::string appKey = *Nan::Utf8String(args[0]);
    std::string pinCode = *Nan::Utf8String(args[1]);
    std::string userId = *Nan::Utf8String(args[2]);
    std::string serverAddr = *Nan::Utf8String(args[3]);
    unsigned int serverPort = args[4]->Uint32Value();
    bool isEnterprise = args[5]->BooleanValue();
    Local<Function> cb = Local<Function>::Cast(args[6]);
    
    emRtn = pobMirror->Start(appKey, pinCode, userId, serverAddr, 
      serverPort, isEnterprise);
    
    const unsigned argc = 1;
    Local<Value> argv[argc] = {String::NewFromUtf8(isolate, ToString(emRtn))};
    cb->Call(isolate->GetCurrentContext()->Global(), argc, argv);
    }

  
    void Initialize(Local<Object> exports)
    {
    NODE_SET_METHOD(exports, "initSdk", InitSdk);
    }

    NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)
} // namespace hpcast

js调用Addons的接口，传递进来的是v8数据类型，而我们调用SDK接口，需要将其转为C++数据类型。这里引用了Nan的类型转换方法：

std::string serverAddr = *Nan::Utf8String(args[3]);
unsigned int serverPort = args[4]->Uint32Value();
bool isEnterprise = args[5]->BooleanValue();

对于回调函数，在转为Local<Function>类型后，通过Call方法触发回调：

Local<Function> cb = Local<Function>::Cast(args[6]);

const unsigned argc = 1;
Local<Value> argv[argc] = {String::NewFromUtf8(isolate, ToString(emRtn))};
cb->Call(isolate->GetCurrentContext()->Global(), argc, argv);

打包

和mac类似，如果直接将SDK和源码一起打包，electron是无法引入SDK的。因windows暂时没有签名，我们直接通过asarUnpack将SDK文件打包到app.asar.unpack目录。