H5如何与原生App(ios,安卓,RN)通信？

关注前端公众号 前端每日一博&＃xff0c;每日为你分享一篇前端系列博文。永不断更&＃xff01;

前言

为了提高开发效率&＃xff0c;开发人员往往会使用原生app里面嵌套前端h5页面的快速开发方式&＃xff0c;这就要涉及到h5和原生的相互调用&＃xff0c;互相传递数据&＃xff0c;接下来就实践项目中的交互方式做一个简单的记录分享&＃xff0c;废话不多说&＃xff0c;直接上正文&＃xff1a;

由于安卓和ios的处理方式不一样&＃xff0c;所以我们要分开处理先贴上判断访问终端的代码


//判断访问终端
function browserVersion(){var u &＃61; navigator.userAgent;return {trident: u.indexOf(&＃39;Trident&＃39;) > -1, //IE内核presto: u.indexOf(&＃39;Presto&＃39;) > -1, //opera内核webKit: u.indexOf(&＃39;AppleWebKit&＃39;) > -1, //苹果、谷歌内核gecko: u.indexOf(&＃39;Gecko&＃39;) > -1 && u.indexOf(&＃39;KHTML&＃39;) &＃61;&＃61; -1,//火狐内核mobile: !!u.match(/AppleWebKit.*Mobile.*/), //是否为移动终端ios: !!u.match(/\(i[^;]&＃43;;( U;)? CPU.&＃43;Mac OS X/), //ios终端android: u.indexOf(&＃39;Android&＃39;) > -1 || u.indexOf(&＃39;Adr&＃39;) > -1, //android终端iPhone: u.indexOf(&＃39;iPhone&＃39;) > -1 , //是否为iPhone或者QQHD浏览器iPad: u.indexOf(&＃39;iPad&＃39;) > -1, //是否iPadwebApp: u.indexOf(&＃39;Safari&＃39;) &＃61;&＃61; -1, //是否web应该程序&＃xff0c;没有头部与底部weixin: u.indexOf(&＃39;MicroMessenger&＃39;) > -1, //是否微信 &＃xff08;2015-01-22新增&＃xff09;qq: u.match(/\sQQ/i) &＃61;&＃61; " qq" //是否QQ};

通信原理之先了解webview

IOS容器在IOS客户端中&＃xff0c;我们首先要提到的是一个叫UIWebView的容器&＃xff0c;苹果对他的介绍是&＃xff1a;

UIWebView是一个可加载网页的对象&＃xff0c;它有浏览记录功能&＃xff0c;且对加载的网页内容是可编程的。说白了UIWebView有类似浏览器的功能&＃xff0c;我们使用可以它来打开页面&＃xff0c;并做一些定制化的功能&＃xff0c;如可以让js调某个方法可以取到手机的GPS信息。

但需要注意的是&＃xff0c;Safari浏览器使用的浏览器控件和UIwebView组件并不是同一个&＃xff0c;两者在性能上有很大的差距。幸运的是&＃xff0c;苹果发布iOS8的时候&＃xff0c;新增了一个WKWebView组件容器&＃xff0c;如果你的APP只考虑支持iOS8及以上版本&＃xff0c;那么你就可以使用这个新的浏览器控件了。

WKWebView重构了原有UIWebView的14个类&＃xff0c;3个协议&＃xff0c;性能提升的同时&＃xff0c;赋予了开发者更加细致的配置&＃xff08;这些配置仅针对客户端IOS开发&＃xff0c;对于前端H5来说&＃xff0c;保持两种容器调用方法的一致性很重要&＃xff09;。

Android容器在安卓客户端中&＃xff0c;webView容器与手机自带的浏览器内核一致&＃xff0c;多为android-chrome。不存在兼容性和性能问题。

RN容器在react-native开发中&＃xff0c;从rn 0.37版本开始官方引入了组件&＃xff0c;在安卓中调用原生浏览器&＃xff0c;在IOS中默认调用的是UIWebView容器。从IOS12开始&＃xff0c;苹果正式弃用UIWebView&＃xff0c;统一采用WKWebView。

RN从0.57起&＃xff0c;可指定使用WKWebView作为WebView的实现

// rn js code


WebView组件不要嵌套在或原生点击组件中&＃xff0c;会造成H5内页面滚动失效

h5向ios客户端发送消息&＃xff1b;

在ios中&＃xff0c;并没有现成的api让js去调用native的方法&＃xff0c;但是UIWebView与WKWebView能够拦截h5内发起的所有网络请求。所以我们的思路就是通过在h5内发起约定好的特定协议的网络请求&＃xff0c;如&＃39;jsbridge://bridge2.native?params&＃61;&＃39; &＃43; encodeURIComponent(obj)然后带上你要传递给ios的参数&＃xff1b;然后在客户端内拦截到指定协议头的请求之后就阻止该请求并解析url上的参数&＃xff0c;执行相应逻辑

在H5中发起这种特定协议的请求方式分两种&＃xff1a;

1. 通过localtion.href&＃xff1b;

通过location.href有个问题&＃xff0c;就是如果我们连续多次修改window.location.href的值&＃xff0c;在Native层只能接收到最后一次请求&＃xff0c;前面的请求都会被忽略掉。

1. 通过iframe方式&＃xff1b;

使用iframe方式&＃xff0c;以唤起Native;以唤起分享组件为例

// h5 js code 将它封装一下function createIframe(url){var url &＃61; &＃39;jsbridge://getShare?title&＃61;分享标题&desc&＃61;分享描述&link&＃61;http%3A%2F%2Fwww.douyu.com&cbName&＃61;jsCallClientBack&＃39;;var iframe &＃61; document.createElement(&＃39;iframe&＃39;);iframe.style.width &＃61; &＃39;1px&＃39;;iframe.style.height &＃61; &＃39;1px&＃39;;iframe.style.display &＃61; &＃39;none&＃39;;iframe.src &＃61; https://segmentfault.com/a/url;document.body.appendChild(iframe);setTimeout(function() {iframe.remove();}, 100);}


然后客户端通过拦截这个请求&＃xff0c;并且解析出相应的方法和参数&＃xff1a;这里以ios为例&＃xff1a;

// IOS swift codefunc webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {let url &＃61; request.URLlet scheme &＃61; url?.schemelet method &＃61; url?.hostlet query &＃61; url?.queryif url !&＃61; nil && scheme &＃61;&＃61; "jsbridge" {switch method! {case "getShare":self.getShare()default:print("default")}return false} else {return true}}


看不懂就略过&＃xff0c;非重点。。。。。

这里我们在请求参数中加上了cbName&＃61;jsCallClientBack&＃xff0c;这个jsCallClientBack为JS调用客户端所定义的回调函数&＃xff0c;在业务层jsBridge封装中&＃xff0c;我们传入一个匿名函数作为回调&＃xff0c;底层将这个函数绑定在window的jsbridge对象下并为其定义一个独一无二的key&＃xff0c;这个key就是jsCallClientBack&＃xff0c;客户端在处理完逻辑后&＃xff0c;会通过上面已经介绍过的方法来回调window下的方法。

ps: 在将回调绑定在window下时&＃xff0c;特别注意要使用bind保持函数内this的原有指向不变

IOS客户端调用H5方法

Native调用Javascript语言&＃xff0c;是通过UIWebView组件的stringByEvaluatingJavascriptFromString方法来实现的&＃xff0c;该方法返回js脚本的执行结果。

// IOS swift codewebview.stringByEvaluatingJavascriptFromString("window.methodName()")


从上面代码可以看出它其实就是执行了一个字符串化的js代码&＃xff0c;调用了window下的一个对象&＃xff0c;如果我们要让native来调用我们js写的方法&＃xff0c;那这个方法就要在window下能访问到。但从全局考虑&＃xff0c;我们只要暴露一个对象如JSBridge给native调用就好了。

调用客户端原生方法的回调函数也将绑在window下供客户端成功反调用&＃xff0c;实际上一次调用客户端方法最后产生的结果是双向互相调用。

H5调用Android客户端方法

在安卓webView中有三种调用native的方式&＃xff1a;

通过schema方式&＃xff0c;客户端使用shouldOverrideUrlLoading方法对url请求协议进行解析。这种js的调用方式与ios的一样&＃xff0c;使用iframe来调用native方法。通过在webview页面里直接注入原生js代码方式&＃xff0c;使用addJavascriptInterface方法来实现。

// android JAVA codeclass JSInterface {&＃64;JavascriptInterfacepublic String getShare() {//...return "share";}
}
webView.addJavascriptInterface(new JSInterface(), "AndroidNativeApi");


上面的代码就是在页面的window对象里注入了AndroidNativeApi对象。在js里可以直接调用原生方法。

使用prompt,console.log,alert方式&＃xff0c;这三个方法对js里是属性原生的&＃xff0c;在android webview这一层是可以重写这三个方法的。一般我们使用prompt&＃xff0c;因为这个在js里使用的不多&＃xff0c;用来和native通讯副作用比较少。

// android JAVA code
class WebChromeClient extends WebChromeClient {&＃64;Overridepublic boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {// 重写window下的prompt&＃xff0c;通过result返回结果}&＃64;Overridepublic boolean onConsoleMessage(ConsoleMessage consoleMessage) {}&＃64;Overridepublic boolean onJsAlert(WebView view, String url, String message, JsResult result) {}} 


一般而言安卓客户端选用1、2方案中的一种进行通信&＃xff0c;从前端层面来讲&＃xff0c;推荐客户端都使用schema协议的方式&＃xff0c;便于前端jsBridge底层代码的维护与迭代。

Android客户端调用H5方法

在安卓APP中&＃xff0c;客户端通过webview的loadUrl进行调用:

// android JAVA codewebView.loadUrl("Javascript:window.jsBridge.getShare()");


H5端将方法绑定在window下的对象即可&＃xff0c;无需与IOS作区分

H5调用RN客户端

我们知道RN的webView组件实际上就是对原生容器的二次封装&＃xff0c;因此我们不需要直接通过schema协议来通信&＃xff0c;只需要使用浏览器postMessage、onMessage来传递消息即可&＃xff0c;类似于iframe&＃xff0c;而真正的通信过程RN已经帮我们做了。

// h5 js code
window.postMessage(data);
// rn js code
 {let { data } &＃61; e.nativeEvent;//...}}/>


RN客户端调用H5

postMessage是双向的&＃xff0c;所以也可以在RN里发消息&＃xff0c;H5里接消息来触发对应的回调

this.refs.webView.postMessage({cbName: &＃39;xxx&＃39;,param: {}
}); 


前端jsBridge的封装

在了解了js与客户端底层的通信原理后&＃xff0c;我们可以将IOS、安卓统一封装成jsBridge提供给业务层开发调用。

class JsBridge {static lastCallTimeconstructor() {if (UA.isReactNative()) {document.addEventListener(&＃39;message&＃39;, function(e) {window.jsClientCallBack[e.data.cbName](e.data.param);});}}// 通用callNtive方法callClient(functionName, data, callback) {// 避免连续调用if (JsBridge.lastCallTime && (Date.now() - JsBridge.lastCallTime) < 100) {setTimeout(() &＃61;> {this.callClient(functionName, data, callback);}, 100);return;}JsBridge.lastCallTime &＃61; Date.now();data &＃61; data || {};if (callback) {const cbName &＃61; randomName();Object.assign(data, { cbName });window.jsClientCallBack[cbName] &＃61; callBack.bind(this);}if (UA.isIOS()) {data.forEach((key, value) &＃61;> {try {data[key] &＃61; JSON.stringify(value);} catch(e) { }});var url &＃61; &＃39;jsbridge://&＃39; &＃43; functionName &＃43; &＃39;?&＃39; parseJSON(data);var iframe &＃61; document.createElement(&＃39;iframe&＃39;);iframe.style.width &＃61; &＃39;1px&＃39;;iframe.style.height &＃61; &＃39;1px&＃39;;iframe.style.display &＃61; &＃39;none&＃39;;iframe.src &＃61; url;document.body.appendChild(iframe);setTimeout(() &＃61;> {iframe.remove();}, 100);} else if (UA.isAndroid()) {    //  这里安卓客户端使用的是上面说的第二种通信方法window.AndroidNativeApi && window.AndroidNativeApi[functionName] && window.AndroidNativeApi[functionName](JSON.stringify(data));} else if (UA.isReactNative()) {     //rn的组件可以设置props.userAgent来让H5识别window.postMessage(JSON.stringify(data););} else {console.error(&＃39;未获取platform信息&＃xff0c;调取api失败&＃39;);}}// 业务层自定义方法getShare(data, callBack) {//..}
}


在核心封装的基础上&＃xff0c;我们可以还做更多的优化&＃xff0c;比如将每个回调函数调用后自我销毁释放内存

四、调试

安卓使用chrome://inspect进行调试&＃xff0c;需要翻墙 IOS使用mac safari的develop选项进行调试 使用RN的http://localhost:8081/debugger-ui 只能调试RN代码&＃xff0c;无法调试webView代码&＃xff0c;RN下webView调试和对应native相同&＃xff0c;但是在chrome://inspect下会出现样式问题。除非是纯RN编写&＃xff0c;直接打包成APP&＃xff0c;否则不建议在RN下调用webView组