XPage 系列|这次升级后终于是全自动化注册了!

b175f93d36ce6cc8f1cc25780d4df80866c312448c9c829e9c04008d743e8d72.png

前言

作为 X-Library 系列框架 的灵魂所在,XPage 开源两年以来,一直致力于降低 Fragment 使用的难度,努力实现一个 Activity 多 Fragment 的 Android 开发模式。

就在前不久,我就整理了 XPage 开源这几年来的使用情况,写了一篇《史上最方便的 Android 页面框架 XPage 使用指南》 ,并且还录了几期视频单独讲解了 XPage 的使用 ,让越来越多地人看到了 XPage 使用的便捷性。

但就在前几天,在交流群里突然有人问我下面几个问题:

上面的问题让我突然认识到一点:并不是所有人都对 APT 技术有所了解的。

看来我之前参考 ARouter 实现的自动注册功能可能并没有完善,难怪 ARouter 后来会写一个 arouter-register 插件来实现自动注册的功能。

于是乎,为了能够让 XPage 的自动注册功能更加完美,我加班加点开发,于是就有了 XPage 的 3.1.1 版本--彻底的自动化注册

升级后有什么变化

在感受全自动化页面注册带来的便利之前,让我们先来感受一下之前版本的使用。

3.1.1 之前版本

在 3.1.1 之前版本,在使用自动注册功能的时候,还是需要实现 PageConfiguration 接口,并调用编译时自动生成的页面配置类“moduleName”+PageConfig 的 getPages()方法返回注册的页面。

PageConfig.getInstance()
        .setPageConfiguration(new PageConfiguration() { //页面注册
            @Override
            public List<PageInfo> registerPages(Context context) {
                //自动注册页面,是编译时自动生成的,build一下就出来了。如果你还没使用@Page的话,暂时是不会生成的。
                return AppPageConfig.getInstance().getPages(); //自动注册页面
            }
        })
        .debug("PageLog")       //开启调试
        .setContainActivityClazz(XPageActivity.class) //设置默认的容器Activity
        .enableWatcher(false)   //设置是否开启内存泄露监测
        .init(this); 

可以看到,这里的自动注册还是需要一部分手动配合才能完成的。如果说你当前只有一个 module 的话,可能还好说。但是如果你使用了多个 module 之后,你就需要把多个 module 生成的配置类像上面那样一个一个地加进去,这样用起来会让人感觉非常的不方便,这明显违背了我写 XPage 框架的初衷!

不仅如此,这样写死还会带来其他很多问题:

3.1.1 之后版本

为了能够解决以上的问题,我实现了一个自动注册的配置类 AutoPageConfiguration 。那么下面就看一下最新版本的 XPage 是如何注册的吧:

PageConfig.getInstance()
        .debug("PageLog")       //开启调试
        .setContainActivityClazz(XPageActivity.class) //设置默认的容器Activity,按需设置(非必须)
        .init(this);            //初始化页面配置

是的,你没有看错,这里没有手动实现 PageConfiguration 接口的部分了,可以说是真正实现了全自动页面注册,是不是非常方便呀?

c6f2262f07737783eb7a97dafb41abde4476cb5e89e9d7b24f81d508248841fe.png

如何实现注册的自动化

看到上面的变化,你是不是非常想知道我是如何实现彻底的自动化注册的?

想要回答这个问题,还是让我们先看一看这个编译时自动生成的配置类是如何实现的。

APT 技术实现页面配置类的自动生成

其实当初实现页面配置类的自动生成的方案,也是我研读了 ARouter 源码之后,受到了 APT 技术的启发后完成的。

因为 XPage 实现路由跳转主要就是靠 PageInfo 和 Fragment 建立起来的映射关系。当时的思路就是采用 APT 技术,利用 @Page 注解去标识需要注册的 Fragment,然后在编译的时候通过 APT 技术去扫描出所有使用了 @Page 注解标识了的 Fragment,将注解信息转化为 PageInfo, 并按 module 生成对应的页面配置类,在这个配置类里面存放了该 module 下所有标注了 @Page 的页面信息 PageInfo

下面是自动生成的一个简单的配置类例子:

xpageconfig.png

可以看到,自动生成的配置类都会存放在 com.xuexiang.xpage.config 包下,类名都是以 PageConfig 作为结尾。注意这里非常关键,它是我后面实现自动化注册的关键。

详细的实现细节,可以参见 XPage 的页面配置自动生成器 PageConfigProcessor 的源码

运行时扫描指定包下的配置类反射实现自动注册

上面我们在了解页面配置类是如何自动生成的时候发现一个规律:

自动生成的配置类都会存放在 com.xuexiang.xpage.config 包下,类名都是以 PageConfig 作为结尾。

那么我们可不可以在运行的时候,直接扫描 com.xuexiang.xpage.config 包下的所有类,然后找到以 PageConfig 作为结尾的配置类,然后反射它的 getPages 方法直接获取到所有的配置信息,然后注册进去?

下面是我根据上面的猜想,实现的 AutoPageConfiguration 类源码:

