WebView与APP交互实战记录

WebView与APP交互

WebView与APP交互,即网页通过JSBrige调用APP的功能,APP也可以通过JSBrige调用网页提供的方法。最近刚好接触到这一块,记录一下前端侧的实际操作过程,这篇文章适合还没接触过这一块的同学们,这里不讲原理,直接开始实战的过程。

准备工作

与客户端同学沟通好使用的JSBrige库,我这里使用的是下面这两个库:

iOS(1.1w+ Star): https://github.com/marcuswestin/WebViewJavascriptBridge

Android(6k+ Star): https://github.com/lzyzsd/JsBridge

Star数量比较高,使用的企业也比较多,所以还是比较可靠的,可以在它们的文档中示例代码。

注意: github上有很多这样的库,但最好配套使用,即iOS和Android注入的jsBrige名称一致,我们前端使用时比较方便统一。

开发步骤

1. 统一封装APP注入的JSBrige

ios和android注入的jsbrige可能会有些差异,所以在使用前我们需要抹平不同客户端的差异。
如果app的同学使用了上面说的库,安卓和iOS会在WebView中的window下注入一个WebViewJavascriptBridge的对象,iOS有可能是注入WVJBCallbacks的数组,也有可能需要通过iframe来注入。iOS的文档中给出了一个兼容的示例代码:

function setupWebViewJavascriptBridge(callback) {
    if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
    if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
    window.WVJBCallbacks = [callback];
    var WVJBIframe = document.createElement('iframe');
    WVJBIframe.style.display = 'none';
    WVJBIframe.src = 'https://__bridge_loaded__';
    document.documentElement.appendChild(WVJBIframe);
    setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}

我们可以直接使用上面的代码,为了使用方便,在页面onload后,我们将这个函数挂在window下:

window.onload = function () {
  function setupWebViewJavascriptBridge(callback) {
    if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
    if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
    window.WVJBCallbacks = [callback];
    var WVJBIframe = document.createElement('iframe');
    WVJBIframe.style.display = 'none';
    WVJBIframe.src = 'https://__bridge_loaded__';
    document.documentElement.appendChild(WVJBIframe);
    setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
  }
  window.setupWebViewJavascriptBridge = setupWebViewJavascriptBridge
}

window.setupWebViewJavascriptBridge这个函数,就是我们所说的JSBridge,即WebView与APP交互的桥梁。

2. JS调用APP的方法

APP端的同学需要先用库提供的方法在APP端实现一个方法,方法名比如:playMusic(musicId),可以传递参数musicId,表示让APP开始播放某一首音乐。js调用时如:

window.setupWebViewJavascriptBridge(function (bridge) {
        bridge.callHandler('playMusic', { musicId: 1 }, function (data) {
          console.log('app触发成功了,音乐正在播放。。。APP回调返回的数据:', data)
        })
      })

上面相当于向app发起了一个playMusic请求,app收到请求后,执行相关的动作,然后可以callback,网页可以拿到回调并继续做相关动作(需要的话)。

3. APP调JS提供的方法

同样的道理,若想APP能调用JS提供的方法,JS中要先注册这个方法,方法名比如stateChange(state),JS注册方法:

window.setupWebViewJavascriptBridge(function (bridge) {
  bridge.registerHandler('stateChange', function (data, responseCallback) {
    console.log('收到APP请求stateChange事件,请求的数据是:', data)
    // 可以返回给app一个回调
    responseCallback('朕已经收到APP爱卿的请求了,且退下!')
  })
})

到这里,WebView与app的交互其实就完成了,就是这么简单。

注意事项

1. window.onload时就callHandler可能不成功

一般在Android中会出现这个问题,这是因为APP注入的WebViewJavascriptBridge还不存在,JS就调用其中的方法了,所以就会没有效果。而Android的库也给出了这个注意事项,所以得这样写:

window.onload = function () {
  function registerAppEvent () {
    window.setupWebViewJavascriptBridge(function (bridge) {
      bridge.registerHandler('stateChange', function (data, responseCallback) {
        console.log('收到APP请求,请求的数据是:', data)
        // 可以返回给app一个回调
        responseCallback('朕已经收到APP爱卿的请求了,且退下!')
      })
    })
  }

  // 兼容写法 
  if (window.WebViewJavascriptBridge) {
    registerAppEvent()
  } else {
    document.addEventListener(
        'WebViewJavascriptBridgeReady'
        , function() {
            registerAppEvent()
        },
        false
    )
  }
}

但这里没有考虑到iOS的情况,在最新的iOS中WebViewJavascriptBridge可能是不存在的,所以上面写法registerAppEvent()在iOS可能无法执行。为了避免多次注入事件,我这里用了setTimeout,兼容两端的流程:

  let isInitBridgeEvent = false // 作为是否已注册过事件的标记
  if (window.WebViewJavascriptBridge) {
    registerAppEvent()
    isInitBridgeEvent = true
  } else {
    document.addEventListener(
      'WebViewJavascriptBridgeReady',
      function () {
        registerAppEvent()
        isInitBridgeEvent = true
      },
      false
    )
    // 如果还没注册则再注册一次
    setTimeout(() => {
      if (!isInitBridgeEvent) {
        registerAppEvent()
        isInitBridgeEvent = true
      }
    }, 100)

这坨代码写的很挫,让我尴尬癌都犯了,有没有热心的小伙伴帮我优化下写法[送花花]。

2. js调用安卓后callback回调不成功,js收不到app返回的消息

这个问题其实github上有issue,这是安卓1.0.4版本没有解决的问题,最新的代码已经解决了。
解决办法是:安卓需要引入最新的master的代码,而不要使用1.0.4版本的代码。

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

推荐阅读更多精彩内容

  • 原文地址 前言 Web 页面中的 JS 与 iOS Native 如何交互是每个 iOS 猿必须掌握的技能。而 J...
    小嘴冰凉别乱亲阅读 1,848评论 2 5
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,987评论 4 60
  • 1.栈的定义 栈是一种特殊的线性表。其特殊性在于限定插入和删除数据元素的操作只能在线性表的一端进行 结论:后进先出...
    西西里的姑娘阅读 438评论 0 0
  • 站在一楼看外面,都是细节,自己附近的那点东西,市井吵架,违章停车。 站在十楼看外面,能看到局部,细节慢慢消失,轮廓...
    马首阅读 1,261评论 0 0
  • 1.关于写作资源库,想了想自己确实引用不到太多。平时看小说更多是为了看情节,几乎都是一本书读一遍那种。看到写得好的...
    库小花阅读 204评论 3 0