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

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

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

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-architecture.png

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();
}

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


handler-execute.png

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

安全控制

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

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

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

全局安全控制策略

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

  1. Java注入bridge的时候

    根据当前加载的页面url和参数信息,判断是否需要在页面中注入bridge。如果被安全规则拦截,则之前通过addJavaScriptInterface()注入的对象会被移除,也不会向页面中注入bridge对象,确保安全。

  2. JavaScript调用具体的Java接口的时候

    在执行具体的Java开放的接口方法之前, 也会先触发全局的安全检查规则。

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

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

Feture

✔️ 注入jsbridge重试机制

✔️ 使用apt技术注册handler

✔️ JavaScript调用Java功能

✔️ Java调用JavaScript功能

✔️ 安全控制策略

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

整个工具库比较简单和小巧,目前开发自测阶段基本能够满足业务的需求(但还不确定存在哪些坑),欢迎大家对这种实现方案存在的问题提出改进的意见,谢谢

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