zoukankan      html  css  js  c++  java

  • JSBridge深度剖析

    概述

    做过混合开发的人都知道Ionic和PhoneGap之类的框架，这些框架在web基础上包装一层Native。然后通过Bridge技术的js调用本地的库。

    在讲JSBridge技术之前。我们来看一下传统的实现方式。

    Android端

    Native调JS

    native调用js比較简单，仅仅要遵循：”javascript: 方法名(‘參数,须要转为字符串’)”的规则就可以。

    在4.4之前，调用的方式：

    // mWebView = new WebView(this);            
mWebView.loadUrl("javascript: 方法名('參数,须要转为字符串')"); 

//ui线程中运行
 runOnUiThread(new Runnable() {  
        @Override  
        public void run() {  
            mWebView.loadUrl("javascript: 方法名('參数,须要转为字符串')");  
            Toast.makeText(Activity名.this, "调用方法...", Toast.LENGTH_SHORT).show();  
        }  
});

    4.4以后(包含4.4)。使用下面方式：

    mWebView.evaluateJavascript("javascript: 方法名('參数,须要转为字符串')", new ValueCallback() {
        @Override
        public void onReceiveValue(String value) {
            //这里的value即为相应JS方法的返回值
        }
});

    说明：

    • 4.4之前Native通过loadUrl来调用JS方法,仅仅能让某个JS方法运行,可是无法获取该方法的返回值
    • 4.4之后,通过evaluateJavascript异步调用JS方法,而且能在onReceiveValue中拿到返回值
    • 不适合传输大量数据(大量数据建议用接口方式获取)
    • mWebView.loadUrl(“javascript: 方法名(‘參数,须要转为字符串’)”);函数需在UI线程运行，由于mWebView为UI控件

    JS调Native

    Js调用Native须要对WebView设置@JavascriptInterface注解，这里有个漏洞。后面会给大家说明。

    要想js能够Native，须要对WebView设置下面属性。

    WebSettings webSettings = mWebView.getSettings();  
 //Android容器同意JS脚本
webSettings.setJavaScriptEnabled(true);
//Android容器设置侨连对象
mWebView.addJavascriptInterface(getJSBridge(), "JSBridge");

    这里我们看到了getJSBridge()。Native中通过addJavascriptInterface加入暴露出来的JS桥对象,然后再该对象内部声明相应的API方法。

    private Object getJSBridge(){  
    Object insertObj = new Object(){  
        @JavascriptInterface
        public String foo(){  
            return "foo";  
        }  

        @JavascriptInterface
        public String foo2(final String param){  
            return "foo2:" + param;  
        }  

    };  
    return insertObj;  
}

    那么Html怎么调用Native的方法呢？

    //调用方法一
window.JSBridge.foo(); //返回:'foo'
//调用方法二
window.JSBridge.foo2('test');//返回:'foo2:test'

    说明：

    • 在Android4.2以上(api17后),暴露的api要加上注解@JavascriptInterface，否则会找不到方法。

    • 在api17曾经,addJavascriptInterface有风险,hacker能够通过反编译获取Native注冊的Js对象。然后在页面通过反射Java的内置 静态类。获取一些敏感的信息和破坏
    • JS调用Native暴露的api,而且能得到相应返回值

    注：说到WebView中接口隐患的问题，这里大家能够參考WebViw漏洞利用，只是Android发展到如今，这个漏洞基本没有了。

    iOS端

    Native调JS

    Native调用js的方法比較简单。Native通过stringByEvaluatingJavaScriptFromString调用Html绑定在window上的函数。只是应注意Oc和Swift的写法。

    //Swift
webview.stringByEvaluatingJavaScriptFromString("方法名(參数)")
//OC
[webView stringByEvaluatingJavaScriptFromString:@"方法名(參数);"];

    说明：

    • Native调用JS方法时,能拿到JS方法的返回值
    • 不适合传输大量数据(大量数据建议用接口方式获取)

    JS调Native

    Native中通过引入官方提供的JavaScriptCore库(iOS7以上),然后能够将api绑定到JSContext上(然后Html中JS默认通过window.top.*可调用)。

    引入官方的库文件

    #import <JavaScriptCore/JavaScriptCore.h>

    Native注冊api函数(OC)

    -(void)webViewDidFinishLoad:(UIWebView *)webView{
    [self hideProgress];
    [self setJSInterface];
}

