JsBridge使用和原理

What is JsBridge

近期在做一个项目,使用的是Native+H5的方式实现的。众所周知的是在Android中,Webview所实现的java与js的交互存在一些安全问题,并且这样的使用方式,没法让一套H5同时适配Android和iOS两个平台,因此,就需要有一个中间组件来实现js与本地的代码的交互,也就是JsBridge。

在Android平台我们选用了开源项目。整个库的结构也比较简单:一个用来注入的js文件,一个自定义的Webview(包括webViewClient),以及作为载体的BridgeHandler。

JsBridge的使用

在介绍JsBridge的原理之前,先简单介绍下JsBridge的使用,也可以看github上的表述。

JsBridge库集成

集成的方式有很多种:

  1. 使用作者推荐方式:
    repositories {  
        maven {url "https://jitpack.io"}  
    }  
    dependencies {  
        compile 'com.github.lzyzsd:jsbridge:1.0.4'
    }
  1. 使用源码集成
    下载源码,将源码拷贝至自己的工程内,作为工程的文件。
  2. 自定义Module
    下载源码,新建Module,将源码导入Module,并将项目依赖自定义的Module

使用JsBridge库

  • 提供操作给Js调用

      webView.registerHandler("submitFromWeb", new BridgeHandler(){
          @Override
          public void handler(String data, CallBackFunction function){
              function.onCallBack("submitFrom web exe, response data from java");
          }
      }
    

Js如果需要调用Java提供的方法时候,则需要调用这个Handler,而在注册时参数submitFromWeb将作为Js调用时使用的Key值。调用方式如下:

    WebViewJavascriptBridge.callHandler(
        'submitFromWeb',
        {'param':str1},
        function(responseData){
            //这里打印的应该是上面Handler实现方法中的callback的入参:submitFrom web exe, response data from java
            document.getElementById("show").innerHTML = "response data from java, data = "+responseData
        }
    )

另外,库也提供了一个简单的没有回调的调用方式:

    webView.setDefaultHandler(new DefaultHandler());

Js调用的方式也可以简化为:

    WebViewJavascriptBridge.send(
        data,
        function(responseData){
            //java中DefaultHandler所实现的方法中callback所定义的入参
        }
    )
  • 提供操作给Java调用
    注册方法与Java雷同:

      WebViewJavascriptBridge.registerHandler("functionInJs", function(data, responseCallback) {
          document.getElementById("show").innerHTML = ("data from Java: = " + data);
          var responseData = "Javascript Says Right back aka!";
          responseCallback(responseData);
      });
    

Java调用Handler时,也跟Js一样:

    webView.callHandler("functionInJs", new Gson().toJson(user),
        new CallBackFunction(){
            @Override
            public void onCallBack(String data){
            }
        }
    );

同样的,在JS中也可以注册默认的Handler,以方便Java调用时,通过send方法发送数据

    bridge.init(function(message, responseCallback) {
        console.log('JS got a message', message);
        var data = {
            'Javascript Responds': 'Wee!'
        };
        console.log('JS responding with', data);
        responseCallback(data);
    });

java调用send方法:

    webView.send("hello");

JsBridge使用原理

在讲JsBridge的实现之前,首先要讲下各个文件的作用:

  • WebViewJavascriptBridge.js     被注入到各个页面的js文件;提供初始化,注册Handler,调用Handler等方法。
  • WebViewJavascriptBridge.java    bridge接口文件,定义了发送信息的方法,由BridgeWebView来实现。
  • BridgeWebView.java         WebView的子类,提供了注册Handler,调用Handler等方法。
  • BridgeWebViewClient.java       WebViewClient的子类,重写了ShouldOverrideUrlLoading,onPageFinish,onPageStart等方法。
  • BridgeHandler.java          作为Java与Js交互的载体。Java&Js通过Handler的名称来找到响应的Handler来操作。
  • DefaultBridgeHandler.java      BridgeHandler的子类,不做任何操作。仅为Java提供默认的接收数据的Handler。
  • CallBackFunction.java        回调函数,Handler处理完成后,用来给Js发送消息。
  • Message.java             消息对象,用来封装与js交互时的json数据,callid,responseid等。
  • BridgeUtil.java            工具类,提供从Url中提取数据,获取回调方法,注入js等方法。

JsBridge调用过程

  1. Native初始化webview,注册Handler;加载页面完成后,将WebViewJavascriptBridge.js文件注入页面。查询消息队列是否有信息需要被接收。
  2. H5页面初始化,注册Handler,查询消息队列是否有信息需要别接收。
  3. 用户操作,H5调用本地功能:Js将消息内容放在sendMessageQueue中,并设置iframe的src为yy://__QUEUE_MESSAGE__/
  4. Webview设置的WebViewClient拦截到约定url,调用Webview的刷新消息队列的方法flushMessageQueue,此方法就是加载了一个url:javascript:WebViewJavascriptBridge._fetchQueue();,这也是Js中定义的方法,另外定义了一个回调;回调方法主要做了两件事:①判断Native是否为此返回数据保有响应回调操作,若有,则执行,若没有,则为判断callId,不为空时为这个callId初始化一个回调。②通过handlername判断是否为默认的Handler还是自定义的Handler,调用相应Handler的handler方法,入参为消息数据内容和第一步中定义的回调。【这段较为难消化,需要阅读代码来理解】
  5. Js中_fetchQueue设置了iframe的src,内容为:yy://return/_fetchQueue/+第二步中放入sendMessageQueue中的消息内容。
  6. WebViewClient拦截到url为yy://return/,调用WebView的handlerReturnData方法;通过url中定义的方法名,找到第四个步骤中定义的回调,并调用。回调方法走完后,删除此回调方法。
  7. 如果Js在调用Handler的时候设置了回调方法,也就是在第四步骤中的含有callId,就会调用queueMessage的方法,然后往下就是走Native给Js发送消息的步骤。
    Ps: Native给Js发送消息的步骤跟上述从第三步骤到第七步骤完全相同,只不过Native和Js对象调换位置即可。

JsBridge的核心

JsBridge之所以能实现Native与Js相互调用的功能,其核心实现其实就是:

  1. 拦截Url
  2. load url("javascript:js_method()");

先说第二点,Native调用Js,通过加载以javascript:开头的url即可实现调用Js的方法。这个很好理解,在web中也是通过这种方式调用Js的方法的。
然后细说下第一点的实现:

  1. 向body中添加一个不可见的iframe元素。通过拦截url的方法来执行相应的操作,但是页面本身不能跳转,所以改变一个不可见的iframe的src就可以让webview拦截到url,而用户是无感知的。
  2. 拦截url。通过shouldOverrideUrlLoading来拦截约定规则的Url,再做具体操作。
    Ps: 添加iframe是H5自身可实现的,但是如果H5来实现的话,需要每个页面实现,且耦合较高;因此放在库里,通过加载完成注入的方式,则会降低耦合

先就这么多~~
留个思考的问题:无论是js发送消息给Native,还是Native发送消息给Js,首先都会发送一个_fetchQueue,然后再发送return;那这两步是否可以合并成一步呢?

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

推荐阅读更多精彩内容