Android JsBridge原始碼學習

眾所周知Android 4.2以下的WebView存在addJavascriptInterface漏洞的問題，不太了解的同學可參考
Android4.2下 WebView的addJavascriptInterface漏洞解決方案
@JavascriptInterface
因此，公司專案中很早便使用 JsBridge 實作 “JS與Native的通信” 了，

Native與JS通信原理

Android端WebView啟動時，會加載一段WebViewJavascriptBridge.js的js腳本代碼，

• Native呼叫JS代碼：
  當Native需要向JS端傳遞資料時，直接在Android WebView中使用WebView.loadURL(javascript:WebViewJavascriptBridge.xxxxx)呼叫在WebViewJavascriptBridge.js中提前定義好的xxxxx方法，將資料傳遞到JS端;
• JS呼叫Native代碼：
  當JS需要將資料傳遞給Native時，通過JS reload iframe將資料傳遞到Native的shouldOverrideUrlLoading(WebView view, String url) 方法的url引數中，Android端通過截獲url獲取JS傳遞過來的引數，

以此來實作Native與JS的通信，

GitHub原始碼

lzyzsd/JsBridge

我注釋的JsBridge

Native呼叫JS代碼，向JS端傳遞資料

以下是“ Native向JS端傳遞資料，并接受JS回呼資料 ”的時序圖

sequenceDiagram participant BridgeWebView.java as clientA participant WebViewJavascriptBridge.js as serverA participant demo.html as serverB Note over clientA: Native向JS端傳遞資料 clientA-->>clientA: BridgeWebView.callHandler\n("functionInJs", \n"Native向JS問好",\n mCallBackFunction); clientA-->>clientA: doSend(handlerName, data, responseCallback) clientA-->>clientA: queueMessage(m) clientA-->>clientA: dispatchMessage(m) clientA->>serverA: BridgeWebView.loadUrl(javascriptCommand)\n呼叫JS的_handleMessageFromNative方法 serverA-->>serverA: _handleMessageFromNative(messageJSON) serverA-->>serverA: _dispatchMessageFromNative(messageJSON) serverA->>serverB: handler(message.data, responseCallback) serverB-->>serverB: bridge.registerHandler\n("functionInJs", \nfunction(data, responseCallback)) serverB-->>serverA: responseCallback(responseData) serverA-->>serverA: _doSend({responseId，responseData}); serverA-->>clientA: reload iframe "yy://__QUEUE_MESSAGE__/" clientA-->>clientA: shouldOverrideUrlLoading(view, url) clientA-->>clientA: flushMessageQueue() clientA->>serverA: BridgeWebView.loadUrl(javascriptCommand)\n呼叫JS的_fetchQueue()方法 serverA-->>serverA: _fetchQueue() serverA-->>clientA: reload iframe "yy://return/_fetchQueue/[{"data"}]" clientA-->>clientA: handlerReturnData(String url) clientA-->>clientA: flushMessageQueue中onCallBack clientA-->>clientA: mCallBackFunction.onCallBack(responseData)

BridgeWebView.java

callHandler("functionInJs", "Native向JS問好", mCallBackFunction);

/**
     * Native呼叫JS
     * <p>
     * call javascript registered handler
     * 呼叫javascript處理程式注冊
     *
     * @param handlerName JS中注冊的handlerName
     * @param data        Native傳遞給JS的資料
     * @param callBack    JS處理完成后，回呼到Native
     */
    public void callHandler(String handlerName, String data, CallBackFunction callBack) {
        doSend(handlerName, data, callBack);
    }

注釋很全，看注釋吧，不作講解

BridgeWebView.java

doSend(handlerName, data, responseCallback)

	/**
     * Native 呼叫 JS
     * <p>
     * 保存message到訊息佇列
     *
     * @param handlerName      JS中注冊的handlerName
     * @param data             Native傳遞給JS的資料
     * @param responseCallback JS處理完成后，回呼到Native
     */
    private void doSend(String handlerName, String data, CallBackFunction responseCallback) {
        LogUtils.e(TAG, "doSend——>data: " + data);
        LogUtils.e(TAG, "doSend——>handlerName: " + handlerName);
        // 創建一個訊息體
        Message m = new Message();
        // 添加資料
        if (!TextUtils.isEmpty(data)) {
            m.setData(data);
        }
        //
        if (responseCallback != null) {
            // 創建回呼ID
            String callbackStr = String.format(BridgeUtil.CALLBACK_ID_FORMAT, ++uniqueId + (BridgeUtil.UNDERLINE_STR + SystemClock.currentThreadTimeMillis()));
            // 1、JS回呼Native資料時候使用；key: id value: callback (通過JS回傳的callbackID 可以找到相應的CallBack方法)
            responseCallbacks.put(callbackStr, responseCallback);
            // 1、JS回呼Native資料時候使用；key: id value: callback (通過JS回傳的callbackID 可以找到相應的CallBack方法)
            m.setCallbackId(callbackStr);
        }
        // JS中注冊的方法名稱
        if (!TextUtils.isEmpty(handlerName)) {
            m.setHandlerName(handlerName);
        }
        LogUtils.e(TAG, "doSend——>message: " + m.toJson());
        // 添加訊息 或者 分發訊息到JS
        queueMessage(m);
    }

