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

·  阅读 1511

移动技术发展了七八年,开发人员永远有个跨平台的梦。从最开始的 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:github.com/al-liu/WebV…

它的特点是跨平台,支持 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 详情。

分类:
Android
标签: