尽管Cocos官方提供了jsb.reflection.callStaticMethod方式支持从JS端直接调用Native端（Android，iOS/Mac）的接口，但是经过大量实践发现此接口在大量频繁调用情况下性能很低下，尤其是在Android端，比如调用Native端实现的打印log的接口，而且会容易引起一些native crash，例如local reference table overflow等问题。纵观Cocos原生代码的实现，基本所有的接口方法的实现都是基于JSB的方式来实现，所以此文主要讲解下JSB的自动绑定逻辑，帮助大家能快速实现callStaticMethod到JSB的改造过程。
背景
对于用过Cocos Creater（为了方便后文直接简称CC）的人来说，jsb.reflection.callStaticMethod 这个方法肯定不陌生，其提供了我们从JS端调用Native端的能力，例如我们要调用Native实现的log打印和持久化的接口，就可以很方便的在JavaScrpit中按照如下的操作调用即可：1
2
3
4
5
6
7
8
9if (cc.sys.isNative && cc.sys.os == cc.sys.OS_IOS) {
msg = this.buffer_string + '\n[cclog][' + clock + '][' + tag + ']' + msg;
jsb.reflection.callStaticMethod("ABCLogServuce", "log:module:level:", msg, 'cclog', level);
return;
} else if (cc.sys.isNative && cc.sys.os == cc.sys.OS_ANDROID) {
msg = this.buffer_string + '\n[cclog][' + clock + '][' + tag + ']' + msg;
jsb.reflection.callStaticMethod("com/example/test/CommonUtils", "log", "(ILjava/lang/String;Ljava/lang/String;)V", level, 'cclog', msg);
return;
}
尽管使用很简单，一行代码就能实现跨平台调用，稍微看下其实现就可以知道，在C++层Android端是通过jni的方式实现的，IOS端是通过运行时的方式动态调用，但是为了兼顾通用性和支持所有的方法，Android端没有对jni相关对象做缓存机制，就会导致短时间大量调用时出现很严重的性能问题，之前我们遇到的比较多的情况就是在下载器中打印log，某些应用场景短时间内触发大量的下载操作，就会出现local reference table overflow的crash，甚至在低端机上导致界面卡顿无法加载出来的问题。
修复此问题就需要针对log调用进行JSB的改造，同时还要加上jni的相关缓存机制，优化性能。
jSB绑定说白了就是 C++ 和脚本层之间进行对象的转换，并转发脚本层函数调用到 C++ 层的过程
JSB绑定通常有手动绑定和自动绑定两种方式，
手动绑定方式可以参考同事写的这篇文章，手动绑定方式优点是灵活，可定制型强，缺点就是全部代码要自己书写，尤其是在js类型跟c++类型转换上，稍有不慎容易导致内存泄漏，某些指针或者对象没有释放。
自动绑定方式则会帮你省了很多麻烦，直接通过一个脚本一键生成相关的代码，后续如果有新增或者改动，也只需要重新执行一次脚本即可。所以自动绑定对于不需要进行强定制，需要快速完成JSB的情况来说就再适合不过了。下面就一步步说明下如何实现自动绑定JSB：
环境配置和自动绑定展示
环境配置
自动绑定，说简单点，其实就只要执行一个python脚本即可自动生成对应的.cpp,.h ,.js文件。所以首先要保证电脑有python运行环境，这里以Mac上安装为例来讲解
1.安装python，强烈建议先安装HomeBrew,然后直接命令行运行1
2/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install python
2.通过pip安装python的一些依赖库1
2
3sudo easy_install pip
sudo pip install PyYAML
sudo pip install Cheetah
3.安装NDK，涉及到c++肯定这个是必不可少的，建议安装14b版本，然后在~/.bash_profile 中设置 PYTHON_ROOT 和 NDK_ROOT 这两个环境变量，因为在后面执行的python文件里面就会直接用到这两个环境变量1
2export NDK_ROOT="/Users/mycount/Library/Android/sdk/ndk-r14b"
export PYTHON_BIN="/usr/bin/python"
Window下直接参考上面需要安装的模块直接安装就好了，最后也要记得配置环境变量。
自动绑定展示
这里演示的是cocos引擎下面也即build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings/auto目录下的文件（如下图所示）是怎么自动生成的，
其实从这些文件名的开头也能看出，这些文件命名都是有某些特定规律的，那么这些文件是怎么生成的呢？
首先打开终端，先cd到build/jsb-default/frameworks/cocos2d-x/tools/tojs目录下，
然后直接运行./genbindings.py
大概运行一分钟左右后，会出现如下的提示，说明已经顺利生成完了。
当然一般大家第一次运行后很可能会失败，出现如下面类似的报错
一般都是因为配置的NDK版本太高导致，最开始我是用NDK16b就出现了问题，换成NDK14b后就OK了。
经过上面的步骤后，build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings/auto下的文件就全部自动生成出来了，是不是非常方便。
下面再以js层通过jsb调用Native层的log方法打印日志为例，详细的告知下如何实现通过自动绑定工具，依据自己写的c++代码，生成对应的自动绑定文件。
编写c++层的实现
C++作为连接js层和Native层的桥梁，既然要实现jsb调用，那第一步肯定是要先把C++层的头文件和实现准备好，这里我们在build/jsb-defaul/frameworks/cocos2d-x/cocos创建一个test文件夹用于存放相关文件，
这里先准备ABCJSBBridge.h，里面主要是申明了一个abcLog的函数，此函数就是供JS层调用打log的，另外由于打log方法肯定在js层很多地方都会使用，所以这里采用了一个单例模式，提供了getInstance()来获取当前类的实例1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
namespace abc
{
class IABCJSBBridgeImpl;
class JSBBridge
{
public:
void abcLog(const int level, const std::string& tag, const std::string& msg);
/**
* Returns a shared instance of the director.
* @js _getInstance
*/
static JSBBridge* getInstance();
/** @private */
JSBBridge();
/** @private */
~JSBBridge();
bool init();
private:
std::unique_ptr<IABCJSBBridgeImpl> _impl;
};
}
下面是对应的实现ABCJSBBridge.cpp:1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// include platform specific implement class
namespace abc
{
// singleton stuff
static JSBBridge *s_SharedJSBBridge = nullptr;
JSBBridge::JSBBridge()
{
DLLOG("Construct JSBBridge %p", this);
init();
}
JSBBridge::~JSBBridge()
{
DLLOG("Destruct JSBBridge %p", this);
s_SharedJSBBridge = nullptr;
}
JSBBridge* JSBBridge::getInstance()
{
if (!s_SharedJSBBridge)
{
DLLOG("getInstance JSBBridge ");
s_SharedJSBBridge = new (std::nothrow) JSBBridge();
CCASSERT(s_SharedJSBBridge, "FATAL: Not enough memory for create JSBBridge");
}
return s_SharedJSBBridge;
}
bool JSBBridge::init(void)
{
DLLOG("init JSBBridge ");
_impl.reset(new JSBBridgeImpl());
}
void JSBBridge::abcLog(const int level, const std::string& tag, const std::string& msg)
{
_impl->abcLog(level, tag, msg);
}
}
CCIABCJSBBridgeIml.h：1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
namespace abc
{
class IABCJSBBridgeImpl
{
public:
virtual ~IABCJSBBridgeImpl(){}
virtual void abcLog(const int level, const std::string& tag, const std::string& msg) = 0;
};
}
这里为了方便区分Android平台和iOS平台的实现，仿照Cocos源码其他地方的写法，分别提供了ABCJSBBridge-android.h和ABCJSBBridge-apple.h以及对应的实现类,两个平台分别继承IABCJSBBridgeImpl然后实现内部的虚函数即可。
JSB配置脚本编写
为了保持跟官方的一致，我们在build/jsb-default/frameworks/cocos2d-x/tools/tojs 目录下创建genbindings_test.py，里面的内容基本跟genbindings.py 差不多，主要区别有如下几点：
1.去掉了cmd_args 那段，里面主要是记录了cocos自带的一些需要生成jsb的文件，因为考虑到项目可能会对Cocos源码进行修改，如果这时候把这部分保留的话，当运行脚本后会把我们自带的修改就给覆盖掉了
2.取消了定制的output_dir也就是最终生成的js，c++等绑定文件的路径，而是保持跟Cocos一样，也即在cocos/scripting/js-bindings/auto，主要为了方便下一步配置mk文件
这里先说下genbindings_test.py里面配置的一些参数：
1.NDK_ROOT 环境变量：指示 NDK 的根目录
2.PYTHON_BIN 环境变量：指示 Python 命令的路径
3.cocosdir：Cocos 引擎根目录，在用户工程下一般是 build/jsb-default/frameworks/cocos2d-x/
4.jsbdir：JSB 目录，在用户工程下一般是 build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings
5.cxx_generator_root：自动绑定工具路径，在用户工程下一般是 build/jsb-default/frameworks/cocos2d-x/tools/bindings-generator
6.output_dir：生成的绑定文件存储路径
7.cmd_args和custom_cmd_args：所有配置文件，及其对应的模块名称和输出文件名称
这里自动绑定工具使用 libclang 的 python API 对 C++ 头文件进行语法分析。绑定的过程大致如下：
- 创建绑定代码输出文件。
- 递归扫描需要绑定的头文件。
- 通过 libclang 的 clang.cindex python 模块找到所有需要绑定的类，公共 API 等。
- 按照模版生成类绑定函数，API 绑定函数，绑定注册函数并输出到文件中。
关于custom_cmd_args参数的配置这里说明下：
1 | 'cocos2dx_test.ini': ('cocos2dx_test', 'jsb_cocos2dx_test_auto'), |
这里的配置文件cocos2dx_test.ini又是用来干嘛的呢？其实就跟build/jsb-default/frameworks/cocos2d-x/tools/tojs/下的其他.ini文件类似，主要让自动绑定工具知道哪些 API 要被绑定和以什么样的方式绑定，写法上直接参考Cocos已有的ini文件，这里展示下cocos2dx_test.ini的内容：
1 | [cocos2dx_test] |
其实从里面的注释也讲的非常详细，这里说几个主要的属性及含义：
以上的配置完成后，就可以按照如下命令运行自动生成绑定文件：
然后就会看到在build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings下面多出了三个绑定文件
打开生成的jsb_cocos2dx_test_autp.cpp：1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
se::Object* __jsb_abc_JSBBridge_proto = nullptr;
se::Class* __jsb_abc_JSBBridge_class = nullptr;
static bool js_cocos2dx_test_JSBBridge_abcLog(se::State& s)
{
abc::JSBBridge* cobj = (abc::JSBBridge*)s.nativeThisObject();
SE_PRECONDITION2(cobj, false, "js_cocos2dx_test_JSBBridge_abcLog : Invalid Native Object");
const auto& args = s.args();
size_t argc = args.size();
CC_UNUSED bool ok = true;
if (argc == 3) {
int arg0 = 0;
std::string arg1;
std::string arg2;
ok &= seval_to_int32(args[0], (int32_t*)&arg0);
ok &= seval_to_std_string(args[1], &arg1);
ok &= seval_to_std_string(args[2], &arg2);
SE_PRECONDITION2(ok, false, "js_cocos2dx_test_JSBBridge_abcLog : Error processing arguments");
cobj->abcLog(arg0, arg1, arg2);
return true;
}
SE_REPORT_ERROR("wrong number of arguments: %d, was expecting %d", (int)argc, 3);
return false;
}
SE_BIND_FUNC(js_cocos2dx_test_JSBBridge_abcLog)
static bool js_cocos2dx_test_JSBBridge_getInstance(se::State& s)
{
const auto& args = s.args();
size_t argc = args.size();
CC_UNUSED bool ok = true;
if (argc == 0) {
abc::JSBBridge* result = abc::JSBBridge::getInstance();
ok &= native_ptr_to_seval<abc::JSBBridge>((abc::JSBBridge*)result, &s.rval());
SE_PRECONDITION2(ok, false, "js_cocos2dx_test_JSBBridge_getInstance : Error processing arguments");
return true;
}
SE_REPORT_ERROR("wrong number of arguments: %d, was expecting %d", (int)argc, 0);
return false;
}
SE_BIND_FUNC(js_cocos2dx_test_JSBBridge_getInstance)
bool js_register_cocos2dx_test_JSBBridge(se::Object* obj)
{
auto cls = se::Class::create("JSBBridge", obj, nullptr, nullptr);
cls->defineFunction("abcLog", _SE(js_cocos2dx_test_JSBBridge_abcLog));
cls->defineStaticFunction("getInstance", _SE(js_cocos2dx_test_JSBBridge_getInstance));
cls->install();
JSBClassType::registerClass<abc::JSBBridge>(cls);
__jsb_abc_JSBBridge_proto = cls->getProto();
__jsb_abc_JSBBridge_class = cls;
se::ScriptEngine::getInstance()->clearException();
return true;
}
bool register_all_cocos2dx_test(se::Object* obj)
{
// Get the ns
se::Value nsVal;
if (!obj->getProperty("abc", &nsVal))
{
se::HandleObject jsobj(se::Object::createPlainObject());
nsVal.setObject(jsobj);
obj->setProperty("abc", nsVal);
}
se::Object* ns = nsVal.toObject();
js_register_cocos2dx_test_JSBBridge(ns);
return true;
}
看到这里是不是感觉很熟悉，跟Cocos 已有的那些cpp完全一样，甚至包括里面的注册函数和类的定义都给全部自动生成了。
Cocos编译配置
尽管经过上面一步后我们已经生成出来了绑定文件，但是js层还是没法直接使用，因为还需要把生成的绑定文件，配置到mk文件中，从而跟其他c++文件一起编译才行，这部分主要就是将最后的mk编译配置。
1.打开build/jsb-default/frameworks/cocos2d-x/cocos/Android.mk文件，在其中加上最开始实现的cpp文件
2.打开build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings/proj.android/Android.mk，在其中加上上一步生成的cpp文件
3.打开build/jsb-default/frameworks/runtime-src/Classes/jsb_module_register.cpp，添加引擎启动时调用绑定文件的注册函数，从而将其添加到js环境中
4.打开build/jsb-default/frameworks/cocos2d-x/cocos/scripting/js-bindings/script/jsb_boot.js，在其中增加js对象的初始化
上面说到的jsb_module_register.cpp 和jsb_boot.js 其实都是在Cocos引擎初始化的时候就会去调用的，关于启动流程感兴趣的可以去看看这篇文章
经过上面这些配置后，最终就可以在js层直接像下面这样来进行调用，而不是用callStaticMethod方式
自动绑定的限制条件
自动绑定依赖于Bindings Generator 工具，Cocos官方还在github上单独把这部分拎出来了，https://github.com/cocos2d/bindings-generator/
Bindings Generator 工具它可以将 C++ 类的公共方法和公共属性绑定到脚本层。自动绑定工具尽管非常强大，但是还是会有一些限制：
- 只能够针对类生成绑定，不可以绑定结构体，独立函数等。
- 不能够生成 Delegate 类型的 API，因为脚本中的对象是无法继承 C++ 中的 Delegate 类并重写其中的 Delegate 函数的。
- 子类中重写了父类的 API 的同时，又重载了这个 API。
- 部分 API 实现内容并没有完全体现在其 API 定义中。
- 在运行时由 C++ 主动调用的 API。
总结
总的来说，自动绑定JSB只需要要求开发者编写相关的实现c++实现类，一个配置文件，然后执行一条命令就能完整整个的绑定过程，如果没有什么特殊定制，相对于手动绑定来说，效率上还是提高了不少，实际工作做可以依据具体情况先用自动绑定功能，然后再去手动修改生成的绑定文件，达到事倍功半的效果。