• 做了一個Message來封裝data資料
• 創建了一個callBackId，并將對應的參考存盤在Map<String, CallBackFunction> responseCallbacks，這樣JS相應方法處理結束后，將JS的處理結果回傳來的時候，Native可通過該callbackId找到對應的CallBackFunction，從而完成資料回呼，

	/**
	 * BridgeWebView.java
     * list<message> != null 添加到訊息集合否則分發訊息
     *
     * @param m Message
     */
    private void queueMessage(Message m) {
        LogUtils.e(TAG, "queueMessage——>message: " + m.toJson());
        if (startupMessage != null) {
            startupMessage.add(m);
        } else {
            // 分發訊息
            dispatchMessage(m);
        }
    }

    /**
    * BridgeWebView.java
     * 分發message 必須在主執行緒才分發成功
     *
     * @param m Message
     */
    void dispatchMessage(Message m) {
        LogUtils.e(TAG, "dispatchMessage——>message: " + m.toJson());
        // 轉化為JSon字串
        String messageJson = m.toJson();
        //escape special characters for json string  為json字串轉義特殊字符
        messageJson = messageJson.replaceAll("(\\\\)([^utrn])", "\\\\\\\\$1$2");
        messageJson = messageJson.replaceAll("(?<=[^\\\\])(\")", "\\\\\"");
        String javascriptCommand = String.format(BridgeUtil.JS_HANDLE_MESSAGE_FROM_JAVA, messageJson);

        LogUtils.e(TAG, "dispatchMessage——>javascriptCommand: " + javascriptCommand);
        // 必須要找主執行緒才會將資料傳遞出去 --- 劃重點
        if (Thread.currentThread() == Looper.getMainLooper().getThread()) {
            // 呼叫JS中_handleMessageFromNative方法
            this.loadUrl(javascriptCommand);
        }
    }

• dispatchMessage中，通過load javascript:WebViewJavascriptBridge._handleMessageFromNative('%s');將Message資料傳遞到JS方法的_handleMessageFromNative當中

// Native通過loadUrl(JS_HANDLE_MESSAGE_FROM_JAVA)，呼叫JS中_handleMessageFromNative方法，實作Native向JS傳遞資料
final static String JS_HANDLE_MESSAGE_FROM_JAVA = "javascript:WebViewJavascriptBridge._handleMessageFromNative('%s');";

WebViewJavascriptBridge.js

    // 1、收到Native的訊息
    // 提供給native呼叫,receiveMessageQueue 在會在頁面加載完后賦值為null,所以
    function _handleMessageFromNative(messageJSON) {
        //
        console.log(messageJSON);
        // 添加到訊息佇列
        if (receiveMessageQueue) {
            receiveMessageQueue.push(messageJSON);
        }
        // 分發Native訊息
        _dispatchMessageFromNative(messageJSON);
       
    }

• 這里將Native發送過來的訊息添加到receiveMessageQueue陣列中，

    //2、分發Native訊息
    function _dispatchMessageFromNative(messageJSON) {
        setTimeout(function() {
            // 決議訊息
            var message = JSON.parse(messageJSON);
            //
            var responseCallback;
            //java call finished, now need to call js callback function
            if (message.responseId) {
            	...
            } else {
                // 訊息中有callbackId 說明需要將處理完成后，需要回呼Native端
                //直接發送
                if (message.callbackId) {
                    // 回呼訊息的 回呼ID
                    var callbackResponseId = message.callbackId;
                    //
                    responseCallback = function(responseData) {
                        // 發送JS端的responseData
                        _doSend({
                            responseId: callbackResponseId,
                            responseData: responseData
                        });
                    };
                }

                var handler = WebViewJavascriptBridge._messageHandler;
                if (message.handlerName) {
                    handler = messageHandlers[message.handlerName];
                }
                //查找指定handler
                try {
                    handler(message.data, responseCallback);
                } catch (exception) {
                    if (typeof console != 'undefined') {
                        console.log("WebViewJavascriptBridge: WARNING: javascript handler threw.", message, exception);
                    }
                }
            }
        });
    }