-(void)setJSInterface{

    JSContext *context =[_wv valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

    // 注冊名为foo的api方法
    context[@"foo"] = ^() {

        //获取參数
        NSArray *args = [JSContext currentArguments];
        NSString *title = [NSString stringWithFormat:@"%@",[args objectAtIndex:0]];
        //做一些自己的逻辑
        //返回一个值  'foo:'+title
        return [NSString stringWithFormat:@"foo:%@", title];
    };    
}

    Html中JS调用Native方法

    window.top.foo('test');

    说明：

    • iOS7才出现这样的方式,在这之前,js无法直接调用Native,仅仅能通过JSBridge方式简单介绍调用
    • JS能调用到已经暴露的api,而且能得到相应返回值
    • iOS原生本身是无法被JS调用的,可是通过引入官方提供的第三方”JavaScriptCore”,就可以开放api给JS调用

    JSBridge

    什么是JSBridge

    JSBridge：听其取名就是js和Native之前的桥梁，而实际上JSBridge确实是JS和Native之前的一种通信方式。简单的说，JSBridge就是定义Native和JS的通信,Native仅仅通过一个固定的桥对象调用JS,JS也仅仅通过固定的桥对象调用Native。JSBridge还有一个叫法及大家熟知的Hybrid app技术。

    这里写图片描写叙述

    流程：H5->通过某种方式触发一个url->Native捕获到url,进行分析->原生做处理->Native调用H5的JSBridge对象传递回调。

    我们前面讲过了原生的WebView/UIWebView控件已经能够和Js实现数据通信了。那为什么还要JSBridge呢？
    事实上使用JSBridge有非常多方面的考虑：

    • Android4.2下面,addJavascriptInterface方式有安全漏掉
    • iOS7下面,JS无法调用Native
    • url scheme交互方式是一套现有的成熟方案,能够完美兼容各种版本号。对曾经老版本号技术的兼容。

    url scheme

    url scheme是一种相似于url的链接,是为了方便app直接互相调用设计的。详细来讲假设是系统的url scheme,则打开系统应用,否则找看是否有app注冊这样的scheme,打开相应app。
    注：这样的scheme必须原生app注冊后才会生效。

    而在我们实际的开发中，app不会注冊相应的scheme,而是由前端页面通过某种方式触发scheme(如用iframe.src),然后Native用某种方法捕获相应的url触发事件,然后拿到当前的触发url,依据定义好的协议,分析当前触发了那种方法。

    JSBridge技术实现

    要实现JSBridge,我们须要按下面步骤分析：

    • 第一步:设计出一个Native与JS交互的全局桥对象
    • 第二步:JS怎样调用Native
    • 第三步:Native怎样得知api被调用
    • 第四步:分析url-參数和回调的格式
    • 第五步:Native怎样调用JS
    • 第六步:H5中api方法的注冊以及格式

    JSBridge的完整流程可总结为：
    这里写图片描写叙述

    设计Native与JS交互的全局桥对象

    我们规定,JS和Native之间的通信必须通过一个H5全局对象JSbridge来实现。该对象有例如以下特点：
    该对象名为”JSBridge”，是H5页面中全局对象window的一个属性。形如：

    var JSBridge = window.JSBridge || (window.JSBridge = {});

    该对象有例如以下方法：

    • registerHandler( String,Function )H5调用注冊本地JS方法,注冊后Native可通过JSBridge调用。

      调用后会将方法注冊到本地变量messageHandlers 中。

    • callHandler( String,JSON,Function )H5调用 调用原生开放的api,调用后实际上还是本地通过url scheme触发。调用时会将回调id存放到本地变量responseCallbacks中
    • _handleMessageFromNative( JSON )Native调用 原生调用H5页面注冊的方法,或者通知H5页面运行回调方法

    这里写图片描写叙述

    JS调用Native

    我们定义好了全局桥对象,能够通过它的callHandler方法来调用原生的api。

    callHandler函数内部实现过程

    在运行callHandler时,内部经历了下面步骤:

    1. 推断是否有回调函数,假设有,生成一个回调函数id,并将id和相应回调加入进入回调函数集合responseCallbacks中。
    2. 通过特定的參数转换方法,将传入的数据,方法名一起,拼接成一个url scheme
    //url scheme的格式如
//基本实用信息就是后面的callbackId,handlerName与data
//原生捕获到这个scheme后会进行分析
var uri = CUSTOM_PROTOCOL_SCHEME://API_Name:callbackId/handlerName?data
    1. 使用内部早就创建好的一个隐藏iframe来触发scheme
    //创建隐藏iframe过程
var messagingIframe = document.createElement('iframe');
messagingIframe.style.display = 'none';
document.documentElement.appendChild(messagingIframe);

//触发scheme
messagingIframe.src = uri;

    注：正常来说是能够通过window.location.href达到发起网络请求的效果的。可是有一个非常严重的问题，就是假设我们连续多次改动window.location.href的值，在Native层仅仅能接收到最后一次请求，前面的请求都会被忽略掉。

    所以JS端发起网络请求的时候，须要使用iframe。这样就能够避免这个问题。

    Native通知api被调用

    上一步。我们已经成功在H5页面中触发scheme,那么Native怎样捕获scheme被触发呢？

    依据系统不同,Android和iOS分别有自己的处理方式。

    Android

    在Android中(WebViewClient里),通过shouldoverrideurlloading能够捕获到url scheme的触发。

    public boolean shouldOverrideUrlLoading(WebView view, String url){
    //假设返回false。则WebView处理链接url。假设返回true，代表WebView依据程序来运行url
    return true;
}

    iOS

    iOS中,UIWebView有个特性：在UIWebView内发起的全部网络请求，都能够通过delegate函数在Native层得到通知。

    这样,我们能够在webview中捕获url scheme的触发(原理是利用 shouldStartLoadWithRequest)

    - (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    NSURL *url = [request URL];

    NSString *requestString = [[request URL] absoluteString];
    //获取利润url scheme后自行进行处理

    分析url-參数和回调的格式

    在前面的步骤中,Native已经接收到了JS调用的方法,那么接下来,原生就应该依照定义好的数据格式来解析数据了，Native接收到Url后,能够依照这样的格式将回调參数id、api名、參数提取出来,然后按例如以下步骤进行。

    1. 依据api名,在本地找寻相应的api方法,而且记录该方法运行完后的回调函数id
    2. 依据提取出来的參数,依据定义好的參数进行转化
    3. 原生本地运行相应的api功能方法
    4. 功能运行完成后,找到这次api调用相应的回调函数id,然后连同须要传递的參数信息,组装成一个JSON格式的參数
    5. 通过JSBridge通知H5页面回调

    Native调用JS

    到了这一步,就该Native通过JSBridge调用H5的JS方法或者通知H5进行回调了。当中的messageJSON数据格式依据两种不同的类型。

    JSBridge._handleMessageFromNative(messageJSON);

    Native通知H5页面进行回调：
    数据格式为: Native通知H5回调的JSON格式。
    Native主动调用H5方法：
    Native主动调用H5方法时,数据格式是:{handlerName:api名,data:数据,callbackId:回调id}：

    • handlerName String型 须要调用的,h5中开放的api的名称
    • data JSON型 须要传递的数据,固定为JSON格式(由于我们固定H5中注冊的方法接收的第一个參数必须是JSON,第二个是回调函数)
    • callbackId String型 原生生成的回调函数id,h5运行完成后通过url scheme通知原生api成功运行,并传递參数

    H5中api方法的注冊以及格式

    前面有提到Native主动调用H5中注冊的api方法,那么h5中怎么注冊供原生调用的api方法呢？

    JSBridge.registerHandler('testH5Func',function(data,callback){
    alert('測试函数接收到数据:'+JSON.stringify(data));
    callback&&callback('測试回传数据...');
});

    如上代码,当中第一个data即原生传过来的数据,第二个callback是内部封装过一次的,运行callback后会触发url scheme,通知原生获取回调信息.

    完好JSBridge方案

    github上有一个开源项目,它里面的JSBridge做法在iOS上进一步优化了,所以參考他的做法,这里进一步进行了完好。地址marcuswestin/WebViewJavascriptBridge

    JSBridge对象图解:
    这里写图片描写叙述

    JSBridge实现完整流程:
    这里写图片描写叙述

    总结

    那么我们在实际的开发中，怎样针对Android和iOS的不同情况,统一出一种完整的方案。


    这里写图片描写叙述

    另类实现：不採用url scheme方式

    前面提到的JSBridge都是基于url scheme的,但事实上假设不考虑Android4.2下面,iOS7下面,事实上也能够用还有一套方案的。

    • Native调用JS的方法不变
    • JS调用Native是不再通过触发url scheme,而是採用自带的交互
      详细来讲：
      Android中,原生通过 addJavascriptInterface开放一个统一的api给JS调用,然后将触发url scheme步骤变为调用这个api,其余步骤不变。

    OS中,原生通过JavaScriptCore里面的方法来注冊一个统一api,其余和Android中一样。
  • 相关阅读:
    form表单提交后保持输入的值
    django 自定义属性
    linux修改mysql密码
    linux下备份mysql数据库
    《小学数学辅导》服务协议
    《小升初辅导》服务协议
    《小学数学试题练习》服务协议
    清明节应该回高中学校扫扫墓，因为那里埋葬了你的青春。
    [转]智能聊天机器人小黄鸡及其制作方法
    人们问我，长大了要做什么？我写下“快乐”，他们说我理解错了题目。我告诉他们，他们理解错了人生。—— 约翰·列侬
  • 原文地址：https://www.cnblogs.com/yjbjingcha/p/7390899.html
Copyright © 2011-2022 走看看