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实战

    原文作者:珠穆朗玛小王子
    原文地址: https://www.jianshu.com/p/85441eddb589
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