Android中JSBridge的原理與實現

Android中的JSBridge是H5與Native通信的橋梁,其作用是實現H5與Native間的雙向通信。要實現H5與Native的雙向通信,解決如下四個問題即可:
1、Java如何調用JavaScript
2、JavaScript如何調用Java
3、方法參數以及回調如何處理
4、通信的數據格式是怎么樣的

下面從以上問題依次開始討論:

1、Java如何調用JavaScript

在Android 中,Java與JavaScript的一切交互都是依托于WebView的??赏ㄟ^如下方法來完成,其中function()即為JavaScript代碼,來實現相應的具體H5層功能

WebView.loadUrl("javascript:function()");

2、JavaScript如何調用Java

要實現在JavaScript中調用Java,就需要在JavaScript中有觸發Java方法的對象和方法。在JavaScript中,當調用window對象的prompt方法時,會觸發Java中的WebChromeClient對象的onJsPrompt方法,因此可以利用這個機制來實現js調用native的代碼

3、方法參數以及回調處理

任何IPC通信都涉及到參數序列化的問題,同理,Java與JavaScript之間只能傳遞基礎類型(包括基本類型和字符串),不包括其他對象或者函數。所以可以采用json格式來傳遞數據。JavaScript與Java相互調用不能直接獲取返回值,只能通過回調的方式來獲取返回結果。

4、通信的數據格式

Java與JavaScript通信需要遵循一定的通信協議,可以仿照HTTPS協議來將此協議定義為jsbridge協議:

jsbridge://className:port/methodName?jsonObj

當js調用native功能時,應當指定native層要完成某個功能調用的類名(className)和方法名(methodName),以及js傳遞過來的參數(jsonObj)。port值是指當native需要將操作結果返回給js時,在js中定義一個callback,并將這個callback存儲在指定的位置上,這個port就定義了callback的存儲位置。

jsbridge原理圖.png

JSBridge的具體工作流程圖如上所示:

1、js觸發調用native層的行為

JSBridge.call(className, methodName, params, callback);

將call方法中的參數組合成jsbridge協議格式的url。然后通過prompt方法將url傳遞到native層。

window.prompt(url);

2、通過WebChromeClient來獲取js傳遞過來的url.

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;
    }
}

3、JSBridge類管理暴露給前端方法,前端調用的方法應該在此類中注冊才可使用。register的實現是從Map中查找key是否存在,不存在則反射取得對應class中的所有方法,具體方法是在BridgeImpl中定義的,方法包括三個參數分別為WebView、JSONObject、CallBack。如果滿足條件,則將所有滿足條件的方法put到map中。

private static Map<String, HashMap<String, Method>> exposedMethods = new HashMap<>();
public static void register(String exposedName, Class<? extends IBridge> clazz) {
        if (!exposedMethods.containsKey(exposedName)) {
            try {
                exposedMethods.put(exposedName, getAllMethod(clazz));
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

JSBridge類中的callJava方法就是將js傳遞過來的URL解析,根據將要調用的類名從剛剛建立的Map中找出,根據方法名調用具體的方法,并將解析出的三個參數傳遞進去。

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("/", "");
            }
        }


        if (exposedMethods.containsKey(className)) {
            HashMap<String, Method> methodHashMap = 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;
    }

4、CallBack類是用來回調js中回調方法的Java對應類。Java層處理好的返回結果是通過CallBack類來實現的。在這個回調類中傳遞的參數是JSONObject(返回結果)、WebView和port,port應與js傳遞過來的port相對應。

private static Handler mHandler = new Handler(Looper.getMainLooper());
    private static final String CALLBACK_JS_FORMAT = "javascript:JSBridge.onFinish('%s', %s);";
    private String mPort;
    private WeakReference<WebView> mWebViewRef;

    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);
                }
            });
        }
    }

5、JSBridgeImpl類中定義所有暴露給前端的方法的具體實現。本文以showToast為例來通過native代碼顯示toast,并給出js的回調函數,返回一個JSONObject對象。

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();
            }
        }
    }

6、在js中通過

JSBridge.call('bridge','showToast',{'msg': 'Hello'}, function(res){alert(JSON.stringi
    fy(res))})"

即可調用在Java層定義的showToast方法,調用前不要忘記在java層的JSBridge中注冊該方法。

JSBridge.register("bridge", BridgeImpl.class);

二、總結:

JSBridge的基本原理為:
H5->通過某種方式觸發一個url->Native捕獲到url,進行分析->原生做處理->Native調用H5的JSBridge對象傳遞回調。如下圖

h5與原生頁面通過jsbridge交互.png

三、安全性:

1、Android4.2以下,addJavascriptInterface方法有安全漏洞,js代碼可以獲取到Java層的運行時對象,來偽造當前用戶執行惡意代碼。
2、ios7以下,JavaScript無法調用native代碼。
3、通過js聲明的對象,是通過loadUrl注入到頁面中的,所以這個對象是js對象,而不是Java對象,沒有getClass等Object方法,因此也無法獲得Runtime對象,避免了惡意代碼的注入。
4、JSBridge采用URL解析的交互方式,是一套成熟的解決方案,便于拓展,無重大安全性問題。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374

推薦閱讀更多精彩內容