聊一聊 webview 与 JS 交互方案 - 适用 Android & iOS
JayBacon
7年前
<p><strong>webview 与 JS 交互分为两种：</strong></p> <ul> <li>Android & iOS 调用 JS 的方法</li> <li>JS 调用 Android & iOS 的方法</li> </ul> <p><strong>Android & iOS 调用 JS 的方法，伪代码如下：</strong></p> <ul> <li> <p>Android</p> <pre> <code class="language-javascript">webView.loadUrl("javascript:show('xxx');");</code></pre> </li> <li> <p>iOS</p> <pre> <code class="language-javascript">NSString *result = [self.webView stringByEvaluatingJavaScriptFromString:@"showReturn('xxx');"];</code></pre> </li> </ul> <p>webview 调用 JS 的方法比较简单， show('xxx') 方法是 JS 中定义的一个方法：</p> <pre> <code class="language-javascript"><script language=javascript> function show(str) { alert(str); } function showReturn(str) { return "result"; } </script></code></pre> <p>这种方式，缺陷很明显：</p> <ol> <li> <p>Android 没法拿到返回值；但是，iOS是可以拿到返回值的，这是最重要的区别！！！另外，我们也无法传递一个回调接口 Callback 用于回调，也就是说此方法调用成功与否，是无法知道的。</p> </li> <li> <p>show 方法必须是 JS 中存在的，即使不存在你调用了也不会报错；另外，随着业务的增长，我们不得不增加许许多多类似 show 的方法，来处理其他业务。</p> </li> </ol> <p><strong>JS 调用 Android & iOS 的方法，伪代码如下：</strong></p> <ul> <li> <p>Android</p> <pre> <code class="language-javascript">private class JsToNative { // 没有返回结果 @JavascriptInterface public void jsMethod(String paramFromJS) { } // 有返回结果 @JavascriptInterface public String jsMethodReturn(String paramFromJS) { return "your result"; } } // JsToNative就是一个别名，你可以随意 webView.addJavascriptInterface(new JsToNative(), "JsToNative");</code></pre> <p>JS 调用 Android</p> <pre> <code class="language-javascript">// 没有返回结果 var paramFromJS = "xxx"; window.JsToNative.jsMethod(paramFromJS); // 有返回结果 var returnResult = window.JsToNative.jsMethodReturn(paramFromJS);</code></pre> </li> <li> <p>iOS</p> <p>两种方式：</p> <ul> <li>JS 里面直接调用方法</li> <li>JS 里面通过对象调用方法</li> </ul> </li> </ul> <p>方式一：JS 里面直接调用方法</p> <pre> <code class="language-javascript">- (void)webViewDidFinishLoad:(UIWebView *)webView { JSContext *context = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"]; context[@"jsMethod"] = ^() { NSArray *args = [JSContext currentArguments]; for (id obj in args) { NSLog(@"%@",obj); } } context[@"jsMethodReturn"] = ^() { return "your result"; } }</code></pre> <p>JS 调用 iOS</p> <pre> <code class="language-javascript">// 没有返回结果 var paramFromJS = "xxx"; jsMethod(paramFromJS); // 有返回结果 var returnResult = jsMethodReturn(paramFromJS);</code></pre> <p>方式二：JS 里面通过对象调用方法</p> <p>这种方式需要使用到 JSExport 协议，类似Android的 @JavascriptInterface 注解。</p> <p>由于篇幅原因，这里不做详细讲解，感兴趣的同学可以参考： <a href="/misc/goto?guid=4959728498349534387" rel="nofollow,noindex">这里</a> 。</p> <p>小结：</p> <ol> <li>JS 都可以从 Android 和 iOS 方法拿到返回值，不存在Android 调用 JS 无法拿到返回值的情况。</li> <li>弊端和前面类似，JS 事先需要知道 Android 和 iOS 的方法名（参数等）；另外，随着业务的增长，我们不得不增加更多的方法，来处理其他业务。</li> </ol> <p><strong>思考：</strong></p> <ol> <li>如何避免 JS、Android、iOS 相互调用时，需要事先“约定”方法名称和参数？</li> <li>原生调用 JS 方法，能否类似原生开发一样，使用 Callback（block） 做为回调方式？</li> <li>JS 调用原生能否使用 function 获得返回值?</li> </ol> <p><strong>iOS/OSX - WebViewJavascriptBridge</strong></p> <p>这是 marcuswestin 公司开源的一个用于 iOS/OSX 平台 webview 与 JS 通信的方案，它在 webview 和 JS 之间“架了”一座桥梁，提供了非常便捷的通信方式，引用官方的介绍：</p> <p>An iOS/OSX bridge for sending messages between Obj-C and JavaScript in UIWebViews/WebViews</p> <p>此项目的 <strong>star</strong> 数量达到 <strong>7600+</strong> ，可见受欢迎程度非常高，而且据说还有很多大公司的项目在使用，包括：</p> <ul> <li><a href="/misc/goto?guid=4958545932519289081" rel="nofollow,noindex">非死book Messenger</a></li> <li><a href="/misc/goto?guid=4959637082174678739" rel="nofollow,noindex">非死book Paper</a></li> <li><a href="/misc/goto?guid=4959728498502088643" rel="nofollow,noindex">Yardsale</a></li> <li><a href="/misc/goto?guid=4959637082328375490" rel="nofollow,noindex">EverTrue</a></li> <li><a href="/misc/goto?guid=4959637082408235978" rel="nofollow,noindex">Game Insight</a></li> <li><a href="/misc/goto?guid=4959728498648283260" rel="nofollow,noindex">Sush.io</a></li> <li><a href="/misc/goto?guid=4959728498731847845" rel="nofollow,noindex">Imbed</a></li> <li><a href="/misc/goto?guid=4959728498811174903" rel="nofollow,noindex">CareZone</a></li> <li><a href="/misc/goto?guid=4959728498895462860" rel="nofollow,noindex">Hemlig</a></li> <li><a href="/misc/goto?guid=4959728498979023059" rel="nofollow,noindex">Altralogica</a></li> <li><a href="/misc/goto?guid=4959637082654333146" rel="nofollow,noindex">鼎盛中华</a></li> <li><a href="/misc/goto?guid=4959728499098855139" rel="nofollow,noindex">FRIL</a></li> <li><a href="/misc/goto?guid=4959728499173658937" rel="nofollow,noindex">留白·WHITE</a></li> <li><a href="/misc/goto?guid=4959728499257981087" rel="nofollow,noindex">BrowZine</a></li> </ul> <p>这个开源项目的用法也非常简单，简单的示例如下：</p> <ol> <li> <p>注册handler</p> <p>Obj-C中注册handler，给JS调用：</p> <pre> <code class="language-javascript">self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView]; [self.bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) { // 收到JS的调用 NSLog(@"testObjcCallback called: %@", data); // 回调结果给JS responseCallback(@"Response from testObjcCallback"); }];</code></pre> <p>JS中注册handler，给Obj-C调用（JS代码）：</p> <pre> <code class="language-javascript">bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) { // 收到Obj-C的调用 log('ObjC called testJavascriptHandler with', data) var responseData = { 'Javascript Says':'Right back atcha!' } log('JS responding with', responseData) // 回调结果给Obj-C responseCallback(responseData) })</code></pre> </li> <li> <p>根据第一步注册的 handler ，发送消息</p> <p>第一步注册的 handler 有两个： testObjcCallback 和 testJavascriptHandler</p> <p>Obj-C调用JS：</p> <pre> <code class="language-javascript">[self.bridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) { NSLog(@"testJavascriptHandler responded: %@", response); }];</code></pre> <p>JS调用Obj-C：</p> <pre> <code class="language-javascript">bridge.callHandler('testObjcCallback', {'foo': 'bar'}, function(response) { log('JS got response', response) })</code></pre> </li> </ol> <p>使用起来很简单，主要就是使用 registerHandler 来注册 callback（block） ，然后使用 callHandler 来调用注册的 callback（block） 。</p> <p>Obj-C与JS互调，传递数据的格式为String，建议使用JSON格式，这样更易于数据的交互。</p> <p>iOS/OSX平台有这样的Obj-C与JS交互方案，如果Android平台也有类似的方案，岂不是更加完美？</p> <p><strong>Android - JsBridge</strong></p> <p>感谢开源的力量，已经有人给出了类似的解决方案：</p> <p>阅读完整个开源项目之后，我惊讶的发现，关于 <strong>jsBridge</strong> 的设计居然和上文介绍的 <strong>WebViewJavascriptBridge</strong> 几乎一模一样。</p> <p>唯一，也是最明显的一个区别，就是为了解决我们本文开始遇到的问题：</p> <p>Android & iOS 调用 JS 的方法 - Android 没法拿到返回值；但是，iOS是可以拿到返回值的。</p> <p>为了解决这个问题，作者使用了 <strong>webview url</strong> 自定义的 <strong>schema</strong> ，然后截取数据并拦截请求。</p> <p>jsBridge差异部分，关键代码如下：</p> <ul> <li> <p>iOS - jsBridge</p> <pre> <code class="language-javascript">function _fetchQueue() { var messageQueueString = JSON.stringify(sendMessageQueue); sendMessageQueue = []; return messageQueueString; }</code></pre> </li> <li> <p>Android - jsBridge</p> <pre> <code class="language-javascript">function _fetchQueue() { var messageQueueString = JSON.stringify(sendMessageQueue); sendMessageQueue = []; // return messageQueueString; // Android无法直接返回数据, 这是与iOS最大的区别; 所以, 需要使用自定义url形式返回数据。 messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://return/_fetchQueue/' + encodeURIComponent(messageQueueString); }</code></pre> </li> </ul> <p>另外， <strong>jsBridge</strong> 的“加载时机”也有所不同，差异代码如下：</p> <ul> <li style="text-align:center"> <p>iOS - WebViewJavascriptBridge</p> <pre> <code class="language-javascript">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 = 'wvjbscheme://__BRIDGE_LOADED__'; document.documentElement.appendChild(WVJBIframe); setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0) }</code></pre> <p>iOS中，需要在你的web页面的JS脚本中执行这么一段方法，然后在UIWebView的代理方法 shouldStartLoadWithRequest 拦截 wvjbscheme://__BRIDGE_LOADED__ 类型的URL，然后加载 jsBridge：</p> <img src="https://simg.open-open.com/show/06f49ec32868c3abe4eb6dac58c29fe5.png"> <p style="text-align:center">iOS - jsBridge.png</p> </li> <li> <p>Android - JsBridge</p> <p>而Android中，不需要在web页面引入那段JS方法；只需要在WebViewClient的 onPageFinished 方法中加载 jsBridge：</p> </li> </ul> <p style="text-align:center"><img src="https://simg.open-open.com/show/134ccc906ca9a6f9a547f581ca567f18.png"></p> <p style="text-align:center">Android - jsBridge.png</p> <p>很明显，Android 和 iOS 不同的平台需要在 web 页面引入的内容有所不一样；这样，会导致 web 页面开发人员需要根据不同的平台分别处理。</p> <p>既然，我们的初衷是想找到 Android 和 iOS 平台同时都适用的方案，就必须解决这个问题。</p> <p>为此，我改造了 大头鬼 的JsBridge库，Android 使用了和 iOS - WebViewJavascriptBridge 的一致的 jsBridge 文件，唯一修改的方法是 _fetchQueue() ，正如前面提到的，为了解决：</p> <p>Android & iOS 调用 JS 的方法 - Android 没法拿到返回值；但是，iOS是可以拿到返回值的。</p> <p>同时，需要和 iOS 一样，在 web 页面执行一段 JS 方法。其他使用方式基本保持不变，这里感谢 大头鬼 的代码。</p> <p>本来是从fork过来的代码，但是改动比较多，所以就不提交给原作者了。</p> <p>基本使用步骤和iOS的保持高度一致，简单示例如下：</p> <ol> <li> <p>注册handler</p> <p>Android中注册handler，给JS调用：</p> <pre> <code class="language-javascript">webView = (BridgeWebView) findViewById(R.id.webView); webView.registerHandler("testObjcCallback", new BridgeHandler() { @Override public void handler(String data, CallBackFunction function) { Log.i(TAG, "testObjcCallback called: " + data); function.onCallBack("Response from testObjcCallback"); } });</code></pre> <p>JS中注册handler，给Android调用（JS代码）：</p> <pre> <code class="language-javascript">bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) { log('ObjC called testJavascriptHandler with', data) var responseData = { 'Javascript Says':'Right back atcha!' } log('JS responding with', responseData) responseCallback(responseData) })</code></pre> </li> <li> <p>根据第一步注册的 handler ，发送消息</p> <p>第一步注册的 handler 有两个： testObjcCallback 和 testJavascriptHandler</p> <p>Android调用JS：</p> <pre> <code class="language-javascript">webView.callHandler("testJavascriptHandler", "{\"foo\":\"before ready\"}", new CallBackFunction() { @Override public void onCallBack(String data) { } });</code></pre> <p>JS调用Android：</p> <pre> <code class="language-javascript">bridge.callHandler('testObjcCallback', {'foo': 'bar'}, function(response) { log('JS got response', response) })</code></pre> </li> </ol> <p>有了这样的两个库，可以很方便的让我们在Android和iOS平台与JS交互时，使用一致的通信方案，较少了前端同学很多的适配工作。同时，也更符合原生的开发习惯，并且忽略 jsBridge 层的存在。</p> <p>最后，附上两个库的地址</p> <ul> <li>改造后的JsBridge库: JsBridge</li> <li>iOS/OSX - WebViewJavascriptBridge库: WebViewJavascriptBridge</li> </ul> <p> </p> <p>来自：http://www.jianshu.com/p/c565c8f93abd</p> <p> </p>