WebViewJsBridge-Android 做一个好用的桥接库

移动技术发展了七八年,开发人员永远有个跨平台的梦。从最开始的 Web App 被人诟病体验差,ReactNative,Weex 等技术又有很多难以平复的坑,包括现在的 Flutter 也有很多问题待解决,跨平台的梦想很美好,现实却总有这样那样的瑕疵。移动开发发展到今天,我认为最好的跨平台技术还是 H5 + Native 的混合开发模式。随着前端技术的飞速发展,如今可以依靠各种技术和工具对前端进行优化,使其在移动端的体验更接近原生水平。

我们在做混合开发(Hybrid App)时,绝对绕不开 JavaScript 与 Native(iOS & Android)之间的交互问题。现在主流的交互框架有 JsBridge,它可能是最早的 Android 与 JavaScript 桥接库,该库优点是接口简单,不用往 HTML 中引入额外的 js 文件,缺点是只支持 Android,同一个项目还要为 iOS 寻找一个对应的桥接库,另一个问题是对交互接口没有管理,大多数情况下我们把接口都写到一个 Activity 中的,造成代码堆积,接口不易维护。近几年还有一个比较好的桥接库是 DSBridge-Android,这个库相比 JsBridge 的优势是支持 Android 与 iOS,接口支持以类的方式管理,但是使用时需要往 HTML 中引入一个 js 文件,其实现方式是继承了 WebView,所以使用时要使用其改造后的 DWebView,我本人不喜欢这种对 WebView 的侵入方式。

我在其两个库的基础之上又造了一个轮子,这就是 WebViewJsBridge-Android,它首先支持 Android 与 iOS 两个端,接口与 JsBridge 相似,同样支持以类的方式管理交互接口,同样需要引入一个 js 文件(在 1.1.0 版本中可以不引用这个 js 文件),没有使用继承 WebView 这种侵入方式实现功能。

以下是 WebViewJsBridge-Android 的使用文档供大家参考:

WebViewJsBridge-Android

WebViewJsBridge-Android 是 HTML5 和 WebView 之间用于通讯的工具库。

WebViewJsBridge-iOS:https://github.com/al-liu/WebViewJsBridge-iOS

它的特点是跨平台,支持 iOS,Android,JavaScript,接口统一,简单易用。工具库的实现对 WebView 无侵入性。使用以类的方式来管理通信的接口,每个接口的实现类对应唯一的命名空间,如 ui.alert,ui 对应一个实现类的命名空间,alert 是该实现类的一个实现方法。在 1.1.0 版本中, H5 可以不引入 hcJsBridge.js 文件。

下面这张图帮助理解它们之间的关系:

WebViewJsBridge-namespace.png

系统版本要求

支持 API 19,Android4.4及以上的系统版本。

安装

Gradle

compile 'com.lhc:webviewjsbridge:1.1.0'

引入 WebViewJsBridge 的 js 文件

在 html 中 <script>引入 hcJsBridge.js</script>

注意: 1.1.0 版本 H5 可以不引入 hcJsBridge.js 文件,但使用方法有少许差异,后面有介绍。

Example 的说明

example 模块中提供完整使用示例,包括基础的调用演示和进阶用法,如,调用相机拍摄一张图片,使用 okhttp 发起一个 GET 请求。

使用方法

初始化原生的 WebViewJsBridge 环境

// WebView 要开启 JavaScriptEnabled
webSettings.setJavaScriptEnabled(true);
mJsBridge = WebViewJsBridge.newInstance(mMainWebView);

如果 H5 不引入 hcJsBridge.js,则还需要在 onPageFinished 中调用 injectWebViewJavascript 方法

mMainWebView.setWebViewClient(new WebViewClient() {
    @Override
    public void onPageFinished(WebView view, String url) {
        super.onPageFinished(view, url);
        mJsBridge.injectWebViewJavascript();
    }
});

原生注册接口实现类供 HTML5 调用

mJsBridge.addJsBridgeApiObject(new UIApiImpl(), "ui");
mJsBridge.addJsBridgeApiObject(new RequestApiImpl(weakReference), "request");

UIApiImpl 的实现类:

public class UIApiImpl {
    private static final String TAG = "UIApiImpl";
    
    @JavascriptInterface
    public void alert(JSONObject data, ResponseHandler<String> responseHandler){
        responseHandler.complete("native api alert'callback.");
    }
    // 实现类支持四种方法签名:
    // 有参数,有回调
    @JavascriptInterface
    public void test1(String data, ResponseHandler<String> responseHandler){
        responseHandler.complete("response data");
    }
    // 有参数,无回调
    @JavascriptInterface
    public void test2(JSONObject data){
        Log.d(TAG, String.format("Js native api:test2, data is:%s", data.toString()));
    }
    // 无参数,无回调
    @JavascriptInterface
    public void test3(){
        Log.d(TAG, "Js native api:test3");
    }
    // 无参数,有回调
    @JavascriptInterface
    public void test4(ResponseHandler<String> responseHandler){
        responseHandler.complete("response data");
    }
}

原生调用 HTML5 接口

mJsBridge.callHandler("test1", "test1 data", new ResponseHandler() {
    @Override
    public void complete(Object responseData) {
        Log.d(TAG, String.format("test1 callback data is:%s", responseData));
    }
});

初始化 HTML5 的 WebViewJsBridge 环境

如果 H5 引入 hcJsBridge.js,则使用下面的方式引入。

<!DOCTYPE html>
<html>
    <head>
        ...
        <script src="./hcJsBridge.js"> </script>
    </head>
    ...
</html>

如果 H5 不引入 hcJsBridge.js,则使用下面这个方法注册接口。

// 在这个 window._hcJsBridgeInitFinished 全局函数中等待 bridge 初始化完成,然后注册接口,初始调用。
window._hcJsBridgeInitFinished = function(bridge) {
    bridge.registerHandler("test1", function(data, callback) {
        callback('callback native,handlename is test1');
    })
    
    bridge.callHandler('ui.test3');
}

HTML5 注册接口供原生调用

hcJsBridge.registerHandler("testCallJs", function(data, callback) {
    log('Native call js ,handlename is testCallJs, data is:', data);
    callback('callback native, handlename is testCallJs');
})

HTML5 调用原生接口

var data = {foo: "bar"};
hcJsBridge.callHandler('ui.alert', data, function (responseData) {
    log('Js receives the response data returned by native, response data is', responseData);
})

开启 debug 日志

开启 debug 日志,将打印一些调用信息,辅助排查问题。debug 日志默认不开启。

mJsBridge.enableDebugLogging(true);

License

WebViewJsBridge-Android 使用 MIT license 发布,查看 LICENSE 详情。

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

推荐阅读更多精彩内容