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 自行决定消息应该怎么处理。




最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容

  • day07——循环嵌套&方法 2.1 循环控制语句 break关键字 break:词义:打破,打碎,破坏 用法一:...
    机会留给有准备的人阅读 188评论 0 0
  • 1.基本用法 在ES6之前,不能直接为函数的参数指定默认值,只能采用变通的方法。 上面代码检查函数log的参数y有...
    aaa8808dde01阅读 81评论 0 0
  • 关于函数的一些操作 回想一下java中方法的定义和调用 //java :求和 public int add(int...
    晚晚_e65f阅读 86评论 0 0
  • (一)JSP的回顾 一、什么是JSP JSP:JavaServerPages(Java服务器端页面) JS...
    请重置阅读 186评论 0 0
  • 1. LNMP应用环境 1.1 LNMP介绍 大约在2010年以前,互联网公司最常用的经典Web服务环境组合就是L...
    阿丧小威阅读 504评论 0 0