无标题文章

---

date: 2016-10-16 11:11

status: public

title: 开始众筹Web与Native交互通讯协议规范(暂行)

version: 1.0

---

#开始众筹Web(H5)与Native交互通讯协议规范(暂行)

##一、简介

为实现Web与Native的交互,现 Web,IOS,Android 三端统一使用该协议进行交互,其原理是Native通过WebView组件和Web之间进行属性的传递,方法的调用。Native通过相关方法 如OC的 stringByEvaluatingJavaScriptFromString 获取JS返回的结果 实现 Native->Web的通讯,而Web通过Native向浏览器的Window对象注入方法或属性来实现相关交互。

##二、命名规范

### 1. 三方均使用驼峰小驼峰命名法 如 方法 getUserInfo 属性 userInfo

### 2. 三方交互的方法 均注入到 Window.native 中

### 3. 三方返回值必须严格约定返回值的类型

~~~

Web中项目有语法检查 所以 返回值 是字符串还是数字要有相应说明 一般传值以Object或者字符串形式,返回值也同样。

在Web中 我们项目判断使用 === 进行判断的 所以 1 === ‘1’ 是false 这点需要注意

~~~

##三、用户信息的传递

### 1. 登录注册的情况

App端打开之后 通过 Web提供的借口方法 window.native.setNativeStorage 将用户信息写到

localStorage里 约定localStorage的用户key为 userinfo

### 2. token过期或登出的情况

token过期 需要续租的情况 请将续租后的新信息 重新写入到nativeUserInfo里

登出 请 直接清空 userinfo 的信息

### 3. 用户信息更新的情况

用户信息更新后 请更新 userinfo

##四、协议类型的约定

### 1. 项目跳转类

协议约定: kaishiba://www.kaistart.com/project?id='123'

Web端的链接使用 该约定协议 Native端拦截到ID 跳到相应项目页

### 2. 特殊跳转类

协议约定 kaishiba://www.kaistart.com/specail?id=''

Web端根据具体情况定义 specail后面的参数 Native端做出相应处理

### 3. 方法调用类

三方均将方法注入到浏览器中的window.native 或者 window.KaiJsBridge中

然后调用公共接口的方法,具体可以看 五 六

##五、Web 调用 Native

1. Native将封装好的方法 注入到 window.KaiJsBridge 中

2. Web可以获取到window.KaiJsBridge下的方法 传递相关参数

3. Native拦截到方法 做出相应处理

示例:

以之前活动报名的分享为例

> Native将封装好的share方法注入到 window.native下

> Js这时候可以在window对象中获取到 share方法

> window.native.share(id, desc, title, pic) 将参数调用方法传递过去

> Native收到相应方法以及参数 做相应处理

> 以上完成了 Web->Native的 单项通信

支付示例(伪代码)

1. 约定 pay() 为调起参数的方法名 参数为 itemid, price

2. Native 写好相应方法 注入到window.native下

3. js调起 window.native.pay(itemid, price)

4. Native 处理相关内容

5. 支付完成后 Native回调 Js的相关内容 参见 六 中的示例

##六、Native 调用 Web

原理和 五 一样 Web将方法注入到window.native 或者 window.KaiJsBridge中

Native直接调用Js的相关方法,并传递相关参数,执行js的相关内容。

示例:

1. js约定 payCallback(itemid, res) 为支付完成后 Native调去Js的方法

2. payCallback(item, res)

{

if (!res) return false;

window.localhost.href = 'http://www.kaistart.com'

}

3. Native支付完成后 调去 js中的  window.native.payCallBack 并传递相关参数

4. 示例中如果支付成功 则跳转到 www.kaistart.com

5. 至此完成了 Native调用Web的相关方法

##七、 说明

本文档仅做现阶段开发参考,日后会根据需求三方协商并修订文档。

##八、另见 接口文档

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

推荐阅读更多精彩内容

  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 3,219评论 0 4
  • spring官方文档:http://docs.spring.io/spring/docs/current/spri...
    牛马风情阅读 1,653评论 0 3
  • 1.要做一个尽可能流畅的ListView,你平时在工作中如何进行优化的? ①Item布局,层级越少越好,使用hie...
    fozero阅读 714评论 0 0
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,690评论 0 9
  • # MVC ​框架的所有代码结构整合都是采用MVC的基础架构,这也是苹果iOS系统的基本架构。Controller...
    keldonwang阅读 313评论 0 0