JSBridge
1. Why do we need JSBridge?
2. Why is “JS”Bridge?
3. What is JSBridge?
Why do we need JSBridge?
背景
随着HTML5的不斷普及及優化，其在移動端開發的應用也越來越多。
why?
H5是跨平台的
依托浏覽器運作，不用區分ios或者安卓去做不同的版本的開發，這樣可以節約開發成本。當然在ios和安卓各種機型下是需要去适配的，比如大家比較熟悉的rem布局以及flex布局等等。
用戶端發版限制
尤其是ios，要稽核。比如要急着上線一個功能或者活動，那麼這時就需要h5。還有就是一些可能會頻繁改動或者新增的功能，比如商品詳情這種，新增品類啊，某種品類新增類目啊等等，更新頻繁的，如果用native開發的話，要頻繁的發版，這就不大現實。這也是為什麼現在大家比較推崇的Hybird混合開發。
顧名思義，JSBridge是一座用JavaScript搭建起來的橋，一端是H5，一端是native。我們搭建這座橋的目的也很簡單，讓native可以調用H5的js代碼，讓H5可以“調用”原生的代碼。
Why is “JS”Bridge
為什麼是JSbridge ?，而不是iOS/安卓 bridge，那是因為這個橋，是通過js來搭建的，也就是用js來寫的。
這個比較容易了解，web端支援JavaScript，native有webview，webview可以在所加載的頁面加載完成後調用頁面的JavaScript代碼。是以，使用JavaScript就理所當然了。
What is JSBridge?
1.Android
2. IOS
Android調用JS
WebView.loadUrl(“javascript:function()”)
mWebView.loadUrl("javascript:JSBridge.onFinish(port,jsonObj);");
JS調用Android
WebView的JavascriptInterface
WebViewClient.shouldOverrideUrlLoading()
WebChromeClient.onConsoleMessage()
WebChromeClient.onJsPrompt()
WebView的JavascriptInterface
是Android官方提供的工js和Native通信方案
1，實作一個java類
public class JavascriptInterface {
@JavascriptInterface
public void showToast(String toast) {
Toast.makeText(MainActivity.this, toast, Toast.LENGTH_SHORT).show();
}
2，在webView中注冊這個類
webView.addJavascriptInterface(new JavascriptInterface(), "javascriptInterface");
3，在js中直接調用這個接口
function showToast(text){
window.javascriptInterface.showToast(text);
}
WebViewClient.shouldOverrideUrlLoading()
這個方法是攔截所有webView的跳轉，頁面可以構造一個特殊格式的Url跳轉，shouldOverrideUrlLoading攔截Url後判斷其格式，然後Native就能執行自身的邏輯了
比如用 iframe 打開一個schema協定
public class CustomWebViewClient extends WebViewClient {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
if (isJsBridgeUrl(url)) {
// JSbridge的處理邏輯
return true;
}
return super.shouldOverrideUrlLoading(view, url);
WebChromeClient.onConsoleMessage()
在js中執行console.log(), 會進入Android的WebChromeClient.consoleMessage()回調
public class CustomWebChromeClient extends WebChromeClient {
@Override
public boolean onConsoleMessage(ConsoleMessage consoleMessage) {
super.onConsoleMessage(consoleMessage);
String msg = consoleMessage.message();//Javascript輸入的Log内容
}
}
WebChromeClient.onJsPrompt()
在js中執行alert、confirm和prompt這三個方法時，會進入Android的onJsAlert、onJsConfirm和onJsPrompt回調
由于prompt的使用頻率較低，是以通常采用prompt實作js和Native的通信
1. 設計schema
和網站的http協定一樣，約定一個js和Android的通信協定
var JSBridgeUrl = 'JSBridge://className:callbackAddress/methodName?jsonObj';
// className: 表示java的類名
// callbackAddress： js回調的辨別
// methodName： java中的方法名
// jsonObj： 接口資料
2，在js中，可以采用如下方法調用安卓的方法
var JSBridge = {
call: function(className, method, params, callback){
var uri = 'JSBridge://' + className + ':' + callback + '/' + method + '?' + params;
window.prompt(uri, "");
}
}
// 下面會調用java中的 bridge.showToast方法
JSBridge.call('bridge','showToast',{'msg':'Hello JSBridge'},
function(res){alert(JSON.stringify(res))});
3，在java中， 可以如下實作：
public class JSBridgeWebChromeClient extends WebChromeClient {
@Override
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
result.confirm(JSBridge.callJava(view, message));
return true;
}
}
// 調用java邏輯
public class JSBridge {
...
public static String callJava(WebView webView, String uriString) {
String methodName = "";
String className = "";
String param = "{}";
String port = "";
if (!TextUtils.isEmpty(uriString) && uriString.startsWith("JSBridge")) {
Uri uri = Uri.parse(uriString);
className = uri.getHost();
param = uri.getQuery();
port = uri.getPort() + "";
String path = uri.getPath();
if (!TextUtils.isEmpty(path)) {
methodName = path.replace("/", "");
}
}
// 基于上面的className、methodName和port path調用對應類的方法if (exposedMethods.containsKey(className)) { HashMapmethodHashMap = exposedMethods.get(className);
if (methodHashMap != null && methodHashMap.size() != 0 && methodHashMap.containsKey(methodName)) {
Method method = methodHashMap.get(methodName);
if (method != null) {
try {
method.invoke(null, webView, new JSONObject(param), new Callback(webView, port));
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
return null;
}
}
// 直接進入showToast函數的實作
public static void showToast(WebView webView, JSONObject param, final Callback callback) {
String message = param.optString("msg");
Toast.makeText(webView.getContext(), message, Toast.LENGTH_SHORT).show();
if (null != callback) {
try {
JSONObject object = new JSONObject();
object.put("key", "value");
object.put("key1", "value1");
callback.apply(getJSONObject(0, "ok", object));
} catch (Exception e) {
e.printStackTrace();
}
}
}
// 上述程式的callback.apply方法實作如下： 即通過webView.loadUrl實作java調用js的方法
public class Callback { private static Handler mHandler = new Handler(Looper.getMainLooper());
private static final String CALLBACK_JS_FORMAT = "javascript:JSBridge.onFinish('%s', %s);";
private String mPort;
private WeakReferencemWebViewRef;
public Callback(WebView view, String port) {
mWebViewRef = new WeakReference<>(view);
mPort = port;
}
public void apply(JSONObject jsonObject) {
final String execJs = String.format(CALLBACK_JS_FORMAT, mPort, String.valueOf(jsonObject));
if (mWebViewRef != null && mWebViewRef.get() != null) {
mHandler.post(new Runnable() {
@Override
public void run() {
mWebViewRef.get().loadUrl(execJs);
}
});
}
}
}
IOS調用JS
先了解下ios 提供的UIWebView
UIWebView是iOS内置的浏覽器控件，UIWebView用于在APP中嵌入網頁，通常是html網頁，也可以是PDF、txt文檔等。但需要注意的是，Safari浏覽器使用的浏覽器控件和UIwebView元件并不是同一個，兩者在性能上有很大的差距。幸運的是，蘋果釋出iOS8的時候，新增了一個WKWebView元件，如果你的APP隻考慮支援iOS8及以上版本，那麼你就可以使用這個新的浏覽器控件了。
UIWebView有一些方法：
loadData： 設定頁面的内容，MIME類型，編碼，基礎url
loadRequest：加載網絡内容
loadHTMLString：加載本地HTML檔案
stopLoading：停止加載
goBack：後退
goForward：前進
reload：重新加載
stringByEvaluatingJavaScriptFromString：執行一段js腳本，并且傳回執行結果
iOS(Objective-C或Swift)調用Javascript方法
// Swift1，通過UIWebView元件的stringByEvaluatingJavaScriptFromString方法來實作的，該方法傳回js腳本的執行結果
webview.stringByEvaluatingJavaScriptFromString("Math.random()")
// OC
[webView stringByEvaluatingJavaScriptFromString:@"Math.random();"];
舉個例子：(比如要彈出一個alert)
NSString *jsStr = [NSString stringWithFormat:@"showAlert('%@')",@"這裡是JS中alert彈出的message"];
[_webView stringByEvaluatingJavaScriptFromString:jsStr];
注意：該方法會同步傳回一個字元串，是以是一個同步方法，可能會阻塞UI。
官方推薦使用WKWebView的evaluateJavaScript:completionHandler:代替這個方法
function asyncAlert(content) {
setTimeout(function(){
alert(content);
},1);
}
2，JavaScriptCore
首先導入JavaScriptCore庫, 然後在OC中擷取JS的上下文
JSContext *context =
[self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
NSString *textJS = @"showAlert('這裡是JS中alert彈出的message')";
[context evaluateScript:textJS];
JS調用IOS方法
1，UIWebView有個特性：在UIWebView内發起的所有網絡請求，都可以通過delegate函數在Native層得到通知。
那麼我們就可以在UIWebView内發起一個自定義的(schema協定)網絡請求，比如這樣的格式：jsbridge://methodName?param1=value1¶m2=value2
于是在UIWebView的delegate函數中，我們隻要發現是jsbridge://開頭的位址，就不進行内容的加載，轉而執行相應的調用邏輯。
H5喚起IOS的分享元件
JS代碼
var JSBridgeUrl = 'JSBridge://doAction?title=分享标題&desc=分享描述&link=http%3A%2F%2Fwww.ffan.com';
var iframe = document.createElement('iframe');
iframe.style.width = '1px';
iframe.style.height = '1px';
iframe.style.display = 'none';
iframe.src = url;
document.body.appendChild(iframe);
setTimeout(function() {
iframe.remove();
}, 100);
IOS代碼
func webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {
print("shouldStartLoadWithRequest")
let url = request.URL
let scheme = url?.scheme
let method = url?.host
let query = url?.query
if url != nil && scheme == "jsbridge" {
print("scheme == \(scheme)")
print("method == \(method)")
print("query == \(query)")
switch method! {
case "getData":
self.getData()
case "putData":
self.putData()
case "gotoWebview":
self.gotoWebview()
case "gotoNative":
self.gotoNative()
case "doAction":
self.doAction()
case "configNative":
self.configNative()
default:
print("default")
}
return false
} else {
return true
}
}
JSBridge.doAction('share', {
title: data.title
desc: data.desc
link: data.link
imgs_url: data.img
});
回調的話，native 另外用 stringByEvaluatingJavaScriptFromString 方法通知 js。
2，JavaScriptCore
IOS代碼
JSContext *context =
[self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
- (void)webViewDidFinishLoad:(UIWebView *)webView
{
JSContext *context =
[self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
//定義好JS要調用的方法, share就是調用的share方法名
context[@"share"] = ^() {
NSLog(@"+++++++Begin Log+++++++");
NSArray *args = [JSContext currentArguments];
UIAlertView *alertView =
[[UIAlertView alloc] initWithTitle:@"方式二" message:@"這是OC原生的彈出窗"
delegate:self cancelButtonTitle:@"收到" otherButtonTitles:nil];
[alertView show];
for (JSValue *jsVal in args) {
NSLog(@"%@", jsVal.toString);
}
NSLog(@"-------End Log-------");
};
}
H5代碼
最後說下參數傳遞
1，将參數以 JSON 的形式傳遞，但是因為要附加在 url 之後，是以我們将 JSON 進行了 Base64 編碼，以保證 url 中不會出現一些非法的字元。
2，用 JSON 傳遞參數，但是将 JSON 放在 UIWebView 中的一個全局數組中，UIWebView 當需要讀取參數時，通過讀取這個全局數組來獲得相應的參數。