如何在 iOS 平台上使用 Javascript 直接调用 Objective-C 方法

本文档基于 v2.x 编写,在 Cocos Creator 3.0 上可能略有变动,我们会尽快更新。

使用 Cocos Creator 打包的 iOS 或者 Mac 原生应用中,我们也提供了 JavaScript 通过原生语言的反射机制直接调用 Objective-C 函数的方法,示例代码如下:

  1. var result = jsb.reflection.callStaticMethod(className, methodName, arg1, arg2, .....);

jsb.reflection.callStaticMethod 方法中,我们通过传入 Objective-C 的类名、方法名、参数就可以直接调用 Objective-C 的静态方法,并且可以获得 Objective-C 方法的返回值。注意仅仅支持调用可访问类的静态方法。

警告:苹果 App Store 在 2017 年 3 月对部分应用发出了警告,原因是使用了一些有风险的方法,其中 respondsToSelector:performSelector: 是反射机制使用的核心 API,在使用时请谨慎关注苹果官方对此的态度发展,相关讨论:JSPatchReact-NativeWeex

参数中的类名,只需要传入 Objective-C 中的类名即可,与 Java 不同,类名并不需要路径。比如你在工程底下新建一个类 NativeOcClass,只要你将它引入工程,那么它的类名就是 NativeOcClass,你并不需要传入它的路径。

  1. import <Foundation/Foundation.h>
  2. @interface NativeOcClass : NSObject
  3. +(BOOL)callNativeUIWithTitle:(NSString *) title andContent:(NSString *)content;
  4. @end

方法

  • JavaScript 到 Objective-C 的反射仅支持 Objective-C 中类的静态方法。
  • 方法名比较需要注意。我们需要传入完整的方法名,特别是当某个方法带有参数的时候,需要将它的 : 也带上。根据下面的例子,此时的方法名是 callNativeUIWithTitle:andContent:,不要漏掉了中间的 :

    1. +(BOOL)callNativeUIWithTitle:(NSString *)title andContent:(NSString *)content;
  • 如果是没有参数的函数,那么就不需要 :。如下面代码中的方法名是 callNativeWithReturnString,由于没有参数,就不需要 :,跟 Objective-C 的 method 写法一致。

    1. +(NSString *)callNativeWithReturnString;

使用示例

下面的示例代码将调用上面 NativeOcClass 的方法,在 JavaScript 层我们只需要这样调用:

  1. var ret = jsb.reflection.callStaticMethod("NativeOcClass",
  2. "callNativeUIWithTitle:andContent:",
  3. "cocos2d-js",
  4. "Yes! you call a Native UI from Reflection");

这里是这个方法在 Objective-C 的实现,可以看到是弹出了一个原生对话框。并把 titlecontent 设置成你传入的参数,并返回一个 boolean 类型的返回值。

  1. +(BOOL)callNativeUIWithTitle:(NSString *) title andContent:(NSString *)content{
  2. UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:title message:content delegate:self cancelButtonTitle:@"Cancel" otherButtonTitles:@"OK", nil];
  3. [alertView show];
  4. return true;
  5. }

此时,你就可以在 ret 中接收到从 Objective-C 传回的返回值(true)了。

Objective-C 执行 JavaScript 代码

反过来,我们也可以通过 evalString 在 C++ 或者 Objective-C 中执行 JavaScript 代码。

比如:

  1. Application::getInstance()->getScheduler()->performFunctionInCocosThread([=](){
  2. se::ScriptEngine::getInstance()->evalString(script.c_str());
  3. });

注意:除非明确当前线程是 主线程,否则都需要将函数分发到主线程执行。

注意

在 Objective-C 的实现中,如果方法的参数需要使用 float、int 和 bool 的,请使用如下类型进行转换:

  • float、int 请使用 NSNumber 类型
  • bool 请使用 BOOL 类型
  • 例如下面代码,传入两个浮点数,然后计算它们的合并返回,我们使用 NSNumber 作为参数类型,而不是 int 和 float。

    1. +(float) addTwoNumber:(NSNumber *)num1 and:(NSNumber *)num2{
    2. float result = [num1 floatValue]+[num2 floatValue];
    3. return result;
    4. }
  • 目前参数和返回值支持 intfloatboolstring,其余的类型暂时不支持。