缘起

页面状态管理是每个app都要考虑的问题--第一次进入显示正在加载中的页面,内容为空的页面,发生错误页面.
段位低一点的,在BaseActivity和BaseFragment中写个方法
段位高一点的,自己造一个包含这几个状态的Layout的轮子(LoadingLayout之类的),在layout文件中使用.

but,每次要管理页面状态时都要在xml中用这个layout包裹我们的内容,不繁琐么?有没有更好的方法?

有的,看这里PageStateManager.不用修改xml,直接一行代码调用就可以嵌入那几个带状态的页面.(基于张鸿洋的LoadingAndRetryManager改写而来的,封装了常用逻辑,优化了相关api).

原理

用代码来插入一层Framelayout来管理页面状态,而不是自己手写到xml.

参数传入需要管理的activity/fragment/view,
然后拿到对应的contentview/view的parent
将contentview/view从parent中移除.
new 一个framlayout,添加loading,error,empty的view,同时也添加contentview/view.
将这个framlayout添加到parent.

提供一个管理类来配置loading,error,empty,以及控制其显示与隐藏操作.

核心代码

    contentParent.removeView(oldContent);
    //setup content layout
    PageLayout loadingAndRetryLayout = new PageLayout(context);

    ViewGroup.LayoutParams lp = oldContent.getLayoutParams();
    contentParent.addView(loadingAndRetryLayout, index, lp);
    loadingAndRetryLayout.setContentView(oldContent);
    // setup loading,retry,empty layout
    setupLoadingLayout(listener, loadingAndRetryLayout);
    setupRetryLayout(listener, loadingAndRetryLayout);
    setupEmptyLayout(listener, loadingAndRetryLayout);

api设计

要设计一个适合大多数应用的页面状态管理类,知晓大多数app的页面管理逻辑即可,哪里用得着提供那么多的setXxx来高度自定义样式?

1. 每个app的状态页面都有自己的风格,所以在Application中初始化时,应该有设置这几个页面的方法.
2. app内部,"加载中"的页面一般全app都是统一的,不会出现这个页面的loading状态页和那个页面的loading状态页不一致的情况.
3. app内部,空白页面一般由图片+文字构成,图片大多一致,而文字说明可能会不一致.
4. app内部,错误页面一般由图片+说明文字+重试按钮 组成,说明文字一般都会不一致.
5. 点击错误页面按钮后重试,重试的逻辑一般是,判断有没有网络,没有就去设置,有的话就重新执行网络请求.
6. 考虑到确实有的地方状态页面跟整个app的完全不同,也提供了在页面内独立设置这几个状态页面的API.

基于上面的思路,提供的API有:

BaseApplication里的初始化

public static void initInApp(Context appContext)//使用默认提供的几个状态页面

/**
自定义状态页面,传入相应的layout文件的id即可.
* 如果需要后续调用自定义空白msg,错误msg字符串的api,则页面中显示该字符串的textview的id必须为tv_msg_empty,tv_msg_error
*/
    public static void initInApp(Context appContext,int layoutIdOfEmpty,int layoutIdOfLoading,int layoutIdOfError)

页面中生成PageManager对象

  /**
     *
     * @param container  必须为activity,fragment或者view.如果是view,则该view对象必须有parent
     * @param retryAction 点击重试的动作,注意,只需要关注有网络的情况,无网络状态时已经封装好:弹出对话框询问用户是否去设置网络
     * @param isShowLoadingOrContent 第一次是显示loading(true)还是content(false)
     * @return 当前页面的状态管理器
     */
    public static PageManager init(final Object container, boolean isShowLoadingOrContent ,final Runnable retryAction)
    
    //如果当前页面的空白状态下,提示语需要自定义,则调用此方法
    public static PageManager init(final Object container, final CharSequence emptyMsg, boolean isShowLoadingOrContent ,final Runnable retryAction)

控制页面状态

public void showLoading()
public void showContent()
public void showEmpty()
public void showError()
public void showError(CharSequence errorMsg)

如果需要针对单个Activity、Fragment、View定制页面，则调用generate方法,并重写 一个重写接口的回调方法:

PageManager.generate(this, new PageListener() {
        @Override
        public void setRetryEvent(View retryView) {
            
        }

        @Override
        public int generateEmptyLayoutId() {
            return super.generateEmptyLayoutId();
        }

        @Override
        public int generateLoadingLayoutId() {
            return super.generateLoadingLayoutId();
        }

        @Override
        public int generateRetryLayoutId() {
            return super.generateRetryLayoutId();
        }
    });

默认提供了三个状态页:

注意事项

1.给view对象设置状态时,该对象必须有parent.
2.失败页面的无网络状态已经处理,runnable里只需要包装有网络时的处理动作.

代码地址

https://github.com/hss01248/PageStateManager