Android 页面多状态布局管理

一、现状

页面多状态布局是开发中常见的需求,即页面在不同状态需要显示不同的布局,实现的方式也比较多,最简单粗暴的方式就是在 XML 中先将不同状态对应的布局隐藏起来,根据需要改变其可见状态,如果多个界面公用相同的状态布局,缺点也很明显,繁琐、重复、不优雅等,类似的实现也可以使用 ViewStub,这样性能会更好些。所以我们要做的就是尽可能避免这些方式所导致的问题,更加高效、优雅的管理不同的状态布局。

二、目标

我们要实现的 StatusView 要实现的主要功能如下:

  • 可在 Activity、Fragment 、XML 中使用,可作用于XML的根布局View或其子View
  • 支持默认的状态布局,可进行常规配置
  • 可自定义状态布局
  • 状态布局懒加载,仅在初次显示时初始化

效果预览如下:


preview

三、实现

这里只对实现过程中一些比较重要的点进行分析。

3.1、初始化

首先有一个最重要的知识点需要明确,XML 布局中的每个View都有其对应的父 View,必然在其父View中都有固定的位置,如果是 Activity 对应的 XML,那XML根布局View的父View是谁呢?其实就是一个 id 为android.R.id.content的 View,如果是 Fragment 对应的 XML,那 XML 根布局 View 的父 View 可以通过fragment.getView()方法得到。所以现在我们可以得到XML 中每一个View和对应的 LayoutParams 位置信息。

既然有了 View 和其对应的 LayoutParams 位置信息,就可以通过其父 View 将指定的子 View 移除掉,然后将 StatusView 添加到被移除的 View 的位置,进而就可以控制 StatusView 来切换不同的状态布局。

简单总结下,就是用 StatusView 替换掉要进行多状态布局切换的 View,这个 View 可以时 XML 中的任意 View。这也是直接在 Activity、Fragment 中使用 StatusView 要做的核心初始化工作。

那么 StatusView 又是个什么呢?其实就是一个继承了FrameLayout的 ViewGroup,之所以要继承 FrameLayout,因为 StatusView 此时仅仅是作为父容器存在的,并不关心内部各种状态 View 的具体情况,所以使用 FrameLayout 就够了,更有通用性。这样 StatusView 也就可以在 XML 中使用了

先将上边这部分内容转化成代码:

public class StatusView extends FrameLayout {
    ......
    /**
     * 在 Activity 中的初始化方法,默认页面的根布局使用多状态布局
     */
    public static StatusView init(Activity activity) {
        View contentView = ((ViewGroup) activity.findViewById(android.R.id.content)).getChildAt(0);
        return init(contentView);
    }

    /**
     * 在 Activity 中的初始化方法
     * @param viewId   使用多状态布局的 ViewId
     */
    public static StatusView init(Activity activity, @IdRes int viewId) {
        View rootView = ((ViewGroup) activity.findViewById(android.R.id.content)).getChildAt(0);
        View contentView = rootView.findViewById(viewId);
        return init(contentView);
    }

    /**
     * 在Fragment中的初始化方法
     * @param viewId   使用多状态布局的 ViewId
     */
    public static StatusView init(Fragment fragment, @IdRes int viewId) {
        View rootView = fragment.getView();
        View contentView = null;
        if (rootView != null) {
            contentView = rootView.findViewById(viewId);
        }
        return init(contentView);
    }

    /**
     * 用 StatusView 替换要使用多状态布局的 View
     */
    private static StatusView init(View contentView) {
        if (contentView == null) {
            throw new RuntimeException("ContentView can not be null!");
        }
        ViewGroup parent = (ViewGroup) contentView.getParent();
        if (parent == null) {
            throw new RuntimeException("ContentView must have a parent view!");
        }
        ViewGroup.LayoutParams lp = contentView.getLayoutParams();
        int index = parent.indexOfChild(contentView);
        parent.removeView(contentView);
        StatusView statusView = new StatusView(contentView.getContext());
        statusView.addView(contentView);
        statusView.setContentView(contentView);
        parent.addView(statusView, index, lp);
        return statusView;
    }
    ......
}

如果在 XML 中使用 StatusView 如何进行初始化呢,自然是通过onFinishInflate()方法:

@Override
protected void onFinishInflate() {
    super.onFinishInflate();
    if (getChildCount() == 1) {
        View view = getChildAt(0);
        setContentView(view);
    }
}
3.2、状态布局的切换

StatusView 默认支持 Loading、Empty、Error 三种状态布局,加上原始的页面内容布局,一共四种。切换状态布局时,我们做法是直接从 StatusView 中移除掉正在显示的状态布局,然后添加要显示的状态布局:

private void switchStatusView(View statusView) {
    if (statusView == currentView) {
        return;
    }
    removeView(currentView);
    currentView = statusView;
    addView(currentView);
}
3.3、状态布局的懒加载

在APP使用环境良好的情况下,有些状态布局可能根本没有显示的机会,如果在初始化时一股脑的加载出来自然不可取,影响性能,所以我们要做的就是按需加载,即仅在状态布局初次显示时加载并初始化,之后复用即可:

private View generateStatusView(@LayoutRes int layoutId) {
        View statusView = viewArray.get(layoutId);
        if (statusView == null) {
            statusView = inflate(layoutId);
            viewArray.put(layoutId, statusView);
            configStatusView(layoutId, statusView);
        }
        return statusView;
    }
3.4、更自由的用法

一般的多状态布局管理都会提供默认的 Loading、Empty、Error 三种状态布局,并可以自定义对应的状态布局, 并提供对应的开放 api。但这样会有些局限性,如果有其它业务场景的状态布局,虽然布局文件可以自定义,但原有的api方法调用起来难免会有违和感,并不友好!所以有必要在常用业务场景的基础上再提供更加通用的api方法,并不局限于特定的场景。

目前的做法是用状态布局和对应的索引之间的关系来实现:

// 添加指定索引对应的状态布局
statusView.setStatusView(int index, @LayoutRes int layoutId)
// 为指定索引的状态布局设置初次显示的监听事件,用来进行状态布局的相关初始化
statusView.setOnStatusViewConvertListener(int index, StatusViewConvertListener listener)
// 显示指定索引的状态布局
statusView.showStatusView(int index)
3.5、注意事项
  • 当 Fragment 布局文件的根 View 使用 StatusView 时,为避免出现的异常问题,建议在 XML 中初始化!
  • 当直接在 Fragment 中使用时,init()方法需要在onCreateView()之后的生命周期方法中执行!
  • 由于StatusView 继承自 FrameLayout,所以会多一层布局嵌套。

主要的点就这么多了,剩下的就是些属性配置的内容,其实挺简单的,更多细节和用法可参考GitHub:StatusView

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,568评论 25 707
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,473评论 2 59
  • 专业矮子二十年,我为矮子做代言!欲问矮子有啥好,多的让你数不完! 作为一名合格的矮子,我来讲讲“矮子王国”的独有“...
    周木槿阅读 1,916评论 0 1
  • 送完站和Puppy回到家中,睡意全无,心中塞满了不舍与离别的伤感,屋子显得更大了,也许离别就是思念的开始……...
    AprilFriday阅读 117评论 1 2
  • 新疆的秋天过去了,乌市的温度降到了个位数。放假风波后,终于得到消息还是可以回家的。 很早之前就订了回家的火车票,妹...
    Wind_bca3阅读 124评论 0 0