js 与 App 间的 bridge

js 与 App 原生交互

几乎上所有的 App 上面都会有 H5 网页的活动,特别是我们做电商的,我们公司也是这样的。比如 H5 可能需要在 App 里面能获取到用户信息,分享之后的回调需要 App 来告知 H5,从而完成UI的渲染。
我们需要有一套从 App 端很容易注册方法给 js 用,js 也很容易调用 App 的方法。

jsbridge

首先我们的数据通过字符串来传递(json)。
我们可以写一个本地的 js 脚本 在 资源文件下面,来方便我们去记录 js 和 App 间的 注册的方法什么的,作为我们跟 js 交互的中间件。这个中间件主要的作用是记录 js 那边注册的方法、给 js 调用 App 的方法,App 调用 js 的入口。

(function() {

    if (window.HuoqiuJavascriptBridge) {
        return;
    }

    var registerFunctions = {};

    //set default messageHandler
    function init(defaultMessageHandler) {
        if (HuoqiuJavascriptBridge.defaultMessageHandler) {
            throw new Error('HuoqiuJavascriptBridge.init called twice');
        }
        HuoqiuJavascriptBridge.defaultMessageHandler = defaultMessageHandler;
    }

    function registerFunction(functionName, functionHandler) {
        registerFunctions[functionName] = functionHandler;
    }

    function callFunction(functionName, params, callback) {
        var message = { functionName: functionName, params: params};
        var messageString = JSON.stringify(message);
        //console.log(messageString);
        if (window.jsbridge) {
            var response = window.jsbridge.callFunction(messageString);
            if (callback) {
                callback(response);
            }
            return response;
        }
        return '';
    }

    function handleMessageFromNative(messageJSON) {
        //console.log(messageJSON);
        var message = JSON.parse(messageJSON);
        var functionHandler = HuoqiuJavascriptBridge.defaultMessageHandler;
        if (message.functionName) {
            functionHandler = registerFunctions[message.functionName];
        }
        //查找指定function
        try {
            return functionHandler(message.params);
        } catch (exception) {
            if (typeof console != 'undefined') {
                console.log("HuoqiuJavascriptBridge: WARNING: javascript handler threw.", message, exception);
            }
        }
    }

    var HuoqiuJavascriptBridge = window.HuoqiuJavascriptBridge = {
        init: init,
        registerHandler: registerFunction,
        callHandler: callFunction,
        handleMessageFromNative: handleMessageFromNative
    };

    var doc = document;
    var readyEvent = doc.createEvent('Events');
    readyEvent.initEvent('HuoqiuJavascriptBridgeReady');
    readyEvent.bridge = HuoqiuJavascriptBridge;
    doc.dispatchEvent(readyEvent);
})();

大概就是提供了js App 唯一的调用入口,各个方法名 参数 用 json 保存,这样就不用每个方法都写出来,相当于动态添加的。
最后因为 App 的 webview 是需要去加载这段代码的,所以有个时间差,这个时间之后 js 才能去使用 bridge,所以最后发送了一个 ready 事件 告知 js 可以开始使用了。之后 就可以 registerHandler,callHandler 来注册和调用 App 的方法了。

App 端

Android 里面的 @JavascriptInterface 和 evaluateJavascript ( API < 19 用 loadurl)可以来帮助我们完成这些功能。

class HuoqiuJavascriptBridge(private var mWebViewHolder: WebView?, private var mGson: Gson) {

    private val JS_HANDLE_MESSAGE_FROM_NATIVE = "javascript:HuoqiuJavascriptBridge.handleMessageFromNative('%s');"

    private var registerFunctions: MutableMap<String, CallBack> = HashMap()

    init {
        if (mWebViewHolder == null)
            throw NullPointerException("WebView in HuoqiuJavascriptBridge can not be null!")
        mWebViewHolder?.addJavascriptInterface(this, "jsbridge")
    }

    //don't call this
    @JavascriptInterface
    fun callFunction(params: String?): String?{
        if (!TextUtils.isEmpty(params)) {
            var message = mGson.fromJson(params, Message::class.java)
            val callback = registerFunctions[message.functionName]
            if (callback != null) {
                return callback.onCallBack(message.params)
            }
            //Log.d("function", "${message.functionName} : ${message.params}")
        }
        return "function_not_found"
    }

    fun registerFunction(functionName: String, callBack: CallBack) {
        registerFunctions[functionName] = callBack
    }

    fun callFunction(functionName: String, params: String?, callBack: CallBack?) {
        val message = Message()
        message.params = params
        message.functionName = functionName
        var messageJson = message.toJson(mGson)
        messageJson = messageJson.replace("(\\\\)([^utrn])".toRegex(), "\\\\\\\\$1$2")
        messageJson = messageJson.replace("(?<=[^\\\\])(\")".toRegex(), "\\\\\"")
        val javascriptCommand = String.format(JS_HANDLE_MESSAGE_FROM_NATIVE, messageJson)
        if (Thread.currentThread() === Looper.getMainLooper().thread) {
            this.loadJs(javascriptCommand, callBack)
        }else{
            Log.w("HuoqiuJavascriptBridge", "callFunction should be in main thread !")
        }
    }

    private fun loadJs(script: String, callBack: CallBack?) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
            mWebViewHolder?.evaluateJavascript(script, {
                callBack?.onCallBack(it)
            })
        } else {
            mWebViewHolder?.loadUrl(script)
        }
    }

    fun loadHuoqiuJavascriptBridge() {
        val jsContent = assetFile2Str(mWebViewHolder?.context, "HuoqiuJavascriptBridge.js")
        loadJs("javascript:" + jsContent, null)
    }

    private fun assetFile2Str(context: Context?, urlStr: String?): String? {
        if (context == null || TextUtils.isEmpty(urlStr))
            return null
        var inputStream : InputStream? = null
        try {
            inputStream = context.assets.open(urlStr)
            val bufferedReader = BufferedReader(InputStreamReader(inputStream!!))
            var line: String?
            val sb = StringBuilder()
            do {
                line = bufferedReader.readLine()
                if (line != null && !line.matches("^\\s*//.*".toRegex())) {
                    sb.append(line)
                }
            } while (line != null)

            bufferedReader.close()
            inputStream.close()

            return sb.toString()
        } catch (e: Exception) {
            e.printStackTrace()
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close()
                } catch (e: IOException) {
                }

            }
        }
        return null
    }

    fun onDestroy() {
        registerFunctions.clear()
        mWebViewHolder = null
    }
}

其中 loadHuoqiuJavascriptBridge 方法在 webview 的 pagefinish 里面调用,之后就可以调用 registerFunction callFunction 来注册给 js 和调用 js 的方法了,另外 onDestroy 在 页面 onDestroy 调用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,264评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,549评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,389评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,616评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,461评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,351评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,776评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,414评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,722评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,760评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,537评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,381评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,787评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,030评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,304评论 1 252
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,734评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,943评论 2 336

推荐阅读更多精彩内容