Android:从零开始打造自己的深度链接库(三):自定义XML协议

前言

之前我们把ARouter的原理分析了一遍,如果你是刚启动的新项目,建议立刻使用,哪天运营有这个需求了,你就可以牛逼的对他说,我早就已经做好了。

但是老项目就会有一丢丢的尴尬,所以我们要在ARouter的基础上,独立深度链接的功能,然后打造出加强版的深度链接库,我起名为DeepLinkSo。

正文

回顾一下ARouter的源码,我们记得他使用的是自定义注解,完成路由的注册和绑定。注解看上去高大上,但是在这里我认为存在一个致命的短板,那就是不够灵活

注解的局限性

注解的解析是在编译期间完成并生成源码,也就是说版本一经发布,注册的路由地址就无法发生改变,例如

1、 开启新的路由。例如个人信息页我们并没有配置路由,我们就无法通过深度链接打开这个网页,只能修改代码,然后重新发布版本解决这个问题。
2、关闭某个路由,因为某些原因某个页面要停止外部访问,也只能修改代码,然后重新发布版本。

所以几经思考,如果路由的配置文件能够从网上下载更新的话,是不是就能让深度链接更佳灵活呢?

于是我选择了使用XML。
使用注解可以在编译期间生成源码,节省了启动时间,但是牺牲了灵活性。
使用XML恰恰相反,没有增加编译时间,而是增加了启动时间,但是我们的XML还是很小的,经过测试也就10毫秒左右,还在可以接受的范围内。

自定义XML协议

XML协议无论在前端后端都被广泛的使用,而且Android对XML解析的有很好的支持,复习一下XML解析的三种方式:

1、SAX解析
2、Pull解析(推荐)
3、Dom解析

Android推荐使用Pull解析,轻量快速,所以我们也选择使用Pull解析。

首先制定好我们的XML格式:

<?xml version="1.0" encoding="utf-8"?>
<DeepLinkSo>

    <!-- 版本号 -->
    <version value="1" />

    <!-- 拦截器会按照配置的顺序依次执行 -->
    <common-interceptors>
        <common-interceptor>com.lzp.deeplinkso.demo.interceptor.TestInterceptor</common-interceptor>
    </common-interceptors>

    <!-- 所有需要支持DeepLink的文件列表 -->
    <list>

        <!-- 跳转的页面 -->
        <Activity>
            <class>com.lzp.deeplinkso.demo.MainActivity</class>
            <page>main</page>
        </Activity>

        <!-- 跳转的页面 -->
        <Activity>
            <class>com.lzp.deeplinkso.demo.TestActivity</class>
            <page>test</page>
            <!-- 需要的参数 -->
            <params>
                <key type="Long" value="userId" />
                <key value="userName" />
            </params>
            <!-- 是否跳过公共Interceptor -->
            <skipCommonInterceptor>true</skipCommonInterceptor>
            <!-- 私有拦截器 -->
            <!--<interceptors>-->
                <!--<interceptor>com.lzp.deeplinkso.demo.interceptor.TestInterceptor</interceptor>-->
            <!--</interceptors>-->
        </Activity>

        <!-- 自定义事件 -->
        <Event>
            <class>com.lzp.deeplinkso.demo.handler.TestEventHandler</class>
            <page>event</page>
            <params>
                <key value="eventId" />
            </params>
        </Event>

    </list>

</DeepLinkSo>

我们在XML制定了以下内容:

1、版本号。可以根据降级和升级做一些操作。
2、全局拦截器。所有的跳转都会经过拦截处理,我们可以在跳转中设置跳过全局拦截器。
3、跳转的页面。可以设置对应的路由地址,跳转的参数,私有拦截器等。
4、自定义事件。设置和页面是一样的,只是不跳转页面。

这样我们的功能已经算是很全面了,接下来我们可以通过解析XML,保存所有的配置信息:

class DeepLinkSoConfig {

    /**
     * 当前版本号
     *
     *  无实际作用,仅仅是为了区别xml的版本
     * */
    private var version = "0"

    internal var listener: IDeepLinkSoListener? = null

    /**
     * 保存跳转Activity配置项
     * */
    private val activityOptionMap = HashMap<String, DeepLinkSoActivityOption>()

    /**
     * 保存自定义事件配置项
     * */
    private val eventOptionMap = HashMap<String, DeepLinkSoEventOption>()

    /**
     * 自定义拦截器
     * */
    internal var interceptors: ArrayList<IDeepLinkSoInterceptor>? = null

    internal fun setVersionCode(version: String) {
        this.version = version
    }

    fun getVersionCode() = this.version

    /**
     *  添加配置项
     * */
    internal fun addOption(key: String, option: DeepLinkSoOption) {
        when (option) {
            is DeepLinkSoActivityOption -> activityOptionMap[key] = option
            is DeepLinkSoEventOption -> eventOptionMap[key] = option
        }
    }

    /**
     *  添加配置项
     * */
    internal fun getOption(key: String): DeepLinkSoOption? {
        return activityOptionMap[key] ?: eventOptionMap[key]
    }

    /**
     *  获取Activity配置项
     * */
    internal fun getActivityOption(key: String) = activityOptionMap[key]

    /**
     *  获取Event配置项
     * */
    internal fun getEventOption(key: String) = eventOptionMap[key]

    /**
     * 清除配置项
     * */
    internal fun reset() {
        activityOptionMap.clear()
        eventOptionMap.clear()
        interceptors?.clear()
    }

}

解析的过程就不贴了,到此为止,我们已经为具体的开发做好了准备。

总结

今天我们分析了并制定了深度链接库的XML协议,思考了使用注解和XML的优劣点,为之后的功能开发做好准备。

下一篇:Android:从零开始打造自己的深度链接库(四):DeepLinkSo实战

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