demo.html

bridge.registerHandler("functionInJs", function(data, responseCallback) {
    document.getElementById("show").innerHTML = ("data from Java: = " + data);
    if (responseCallback) {
        var responseData = https://www.cnblogs.com/xiaxveliang/p/"Javascript Says Right back aka!";
        responseCallback(responseData);
    }
});

• 這里呼叫到JS的functionInJs注冊方法，并將JS的處理結果Javascript Says Right back aka!回傳，回呼到WebViewJavascriptBridge.js _dispatchMessageFromNative注冊的responseCallback，從而呼叫到WebViewJavascriptBridge.js 的_doSend方法之中，

一下為WebViewJavascriptBridge.js 的_doSend

WebViewJavascriptBridge.js

// 發送JS端的responseData
_doSend({
    responseId: callbackResponseId,
    responseData: responseData
});

// 3、JS將資料發送到Native端
// sendMessage add message, 觸發native的 shouldOverrideUrlLoading方法，使Native主動向JS取資料
//
// 把訊息佇列資料放到shouldOverrideUrlLoading 的URL中不就可以了嗎？
// 為什么還要Native主動取一次，然后再放到shouldOverrideUrlLoading的URL中回傳?
function _doSend(message, responseCallback) {
    // 發送的資料存在
    if (responseCallback) {
        //
        var callbackId = 'cb_' + (uniqueId++) + '_' + new Date().getTime();
        responseCallbacks[callbackId] = responseCallback;
        message.callbackId = callbackId;
    }
    // 添加到訊息佇列中
    sendMessageQueue.push(message);
    // 讓Native加載一個新的頁面
    messagingIframe.src = https://www.cnblogs.com/xiaxveliang/p/CUSTOM_PROTOCOL_SCHEME +'://' + QUEUE_HAS_MESSAGE;
}

• 1、將Native發送過來的Message資料，存盤到sendMessageQueue訊息佇列中
• 2、_doSend 中 reload iframe " yy://QUEUE_MESSAGE/ " 觸發native的 shouldOverrideUrlLoading方法

BridgeWebViewClient.java

