cocos2d-js反射

Posted 2020-11-02 KefeiGame

 

如何在android平台上使用js直接调用Java方法

在cocos2d-js 3.0beta中加入了一个新特性，在android平台上我们可以通过反射直接在js中调用java的静态方法。它的使用方法很简单：

1 var o = jsb.reflection.callStaticMethod(className, methodName, methodSignature, parameters...)

在callStaticMethod方法中，我们通过传入Java的类名，方法名，方法签名，参数就可以直接调用Java的静态方法，并且可以获得Java方法的返回值。下面介绍的类名和方法签名可能会有一点奇怪，但是Java的规范就是如此的。

类名

参数中的类名必须是包含Java包路径的完整类名，例如我们在org.cocos2dx.javascript这个包下面写了一个Test类：

package org.cocos2dx.javascript;

public class Test {

    public static void hello(String msg){
        System.out.println(msg);
    }

    public static int sum(int a, int b){
        return a + b;
    }

    public static int sum(int a){
        return a + 2;
    }

}

那么这个Test类的完整类名应该是org/cocos2dx/javascript/Test,注意这里必须是斜线/,而不是在Java代码中我们习惯的点.。

方法名

方法名很简单，就是方法本来的名字，例如sum方法的名字就是sum。

方法签名

方法签名稍微有一点复杂，最简单的方法签名是()V，它表示一个没有参数没有返回值的方法。其他一些例子：

• (I)V表示参数为一个int，没有返回值的方法
• (I)I表示参数为一个int，返回值为int的方法
• (IF)Z表示参数为一个int和一个float，返回值为boolean的方法

现在有一些理解了吧，括号内的符号表示参数类型，括号后面的符号表示返回值类型。因为Java是允许函数重载的，可以有多个方法名相同但是参数返回值不同的方法，方法签名正是用来帮助区分这些相同名字的方法的。

目前Cocos2d-js中支持的Java类型签名有下面4种：

Java类型	签名
int	I
float	F
boolean	Z
String	Ljava/lang/String;

参数

参数可以是0个或任意多个，直接使用js中的number，bool和string就可以。

使用示例

我们将会调用上面的Test类中的静态方法：

//调用hello方法
jsb.reflection.callStaticMethod("org/cocos2dx/javascript/Test", "hello", "(Ljava/lang/String;)V", "this is a message from js");

//调用第一个sum方法
var result = jsb.reflection.callStaticMethod("org/cocos2dx/javascript/Test", "sum", "(II)I", 3, 7);
cc.log(result); //10

//调用第二个sum方法
var result = jsb.reflection.callStaticMethod("org/cocos2dx/javascript/Test", "sum", "(I)I", 3);
cc.log(result); //5

在你的控制台会有正确的输出的，这很简单吧。

##注意 另外有一点需要注意的就是，在android应用中，cocos的渲染和js的逻辑是在gl线程中进行的，而android本身的UI更新是在app的ui线程进行的，所以如果我们在js中调用的Java方法有任何刷新UI的操作，都需要在ui线程进行。

例如，在下面的例子中我们会调用一个Java方法，它弹出一个android的Alert对话框。

//给我们熟悉的AppActivity类稍微加点东西
public class AppActivity extends Cocos2dxActivity {

    private static AppActivity app = null;
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        app = this;
    }

    public static void showAlertDialog(final String title,final String message) {

        //这里一定要使用runOnUiThread
        app.runOnUiThread(new Runnable() {
            @Override
            public void run() {
                AlertDialog alertDialog = new AlertDialog.Builder(app).create();
                alertDialog.setTitle(title);
                alertDialog.setMessage(message);
                alertDialog.setIcon(R.drawable.icon);
                alertDialog.show();
            }
        });
    }
}

然后我们在js中调用

jsb.reflection.callStaticMethod("org/cocos2dx/javascript/AppActivity", "showAlertDialog", "(Ljava/lang/String;Ljava/lang/String;)V", "title", "hahahahha");

这样调用你就可以看到一个android原生的Alert对话框了。

再加点料

现在我们可以从js调用Java了，那么能不能反过来？当然可以！ 在你的项目中包含Cocos2dxJavascriptJavaBridge，这个类有一个evalString方法可以执行js代码，它位于frameworks\js-bindings\bindings\manual\platform\android\java\src\org\cocos2dx\lib文件夹下。我们将会给刚才的Alert对话框增加一个按钮，并在它的响应中执行js。和上面的情况相反，这次执行js代码必须在gl线程中进行。

alertDialog.setButton("OK", new DialogInterface.OnClickListener() {
    public void onClick(DialogInterface dialog, int which) {
        //一定要在GL线程中执行
        app.runOnGLThread(new Runnable() {
            @Override
            public void run() {
                Cocos2dxJavascriptJavaBridge.evalString("cc.log(\"Javascript Java bridge!\")");
            }
        });
    }
});

这样在点击OK按钮后，你应该可以在控制台看到正确的输出。evalString可以执行任何js代码，并且它可以访问到你在js代码中的对象。

 

如何在ios平台上使用js直接调用OC方法

在Cocos2d-JS v3.0 RC2中，与Android上js调用Java一样，Cocos2d-JS也提供了在iOS和Mac上js直接调用Objective-C的方法，示例代码如下：

var ojb = jsb.reflection.callStaticMethod(className, methodNmae, arg1, arg2, .....);

在jsb.reflection.callStaticMethod方法中，我们通过传入OC的类名，方法名，参数就可以直接调用OC的静态方法，并且可以获得OC方法的返回值。

类

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

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

 

方法

• js到OC的反射仅支持OC中类的静态方法。
• 方法名比较要需要注意，我们需要传入完整的方法名，特别是当某个方法带有参数的时候，你需要将他的:也带上。根据上面的例子。此时的方法名字是callNativeUIWithTitle:andContent:，不要漏掉了他们之间的:。
• 如果是没有参数的函数，那么他就不需要:,如下代码，他的方法名是callNativeWithReturnString，由于没有参数，他不需要:，跟OC的method写法一致。

 +(NSString *)callNativeWithReturnString;

 

使用示例

• 下面的示例代码将调用上面NativeOcClass的方法，在js层我们只需要这样调用：

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

 

• 这里是这个方法在OC的实现，可以看到是弹出一个native的对话框。并把title和content设置成你传入的参数，并返回一个boolean类型的返回值。

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

 

• 此时，你就可以在ret中接受到从OC传回的返回值（true）了。

注意

在OC的实现中，如果方法的参数需要使用float、int、bool的，请使用如下类型进行转换：

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

 

+(float) addTwoNumber:(NSNumber *)num1 and:(NSNumber *)num2{
    float result = [num1 floatValue]+[num2 floatValue];
    return result;
}

 

目前参数和返回值支持 int, float, bool, string，其余的类型暂时不支持。

文件目录

java：frameworks\runtime-src\proj.android\src\org\cocos2dx\javascript

ios:frameworks\runtime-src\proj.ios_mac\mac