EasyBridge:一种简单的js-bridge设计方案

最新推荐文章于 2021-05-27 16:55:55 发布

weixin_34007291

最新推荐文章于 2021-05-27 16:55:55 发布

阅读量92

点赞数

文章标签： javascript java 移动开发 ViewUI

原文链接：https://segmentfault.com/a/1190000014293135

版权

EasyBridge是一个简单易用的js-bridge的工具库，提供了日常开发中，JavaScript与Java之间通讯的能力，与其他常见的js-bridge工具库实现方案不同，EasyBridge具备以下几个特点：

基于Android WebView的addJavascriptInterface特性实现
提供了基于接口粒度的安全管理接口
轻量级，并且简单易用。以这个工具库作为依赖，只需要编写实际通讯接口

Principle

目前混合开发的方案包括：

EasyBridge就是一种简单的JSBridge解决方案。在众多的解决方案中，基本都是在利用系统的WebView所开放的接口，打开Java与JavaScript通讯的渠道，这些方案的实现原理分别包括：

拦截onJsPrompt()方法
当WebView中的页面调用了JavaScript当中的window.prompt()方法的时候，这个方法会被回调。而且这个方法不仅能获取到JavaScript传递过来的string字符串内容，同时也能返回一段string字符串内容被JavaScript接收到，是一个相当适合构建bridge的入口方法。
拦截shouldOverrideUrlLoading()方法
当页面重新load URL或者页面的iframe元素重新加载新的URL的时候，这个方法被回调。
addJavascriptInterface()接口
这个接口简单却强大，通过这个接口，我们能够直接把Java中定义的对象在JavaScript中映射出一个对应的对象，使其直接调用Java当中的方法，但是，在android 4.1及之前的版本存在着严重的漏洞，所以一直被忽视。

EasyBridge在众多的解决方案中，最终了选择了addJavascriptInterface()接口作为方案的基础，主要基于以下几点考量：

目前Android版本已经到了9.0版本，市面上Android4.4之前的版本手机占有率已经很低，很多业务都已经把最低兼容版本定在了4.2以上，在这种情况下可以不考量4.1以下存在的漏洞问题；
addJavascriptInterface()能够提供最简单的同步调用
addJavascriptInterface()与evaluateJavascript()/loadUrl结合，能够带来更加简单的异步调用的解决方案

方案结构

EasyBridge的方案结构如下图所示：

EasyBridge总共会向页面中注入两个JavaScript对象，：

easyBridge
在页面加载到25%以上的时候（onProgressChanged()），通过执行工具库中的一个js文件注入的。这个对象主要的作用是定义了业务页面的JavaScript代码调用native的Java代码的规范入口，对象中定义的一个最关键的函数就是callHandler(handlerName, args, callback)，这就是桥梁的入口。实际上在这个方法的内部，最终就是通过下面的_easybridge对象进入到Java代码层。
_easybridge
通过addJavascriptInterface()映射和注入的一个对象，这个对象提供了实质的入口方法enqueue()，在这个方法当中代码的路线从JavaScript层进入到了Java层，开启了两者的交互。

接口分发

实际上，我们可以通过@JavascriptInterface注解开放很多的接口给JavaScript层调用，也可以通过addJavascriptInterface()映射多个Java对象到JavaScript层，但是为了维护简单和通讯方便，EasyBridge的设计只提供了一个入口和一个出口。所有需要开放给JavaScript层的功能，都是通过构建接口实例进行处理。

接口的定义如下：

public interface BridgeHandler {

    String getHandlerName();

    void onCall(String parameters, ResultCallBack callBack);

    SecurityPolicyChecker securityPolicyChecker();
}

实际的工作流程如下图所示：

最开始初始化的时候需要注册所有可以被JavaScript层调用的业务接口。在运行的过程中，enqueue()入口当中会根据协议定义，通过接口名称找到对应的处理接口实例，并触发接口响应。并且最终的接口响应都在入口处进行回传。因此，实际上，_easybridge对象（在Java层中，其实是EasyBridge的实例）就是一个枢纽站，做任务的分派和结果的传递。

安全控制

EasyBridge的安全检查通过实现下面的接口对象来完成：

public interface SecurityPolicyChecker {
    boolean check(String url, String parameters);
}

内部提供了两级的安全控制策略，分别对应全局的安全控制策略和基于接口粒度的安全控制策略：

全局安全控制策略

在EasyBridgeWebView对象当中，持有SecurityPolicyChecker用于进行全局的安全检查。全局的安全检查在EasyBridge的内部发生在以下两个时机：

Java注入bridge的时候
根据当前加载的页面url和参数信息，判断是否需要在页面中注入bridge。如果被安全规则拦截，则之前通过addJavaScriptInterface()注入的对象会被移除，也不会向页面中注入bridge对象，确保安全。
JavaScript调用具体的Java接口的时候
在执行具体的Java开放的接口方法之前，也会先触发全局的安全检查规则。

基于接口粒度的安全控制策略

每一个BridgeHandler实例也都会持有一个SecurityPolicyChecker的实例，用于针对具体的开发接口设置安全检查规则。每一个接口在接收到分派的指令之前，会先调用其安全控制策略，根据当前加载的页面地址以及传入的指令参数判断是否需要进行指令的分派，否则将会直接命令安全受限，错误返回，结果调用。

Feture

✔️ 注入jsbridge重试机制

✔️ 使用apt技术注册handler

✔️ JavaScript调用Java功能

✔️ Java调用JavaScript功能

✔️ 安全控制策略

关于EasyBridge的feature的详细说明以及整个工具库的使用，可以参考我的GitHub仓库中的说明。

整个工具库比较简单和小巧，欢迎大家对这种实现方案存在的问题提出改进的意见，谢谢