利用APT处理应用内跳转协议

概述

之前看过天猫的关于统跳协议的文章。 其实跳转协议这东西,应该属于稍微成熟一点的app的必备模块。

跳转协议主要为了解决 app 的几个问题:

  • 应用外到应用内的跳转
  • 应用内部的跳转。 尤其在大型项目上, 不同的模块之间的跳转
  • H5 与 native 之间的跳转

处理方式

为每个项目定义一个专属的协议, 例如:
yxl://github.io/o.c?action=login
其中:
yxl :协议
github.io : host
o.c :路径
action :当前链接的动作, 即打开 login 页面。 后面可继续加参数

当内部组件收到跳转链接, 并解析出符合定义的 action 之后, 根据 action 值跳转到对应的界面。一般为了节省跳转链接占用字符的长度, 路径不设置。

处理逻辑很简单, 但是能够跳转的前提是对应的 action 已经被定义过了, 组件知道要跳转到哪。 所以在应用启动的时候就需要将所有的 action 动作都注入到组件内。

最开始我们的解决办法是手工注入。由于不同的模块都在不同的 Module 下开发, 我们定义了一个统一的接口, 应用启动的时候会逐一调去每个 module 的启动接口, 然后在这个内各自将自己的 actions 注入到跳转组件内。

这种处理方法太繁琐, 开发人员不仅需要定义处理, 还需要记着主动注入。 而且这种操作增加一个减少一个或者某个需要修改,牵扯的地方都很多, 维护性上也不好。

升级方案

利用 apt 技术, 开发人员创建 action 的处理类的时候, 通过注解标注对应的 action 动作。 然后通过 apt 插件在编译过程扫描生成一个包含所有 action 对象的清单文件, 在 app 启动的时候根据这个清单自动加载就可以。

开源库

处理代码已开源在 github bjaction 仓库。

集成方式:
  • 在 project 的 build.gradle 文件中引入 apt 插件

'com.neenbedankt.gradle.plugins:android-apt:1.8'

  • 在需要处理跳转的 module 的 build.gradle 文件增加插件和类库依赖

apply plugin: 'com.neenbedankt.android-apt'

compile 'io.github.yangxlei:bjaction:1.0.0'
apt 'io.github.yangxlei:bjaction-compile:1.0.0'

使用
@ActionType("test2")
public class Test2Action implements BJAction.BJActionHandler {

    @Override
    public void doPerform(Context context, String type, Map<String, String> payload) {
        Test2Activity.launch(context);
    }
}

创建一个 BJActionHandler 的子类, 并使用 @ActionType 标注对应的 action 值.

bjaction-compile 会为每个 module 生成一个 ModuleActionTypes
的 java 文件。 在 应用启动时注入到 bjaction 组件内。

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        //yxl://github.io/o.c?action=xx&xx=xx
        BJActionUtil.initialize("yxl", "github.io", "o.c", "action", new BJActionUtil.BJActionDefaultHandler() {
            @Override
            public void onHandleDefault(Context context, String schema) {
                //goto webview
            }
        });
      //加载每个 module 的 ModuleActionTypes 配置
       BJActionUtil.loadActions(io.github.yangxlei.actionhandle.actions.ModuleActionTypes.getModuleActionTypes());
        BJActionUtil.loadActions(yangxlei.github.io.app2.actions.ModuleActionTypes.getModuleActionTypes());

    }
}

在应用启动时, 同样将 schema, host, action 初始化到 bjaction 组件内。

执行跳转

  findViewById(R.id.button_test1).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                BJActionUtil.sendToTarget(MainActivity.this, /*yxl://github.io/o.c?action=test1*/
                        BJActionUtil.buildActionUrl("test1", null));
            }
        });

其实不光只是跳转, 可以通过协议定义任何的 action ,执行任何操作; 因为 action 也是单独定义的, 所以不需要修改原来的任何东西。

参考资料:

javapoet
android-apt

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 接女儿放学回家,在车上我们三个人聊天,是一天中最开心的事。 可儿:“今天政治老师上课,抛了一个尴尬的话题。你们有哪...
    博雅亲子阅读阅读 182评论 0 1
  • 说起社交那腾讯是当之无愧,以前是QQ现在是微信,做到风山水起的,但是现在QQ偏向了年轻化的中学生,微信更多的是上班...
    杨小龙说阅读 529评论 0 1
  • 记忆回到渐渐遥远的那天,我因为头巨疼提前下班回家,你在我家门口等着我,然后进屋给我端水递药。我在沙发上难受的睁不开...
    印子二三事阅读 303评论 0 0