@Override
    public boolean shouldOverrideUrlLoading(WebView view, String url) {
        LogUtils.d(TAG, "shouldOverrideUrlLoading——>url: " + url);
        try {
            url = URLDecoder.decode(url, "UTF-8");
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        if (url.startsWith(BridgeUtil.YY_RETURN_DATA)) { // 如果是回傳資料
            webView.handlerReturnData(url);
            return true;
        } else if (url.startsWith(BridgeUtil.YY_OVERRIDE_SCHEMA)) { //
            webView.flushMessageQueue();
            return true;
        } else {
            return super.shouldOverrideUrlLoading(view, url);
        }
    }

• _doSend 中 reload iframe " yy://QUEUE_MESSAGE/ " 觸發native的 shouldOverrideUrlLoading方法，最終呼叫到webView.flushMessageQueue();方法中

	/**
     * 1、呼叫JS的 _fetchQueue方法，獲取JS中處理后的訊息佇列，
     * JS 中_fetchQueue 方法 中將Message資料回傳到Native的 {@link #BridgeWebViewClient.shouldOverrideUrlLoading}中
     * <p>
     * 2、等待{@link #handlerReturnData} 回呼 Callback方法
     */
    void flushMessageQueue() {
        LogUtils.d(TAG, "flushMessageQueue");
        if (Thread.currentThread() == Looper.getMainLooper().getThread()) {
            // 呼叫JS的 _fetchQueue方法
            BridgeWebView.this.loadUrl(BridgeUtil.JS_FETCH_QUEUE_FROM_JAVA, new CallBackFunction() {

                @Override
                public void onCallBack(String data) {
                    // ... 此處暫時省略
                }
            });
        }
    }

• flushMessageQueue中加載了一段JS腳本，JS_FETCH_QUEUE_FROM_JAVA，以下為JS腳本的代碼，

// 呼叫JS的 _fetchQueue方法，_fetchQueue方法中將Message資料回傳到Native的shouldOverrideUrlLoading中
final static String JS_FETCH_QUEUE_FROM_JAVA = "javascript:WebViewJavascriptBridge._fetchQueue();";

• 這段JS腳本代碼呼叫到的是 WebViewJavascriptBridge.js中的 _fetchQueue方法，

WebViewJavascriptBridge.js

// 將資料回傳給Native
// 提供給native呼叫,該函式作用:獲取sendMessageQueue回傳給native,由于android不能直接獲取回傳的內容,所以使用url shouldOverrideUrlLoading 的方式回傳內容
    function _fetchQueue() {
        // json資料
        var messageQueueString = JSON.stringify(sendMessageQueue);
        // message資料清空
        sendMessageQueue = [];
        // 資料回傳到shouldOverrideUrlLoading
        //android can't read directly the return data, so we can reload iframe src to communicate with java
        messagingIframe.src = https://www.cnblogs.com/xiaxveliang/p/CUSTOM_PROTOCOL_SCHEME +'://return/_fetchQueue/' + encodeURIComponent(messageQueueString);
    }

• 這里通過 reload iframe " yy://return/_fetchQueue/ + encodeURIComponent(messageQueueString)"將資料發送給Native的shouldOverrideUrlLoading方法中，

	/**
     * 1、獲取到CallBackFunction data執行呼叫并且從資料集移除
     * <p>
     * 2、回呼Native{@link #flushMessageQueue()} Callback方法
     *
     * @param url
     */
    void handlerReturnData(String url) {
        LogUtils.d(TAG, "handlerReturnData——>url: " + url);
        // 獲取js的方法名稱
        // _fetchQueue
        String functionName = BridgeUtil.getFunctionFromReturnUrl(url);
        // 獲取_fetchQueue 對應的回呼方法
        CallBackFunction f = responseCallbacks.get(functionName);
        // 獲取body Message訊息體
        String data = https://www.cnblogs.com/xiaxveliang/p/BridgeUtil.getDataFromReturnUrl(url);

        // 回呼 Native flushMessageQueue callback方法
        if (f != null) {
            LogUtils.d(TAG, "onCallBack data" + data);
            f.onCallBack(data);
            responseCallbacks.remove(functionName);
            return;
        }
    }

• 這里的CallBackFunction 回呼到了flushMessageQueue方法的onCallBack中，

@Override
public void onCallBack(String data) {
    LogUtils.d(TAG, "flushMessageQueue——>data: " + data);
    // deserializeMessage 反序列化訊息
    List<Message> list = null;
    try {
        list = Message.toArrayList(data);
    } catch (Exception e) {
        e.printStackTrace();
        return;
    }
    if (list == null || list.size() == 0) {
        LogUtils.e(TAG, "flushMessageQueue——>list.size() == 0");
        return;
    }
    for (int i = 0; i < list.size(); i++) {
        Message m = list.get(i);
        String responseId = m.getResponseId();
        /**
         * 完成Native向JS發送資訊后的回呼
         */
        // 是否是response  CallBackFunction
        if (!TextUtils.isEmpty(responseId)) {
            CallBackFunction function = responseCallbacks.get(responseId);
            String responseData = https://www.cnblogs.com/xiaxveliang/p/m.getResponseData();
            function.onCallBack(responseData);
            responseCallbacks.remove(responseId);
        } else {
            // ... 此處暫時省略
        }
    }
}

• 這里回圈了從JS端獲取到的Message佇列，并將JS端獲取的資料，回呼到了Native中對應的CallBackFunction中，

到這里，JsBridge中Native呼叫JS代碼的通信，則完成了，

一個問題

WebViewJavascriptBridge.js的_doSend(message, responseCallback)方法中，把Message訊息佇列 放到shouldOverrideUrlLoading 的URL中直接回傳給Native不就可以了嗎？

為什么還要用_doSend 中 reload iframe " yy://QUEUE_MESSAGE/ " 觸發native的 shouldOverrideUrlLoading方法，讓Native主動向JS請求一次Message佇列，然后再放到shouldOverrideUrlLoading的URL中回傳給Native呢?

個人觀點：
覺得，這樣將Message集中在一起，通過發送一個訊息給Native，讓Native主動將所有資料請求回來，避免了JS與Native的頻繁互動，

JS呼叫Native代碼，向Native傳遞資料

不太想說了，就到這吧

========== THE END ==========

轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/28332.html

標籤：Android

上一篇：RxJava2 使用 及 原始碼閱讀

下一篇：Android基于TCP協議的Socket通信簡單實體