為什么使用JSBridge
<p>
在平時業務的開發中，為了追求開發的效率以及移植的便利性，一些展示性強的頁面我們會偏向于使用h5來完成，功能性強的頁面我們會偏向于使用native來完成，而一旦使用了h5，為了在h5中盡可能的得到native的體驗，我們native層需要暴露一些方法給js調用，比如，彈Toast提醒，彈Dialog，分享等等，同樣我們也可以通過native方法去直接調用js的方法，所以 JsBridge 就是用來在 Android app的原生 java 代碼與 javascript 代碼中架設通信（調用）橋梁的輔助工具。
這里我們分析一下JSBridge的使用場景
- 1.JS調用JAVA的方法
- 2.JAVA調用JS的方法
- 3.JS調用JAVA方法后，JAVA回調給JS
- 4.JAVA調用JS方法后，JS回調給JAVA
所以針對上面的使用場景，我們分別來實現
1.JS調用JAVA的方法
<p>
WebView 提供了一個接口，可以讓我們注入 Java 對象到頁面中，這樣，頁面中的 javascript 就能直接訪問 Java 對象的接口，從而實現 Java 和 Javascript 的交互。
首先必須啟用 WebView 中的 Javascript 支持
mWebView.getSettings().setJavaScriptEnabled(true);
注入 Java 對象到 WebView 中
mWebView.addJavascriptInterface(new JavaExecutor(mWebView), "JavaExecutor");
Java 對象定義如下(需要特別注意的是，在 JELLY_BEAN_MR1 之后，只有 public 且添加了 @JavascriptInterface 注解的方法才能被調用)
@JavascriptInterface
public final void onJSExecutorJava(String className,String methodName,String params) throws Exception {
Class<?> targetClass = Class.forName(JSApplication.Instance().getPackageName()+ "." + className);
HashMap<String, Method> extendsMethods = getAllMethod(targetClass);;
if (extendsMethods.containsKey(methodName)) {
Method method = extendsMethods.get(methodName);
if (method != null) {
method.invoke(null, new JSONObject(params));
}
}
}
private static HashMap<String, Method> getAllMethod(Class injectedCls) throws Exception{
HashMap<String, Method> mMethodsMap = new HashMap<>();
Method[] methods = injectedCls.getDeclaredMethods();
for (Method method : methods){
String name;
if (method.getModifiers() != (Modifier.PUBLIC | Modifier.STATIC) || (name = method.getName()) == null){
continue;
}
Class[] parameters = method.getParameterTypes();
if (null != parameters && parameters.length == 1){
if (parameters[0] == JSONObject.class) {
mMethodsMap.put(name, method);
}
}
}
return mMethodsMap;
}
所以JS可以調用的就是JavaExecutor類中的onJSExecutorJava方法，這個方法我定義了三個參數，分別是調用類，方法與傳遞過來的參數（主要定義為json類型的格式）
接下來就是看看JS里面的實現了
call: function (obj, method, params) {
JavaExecutor.onJSExecutorJava(obj, method ,JSON.stringify(params));
},
JSBridge.call('JSBridgeImpl','showToast',{'msg':'Hello JSBridge'});
我這里是調用了JSBridgeImpl的showToast方法，傳遞的參數是'msg':'Hello JSBridge'，這個方法是彈一個Toast,并且提示語為Hello JSBridge，這個方法比較簡單就不貼出來了
接下來就是運行實驗
所以JS調用JAVA成功了
2.JAVA調用JS的方法
<p>
至于JAVA調用JS大致有以下幾個可用方法：
1.loadUrl方法
webView.loadUrl("javascript:scriptString"); //其中 scriptString 為 Javascript 代碼
2.在 KITKAT 之后，又新增了一個方法：
webView.evaluateJavascript(scriptString, new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
}
});//其中 scriptString 為 Javascript 代碼，ValueCallback 的用來獲取 Javascript 的執行結果。這是一個異步調用。
所以其實也是調用了JS的方法，接下來看下JS的方法
onJavaCall: function (method, params){
var targetFn = window[method(params)];
if (targetFn) {
targetFn(this);
}
},
我這里定義了兩個參數分別是調用方法與傳遞過來的參數（主要定義為json類型的格式）
接下來看下實際調用的方法
private static final String CALLBACK_JS_FORMAT = "JSBridge.onJavaCall(%s, %s);";
private void transact(final String script){
mHandler.post(new Runnable() {
@Override
public void run() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
mWebView.evaluateJavascript(script, new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
}
});
} else {
mWebView.loadUrl("javascript:" + script);
}
}
});
}
JSONObject object = new JSONObject();
object.put("key", "value");
object.put("key1", "value1");
transact(String.format(CALLBACK_JS_FORMAT, "jsFn2", String.valueOf(jsonObject));
所以是調用了js中的onJavaCall方法，通過onJavaCall去調用jsFn2方法并且把相關的json數據傳遞過去了
看一下我們定義的jsFn2方法
function jsFn2(res) {
title.style.background = 'red';
console.log(JSON.stringify(res))
}
這里主要把html中的標題的背景色進行了修改，并把傳遞的數據打印出來
運行如下
所以JAVA調用JS成功了
3.JS調用JAVA方法后，JAVA回調給JS
<p>
這種類型的使用場景，肯定會在日常開發中會遇到，所以我們可以以并非JSBridge的方式去想這個問題，普通Java相關使用場景看到會用到CallBack，那么這里我們同樣使用CallBack來處理回調。
對于JS和JAVA中的CallBack肯定不是同樣的類型，所以我們需要把JS中定義的CallBack生成一個ID，并把ID與CallBack關聯存儲下來,然后把ID傳遞給執行JAVA方法，當JAVA方法執行完后再通過上述的JAVA調用JS的方法調用JS中處理回調的方法，同時把CallBack的ID，與數據傳遞過來，JS通過ID獲取關聯數據中的CallBack，然后執行CallBack的方法
所以流程如下
1.JS調用JAVA方法，傳遞需要信息，與CallBackID
2.JAVA方法執行完后，調用JS的回調處理方法，通過CallBackID獲取CallBack方法
3.執行CallBack方法
所以這里我們需要對JS調用JAVA的方法中定義的方法進行修改
@JavascriptInterface
public final void onJSExecutorJava(String className,String methodName,String params,long callbackId) throws Exception {
Class<?> targetClass = Class.forName(JSApplication.Instance().getPackageName()+ "." + className);
HashMap<String, Method> extendsMethods = getAllMethod(targetClass);
if (extendsMethods.containsKey(methodName)) {
Method method = extendsMethods.get(methodName);
if (method != null) {
JSCallBack callBack = new JSCallBack(mWebView,callbackId);
method.invoke(null, new JSONObject(params),callBack);
}
}
}
public class JSCallBack {
private static final String CALLBACK_JS_FORMAT = "JSBridge.onJSCallBack(%d, %s);";
WebView mWebView;
long mCallbackId;
public JSCallBack(WebView webView,long callbackId) {
mWebView = webView;
mCallbackId = callbackId;
}
public void onTranst(JSONObject jsonObject){
final String execJs = String.format(CALLBACK_JS_FORMAT,mCallbackId,String.valueOf(jsonObject));
new JsExecutor(mWebView).JavaExecutorJS(execJs);
}
}
這里主要是為JS執行的JAVA方法增加了callbackId，并通過callbackId新建一個JSCallBack對象，當JS要執行的JAVA方法執行結束，就可以執行JSCallBack中的onTranst來調用loadUrl方法來執行JS中回調處理方法
接下來看一個JS中回調處理方法
onJSCallBack: function (callbackId, params){
var callback = this.callbacks[callbackId];
callback && callback(params);
delete this.callbacks[callbackId];
},
這里是通過callbackId獲取callback，并執行callback方法，最后刪除存儲的callback
最后看一下JS調用JAVA的方法，這里也需要進行修改
call: function (obj, method, params, callback) {
var callbackId = Util.getID();
this.callbacks[callbackId] = callback;
JavaExecutor.onJSExecutorJava(obj, method ,JSON.stringify(params), callbackId);
},
JSBridge.call('JSBridgeImpl','showToast',{'msg':'Hello JSBridge'},function (res){console.log(JSON.stringify(res))})
這里是首先獲取了callbackId，并存儲下來，最后將callbackId傳遞給執行的JAVA方法
接下來就是測試一下我們執行的方法，我們這邊是調用了showToast方法，并將回調的數據打印出來。
如下
4.JAVA調用JS方法后，JS回調給JAVA
<p>
其實JAVA調用JS方法JS回調給JAVA和前面的方法步驟是類似的
1.JAVA調用JS方法，傳遞需要信息，與CallBackID
2.JS方法執行完后，調用JAVA的回調處理方法，通過CallBackID獲取CallBack方法
3.執行CallBack方法
所以這里我們需要對JAVA調用JS的方法中定義的方法進行修改
private static final String CALLBACK_JS_FORMAT = "JSBridge.onJavaCall(%s, %s, %d);";
public void JavaExecutorJS(String method,JSONObject jsonObject,JavaCallBack callBack){
long callbackId = System.currentTimeMillis();
Commons.mJavaCallBacks.put(callbackId + "",callBack);
transact(String.format(CALLBACK_JS_FORMAT, method, String.valueOf(jsonObject), callbackId));
}
public interface JavaCallBack {
void onReceiveResult(JSONObject jsonObject);
}
這里獲取當前的時間作為callbackId,然后通過loadurl調用JSBridge的onJavaCall方法
onJavaCall: function (method, params, callbackId){
var targetFn = window[method(params,callbackId)];
if (targetFn) {
targetFn(this);
}
},
當我們調用JS方法時候會把參數和callbackId傳遞過去，當JS方法執行完后，調用JAVA方法將返回的參數與callbackId傳遞過去就可以調用JAVA中定義的Callback方法了
JavaExecutor增加回調返回方法
@JavascriptInterface
public final void onJavaCallBack(String params,long callbackId){
try {
JavaCallBack callBack = Commons.mJavaCallBacks.get(callbackId + "");
callBack.onReceiveResult(new JSONObject(params));
} catch (JSONException e) {
e.printStackTrace();
}
}
回調后獲取callback，調用callBack的onReceiveResult方法
同時JS中也要添加相關的調用方法如下
// JAVA調用js后的回調方法
onJAVACallBack: function (callbackId, params){
JavaExecutor.onJavaCallBack(JSON.stringify(params), callbackId);
},
到這里基本就完成了JAVA調用JS方法后，JS回調給JAVA的需求了
接下來看一下JAVA調用方法與JS中被調用的方法
JSONObject object = new JSONObject();
object.put("key", "value");
object.put("key1", "value1");
new JsExecutor(mWebView).JavaExecutorJS("jsFn2", getJSONObject(0, "ok", object), new JavaCallBack() {
@Override
public void onReceiveResult(JSONObject jsonObject) {
Toast.makeText(getBaseContext(),jsonObject.toString(),Toast.LENGTH_SHORT).show();
}
});
function jsFn2(res,callbackId) {
title.style.background = 'red';
console.log(JSON.stringify(res))
JSBridge.onJAVACallBack(callbackId,{'msg':'Hello JSBridge'})
}
所以需要實現的效果是，title的背景色變化后彈出Toast
運行如下
bingo~~~完成
寫在后面的話
<p>
java 代碼與 javascript 代碼中通信通過這幾種方式都可以實現，當然根據不同的應用和業務需求，開發者們可以根據各自的場景進行相關封裝，peace~~~