public class AutoPageConfiguration implements PageConfiguration {
    /**
     * 页面配置所在的包名
     */
    private static final String PAGE_CONFIG_PACKAGE_NAME = "com.xuexiang.xpage.config";
    /**
     * 页面配置生成类的类后缀名
     */
    private static final String PAGE_CONFIG_CLASS_NAME_SUFFIX = "PageConfig";

    @Override
    public List<PageInfo> registerPages(Context context) {
        List<PageInfo> pageInfos = new ArrayList<>();
        Set<String> classSet = null;
        try {
            classSet = ClassUtils.getClassNames(context, PAGE_CONFIG_PACKAGE_NAME);
        } catch (Exception e) {
            e.printStackTrace();
        }
        if (classSet != null) {
            for (String className : classSet) {
                if (className != null && className.endsWith(PAGE_CONFIG_CLASS_NAME_SUFFIX)) {
                    try {
                        pageInfos.addAll(getPagesByClass(Class.forName(className)));
                    } catch (Exception e) {
                        PageLog.e(e);
                    }
                }
            }
        }
        return pageInfos;
    }

    private List<PageInfo> getPagesByClass(Class<?> clazz) throws Exception {
        // 获取单例对象
        Method getInstanceMethod = clazz.getDeclaredMethod("getInstance");
        getInstanceMethod.setAccessible(true);
        Object instance = getInstanceMethod.invoke(null);
        // 获取页面信息
        Method getPagesMethod = clazz.getDeclaredMethod("getPages");
        getPagesMethod.setAccessible(true);
        return (List<PageInfo>) getPagesMethod.invoke(instance);
    }
}

从源码中我们可以看到,我是这样做的:

有了 AutoPageConfiguration 之后,下面就非常简单啦,我们只需要将 mPageConfiguration 默认设置成 AutoPageConfiguration,这样就可以实现自动化注册啦!

/**
 * 初始化页面信息
 *
 * @param context 上下文
 */
private void initPages(Context context) {
    if (mPageConfiguration == null) {
        // 没有设置的话,就使用自动注册配置
        mPageConfiguration = new AutoPageConfiguration();
    }
    registerPageInfos(mPageConfiguration.registerPages(context));
    CoreConfig.init(context, getPages());
}

增加混淆配置

你以为到这儿就结束了?没那么简单!可以发现,上面的实现方案主要是依赖于扫描类并进行反射注册的。所以如果代码做了混淆了之后,该方案就会失效了,所以我们还需要在混淆配置清单中增加如下的配置来避免混淆:

-keep class com.xuexiang.xpage.config.** { *; }

我们要保证 com.xuexiang.xpage.config 包下的类不能被混淆。

到这儿,自动注册的实现算是真正的讲完了,下面让我们来瞧瞧 XPage 的新版本还有那些地方更新了!

c74856b4f940c8e41794ee18c2d3a9c012cb6dc66e3600ff7206069fb7d4abcf.png

其他更新

去除 LeakCanary 依赖

在此之前,XPage 一直依赖了 LeakCanary,主要原因还是 LeakCanary 在 2.0 版本之前的使用还是相当不方便的,于是我就做了一下默认集成以方便使用。

但是当 LeakCanary 升级到 2.0 以上版本的时候,这个问题似乎就没了。因为进行了重新的设计,LeakCanary 的使用变得没那么具有侵入性,因此我就考虑去除了 LeakCanary 的依赖。

优化了页面点击的键盘处理

之前在 XPageActivity 里面做了简单的页面点击处理:当用户点击到非输入框区域就隐藏键盘。

但是这样做了之后发现效果并不是很好,因为有些页面可能并不需要这个功能,如果把这个写到 Activity 里面的话,那么在这个 Activity 下的所有 Fragment 都将拥有这个功能,这样非常不灵活。

除此之外,使用者可能也想自定义屏幕的触摸事件,因此我对此做了重新设计,将触摸事件的处理下放至每个 Fragment 之中,由 Activity 调用指定的方法进行处理。

相关链接

最后

非常感谢大家对 XPage 的支持,喜欢的小伙伴可以到项目的 Github 主页:https://github.com/xuexiangjys/XPage 点击 star 支持一下哦!

更多资讯内容,欢迎微信搜索公众号:「我的 Android 开源之旅」

  • Android

    Android 是一种以 Linux 为基础的开放源码操作系统,主要使用于便携设备。2005 年由 Google 收购注资,并拉拢多家制造商组成开放手机联盟开发改良,逐渐扩展到到平板电脑及其他领域上。

    311 引用 • 308 回帖 • 446 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    344 引用 • 3267 回帖 • 516 关注
  • fragment
    4 引用 • 1 回帖
  • GitHub

    GitHub 于 2008 年上线,目前,除了 Git 代码仓库托管及基本的 Web 管理界面以外,还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱(报表)、代码片段分享(Gist)等功能。正因为这些功能所提供的便利,又经过长期的积累,GitHub 的用户活跃度很高,在开源世界里享有深远的声望,并形成了社交化编程文化(Social Coding)。

    189 引用 • 1951 回帖 • 169 关注

广告 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...