Hybrid App交互方案-规范（一）

Android/iOS 功能交互

• Android 在加载 H5 页面的时候，需要向 WebView 里面注入一个 _JHAPP 对象，并且该对象提供一个可供 JS 调用的 api 方法；

• iOS 在加载 H5 页面的时候，因为苹果不支持对象注入，所以里面是注入一个 ** _JHAPP** 方法，并且该方法也可供 JS 调用。

但是 Android 和 iOS 与 JS 交互的机制是不一样的，所以还需要制定一下统一的交互规则，方便 JS 进行方法调用。

Android 端调用可以直接拿到调用返回值：

let result = window._jh.api(); // 无参数 API 调用
let result = window._jh.api('eyJuYW1lIjogInRpdGxlIn0='); // 有参数 API 调用

参数解析格式：

{
    RequestId   : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", // 唯一调用标识
    MethodName  : "getPlatformName", // 调用方法名称
    Params  : null | {}, // 要调用方法的参数
}

• RequestId ： 此标识能够代表 JS 的唯一请求，如果是异步方法调用，可以在异步方法完成后回调该标识；
• MethodName ： 要调用的方法名称，请参照接口文档进行实现；
• Params ： 要调用的方法的参数，可以为 Null 或者是一个 Object 类型，为 Null 代表没有参数，反之则 Object 中的每一个 Key 代表一个参数项；
• 同步返回 ： Android 可以直接在方法里面返回函数调用结果，但是请也必须对返回数据进行 Base64 编码之后再返回；
• 异步返回 ： 有些方法需要异步返回结果，可以在方法执行结束之后，把返回结果 Base64 编码之后直接调用 JS 的 notify 方法。

hybrid.notify("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "eyJuYW1lIjogInRpdGxlIn0=");

iOS 端调用不能直接拿到调用返回值：

window.webkit.messageHandlers._jh.postMessage('eyJuYW1lIjogInRpdGxlIn0=');

{
    RequestId   : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", // 唯一调用标识
    MethodName  : "getPlatformName", // 调用方法名称
    Params  : null | {}, // 要调用方法的参数
}

• RequestId ： 此标识能够代表 JS 的唯一请求，如果是异步方法调用，可以在异步方法完成后回调该标识；
• MethodName ： 要调用的方法名称，请参照接口文档进行实现；
• Params ： 要调用的方法的参数，可以为 Null 或者是一个 Object 类型，为 Null 代表没有参数，反之则 Object 中的每一个 Key 代表一个参数项；
• 异步返回 ： iOS 不能同步返回调用结果，但是可以在方法执行结束之后，把返回结果以 Base64 编码之后直接调用 JS 的 notify 方法。

hybrid.notify("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "eyJuYW1lIjogInRpdGxlIn0=");

---

交互消息通知

在很多 App 场景下，H5 页面在运行过程中也需要根据系统运行状态及时的发生改变，但是 H5 没有后台运行的能力，这会导致在有些业务流程中，跳转到了原生界面进行信息采集，但是采集之后的信息需要在不刷新 H5 页面的情况下返回给 H5 界面进行显示，这时候就需要 Android/iOS 原生客户端具备能够及时通知 JS 更新内容的能力。

为了解决这个问题，JS 向原生客户端公开如下方法调用，共接收两个参数：

hybrid.notify(event/* string */, params/* string */);

• event 代表事件名称，可查阅事件通知文档，了解事件名称的含义与携带的参数列表。
• params 代表事件携带的参数，这是一个经过 Base64 编码之后的字符串，前段开发者可查阅事件通知文档，了解具体的使用方法。

如果客户端想要主动通知 H5 更新页面的话，可以随时调用 JS 的 jh.notify 方法，并把要投递的消息参数给编码好即可，由 JS 自行决定消息应该怎么处理。