简化使用 JavaScript 调用 Java 方法(实验性功能)

注意:在 v3.6 之后,jsb 模块将会逐步废弃,接口将会迁移到 cc 命名空间下的 native 模块。

背景

在 v3.4.0 之前,通过反射机制在 JavaScript 调用 JAVA 的静态方法中,我们不仅需要严格声明包名和函数签名,还需要严格校对参数数量以确保正常运行,步骤较为复杂。

因此在 v3.4.0 中我们额外提供了另外一种实验性方法,用于简化脚本层到原生层的调用。这是一种通道,或者说是一个桥梁,在引入其他脚本系统前,我们将其命名为 JsbBridge,意为通过 JSB 绑定作为沟通脚本和原生 APP 的桥梁。

注意:这两种方式都是可以正常使用的,开发者可以根据实际需要选择使用。若要使用之前的方式,请前往 JavaScript 调用 JAVA 文档查看。

JavaScript 接口介绍

在脚本层的接口只有 sendToNativeonNative 两个,分别是 传输接收原生层 参数。使用时需要注意以下几点:

  • 由于现在这个功能还在实验阶段,所以只支持 string 的传输,如果需要传输包含多种参数的对象,请考虑将其转化为 Json 形式进行传输,并在不同层级解析。
  • onNative 同一时间只会记录一个函数,当再次 set 该属性时会覆盖原先的 onNative 方法。
  • sendToScript 方法是单向通信,不会关心下层的返回情况,也不会告知 JavaScript 操作成功或者失败。开发者需要自行处理操作情况。
// JavaScript
export namespace bridge{
    /**
     * Send to native with at least one argument.
     */
    export function sendToNative(arg0: string, arg1?: string): void;
    /**
     * Save your own callback controller with a JavaScript function,
     * Use 'jsb.bridge.onNative = (arg0: String, arg1: String | null)=>{...}'
     * @param args : received from native
     */
    export function onNative(arg0: string, arg1?: string | null): void;
}

Java 接口介绍

对应的 JAVA 接口同样以两个为主,包括 sendToScriptonScript

  • sendToScript 对应 sendToNative,表示需要传输到 JavaScript 的参数。
  • onScript 对应 onNative,表示收到脚本信息后的响应行为。通过创建名为 ICallback 的接口来封装行为,并且使用 setCallback 来启用该接口函数。
// JAVA
public class JsbBridge {
    public interface ICallback{
        /**
         * Applies this callback to the given argument.
         *
         * @param arg0 as input
         * @param arg1 as input
         */
        void onScript(String arg0, String arg1);
    }
    /** Add a callback which you would like to apply
     * @param f ICallback, the method which will be actually applied. multiple calls will override
     * */
    public static void setCallback(ICallback f);
    /**
     * Java dispatch Js event, use native c++ code
     * @param arg0 input values
     */
    public static void sendToScript(String arg0, String arg1);
    public static void sendToScript(String arg0);
}

基本使用

JavaScript 触发 Java 的方法

假设我们的广告接口设置在原生层,那么当玩家点击打开广告的按钮时,理应触发 JAVA 打开广告的操作。

打开广告的接口的代码示例如下:

public void openAd(String adUrl){
    //Code to open ad
}

这时候我们需要先注册打开广告的事件:

JsbBridge.setCallback(new JsbBridge.ICallback() {
        @Override
        public void onScript(String usrName, String url) {
            // Check usr
            // Open Ad
            openAd(url);
        }
    });

并且在 JavaScript 中对按钮的点击事件执行打开操作:

import { native } from 'cc'
public static onclick(){
    // 'usrName' and 'defaultAdUrl' are both string
    native.bridge.sendToNative(usrName, defaultAdUrl);
}

这样就可以通过 native.Bridge 这个通道将需要的信息发送到 Java 层执行打开广告的操作了。

JAVA 触发 JavaScript 的方法

假设我们的动画播放操作记录在 JavaScript,并且希望在 Java 层播放这个动画,也可以注册一个播放动画的事件。

首先需要定义一个播放动画的函数:

public void playAnimation(animationName: string, isLoop: boolean){
    //Code to play Animation
}

然后在 onNative 中记录该方法:

native.bridge.onNative = (animationName: string, isLoop: String | null):void=>{
    if(isLoop && isLoop == "true") {
        this.playAnimation(animationName, true);
        return;
    }
    this.playAnimation(animationName, false);
    return;
}

仍然以安卓项目为例,Java 代码示例如下:

JsbBridge.sendToScript("SkeletonAnim001", "true");

这样便可以调用到 JavaScript 的播放操作了。

示例工程:简单的多事件调用

Creator 提供了 native-script-bridgeGitHub | Gitee)范例,开发者可根据需要自行下载以参考使用。

results matching ""

    No results matching ""