android状态管理优化

43次阅读

共计 22726 个字符,预计需要花费 57 分钟才能阅读完成。

目录介绍

  • 01. 界面状态有哪些
  • 02. 采用 include 方式管理
  • 03. 在 Base 类中处理逻辑
  • 04. 如何降低偶性和入侵性
  • 05. 封装低入侵性状态库

    • 5.1 自定义帧布局
    • 5.2 自定义状态管理器
    • 5.3 如何管理多种状态
  • 06. 封装库极致优化点说明

    • 6.1 用 ViewStub 显示布局
    • 6.2 处理重新加载逻辑
  • 07. 如何使用该封装库

好消息

  • 博客笔记大汇总【16 年 3 月到至今】,包括 Java 基础及深入知识点,Android 技术博客,Python 学习笔记等等,还包括平时开发中遇到的 bug 汇总,当然也在工作之余收集了大量的面试题,长期更新维护并且修正,持续完善……开源的文件是 markdown 格式的!同时也开源了生活博客,从 12 年起,积累共计 N 篇 [近 100 万字,陆续搬到网上],转载请注明出处,谢谢!
  • 链接地址:https://github.com/yangchong2…
  • 如果觉得好,可以 star 一下,谢谢!当然也欢迎提出建议,万事起于忽微,量变引起质变!

01. 界面状态有哪些

  • 在 Android 中,不管是 activity 或者 fragment,在加载视图的时候都有可能会出现多种不同的状态页面 View。比如常见的就有这些:

    • 内容界面,也就是正常有数据页面
    • 加载数据中,加载 loading
    • 加载数据错误,请求数据异常
    • 加载后没有数据,请求数据为空
    • 没有网络,网络异常
  • 同时,思考一下几个问题。

    • 怎样切换界面状态?有些界面想定制自定义状态?状态如何添加点击事件?下面就为解决这些问题!
  • 为何要这样?

    • 一般在加载网络数据时,需要用户等待的场景,显示一个加载的 Loading 动画可以让用户知道 App 正在加载数据,而不是程序卡死,从而给用户较好的使用体验。
    • 当加载的数据为空时显示一个数据为空的视图、在数据加载失败时显示加载失败对应的 UI 并支持点击重试会比白屏的用户体验更好一些。
    • 加载中、加载失败、空数据等不同状态页面风格,一般来说在 App 内的所有页面中需要保持一致,也就是需要做到全局统一。

02. 采用 include 方式管理

  • 直接把这些界面 include 到 main 界面中,然后动态去切换界面,具体一点的做法如下所示。

    • 在布局中,会存放多个状态的布局。然后在页面中根据逻辑将对应的布局给显示或者隐藏,但存在诸多问题。
    <?xml version="1.0" encoding="utf-8"?>
    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        android:id="@+id/activity_main"
        android:orientation="vertical"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
    
        <!-- 正常时布局 -->
        <include layout="@layout/activity_content"/>
        <!-- 加载 loading 布局 -->
        <include layout="@layout/activity_loading"/>
        <!-- 异常时布局 -->
        <include layout="@layout/activity_error"/>
        <!-- 空数据时布局 -->
        <include layout="@layout/activity_emptydata"/>
    
    </LinearLayout>
  • 存在的问题分析

    • 后来发现这样处理不容易复用到其他项目中,代码复用性很低
    • 在 activity 中处理这些状态的显示和隐藏比较乱
    • 调用 setContentView 方法时,是将所有的布局给加载绘制出来。其实没有必要
    • 如果将逻辑写在 BaseActivity 中,利用子类继承父类特性,在父类中写切换状态,但有些界面如果没有继承父类,又该如何处理

03. 在 Base 类中处理逻辑

  • 首先是定义一个自定义的控件,比如把它命名成 LoadingView,然后在这个里面 include 一个布局,该布局包含一些不同状态的视图。代码思路如下所示:

    public class LoadingView extends LinearLayout implements View.OnClickListener {
    
        public static final int LOADING = 0;
        public static final int STOP_LOADING = 1;
        public static final int NO_DATA = 2;
        public static final int NO_NETWORK = 3;
        public static final int GONE = 4;
        public static final int LOADING_DIALOG = 5;
    
        private TextView mNoDataTextView;
        private ProgressBar mLoadingProgressBar;
        private RelativeLayout mRlError;
        private LinearLayout mLlLoading;
        private View mView;
    
        private OnRefreshListener mListener;
    
        public void setRefrechListener(OnRefreshListener mListener) {this.mListener = mListener;}
    
        public interface OnRefreshListener {void refresh();
        }
    
        public LoadingView(Context context) {super(context);
            init(context);
        }
    
        public LoadingView(Context context, AttributeSet attrs) {super(context, attrs);
            init(context);
        }
    
        public LoadingView(Context context, AttributeSet attrs, int defStyleAttr) {super(context, attrs, defStyleAttr);
            init(context);
        }
    
        private void init(Context context) {LayoutInflater inflater = (LayoutInflater) context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
            mView = inflater.inflate(R.layout.common_loading_get, this);
            mLoadingProgressBar = (ProgressBar) mView.findViewById(R.id.mLoadingProgressBar);
            mNoDataTextView  = (TextView) mView.findViewById(R.id.mNoDataTextView);
            mLlLoading = (LinearLayout) mView.findViewById(R.id.ll_loading);
            mRlError = (RelativeLayout) mView.findViewById(R.id.rl_error);
            mRlError.setOnClickListener(this);
            setStatue(GONE);
        }
    
        public void setStatue(int status) {setVisibility(View.VISIBLE);
            try {if (status == LOADING) {// 更新
                    mRlError.setVisibility(View.GONE);
                    mLlLoading.setVisibility(View.VISIBLE);
                } else if (status == STOP_LOADING) {setVisibility(View.GONE);
                } else if (status == NO_DATA) {// 无数据情况
                    mRlError.setVisibility(View.VISIBLE);
                    mLlLoading.setVisibility(View.GONE);
                    mNoDataTextView.setText("暂无数据");
                } else if (status == NO_NETWORK) {// 无网络情况
                    mRlError.setVisibility(View.VISIBLE);
                    mLlLoading.setVisibility(View.GONE);
                    mNoDataTextView.setText("网络加载失败,点击重新加载");
                } else {setVisibility(View.GONE);
                }
            } catch (OutOfMemoryError e) {}}
    
        @Override
        public void onClick(View v) {mListener.refresh();
            setStatue(LOADING);
        }
    }
  • 然后在 BaseActivity/BaseFragment 中封装 LoadingView 的初始化逻辑,并封装加载状态切换时的 UI 显示逻辑,暴露给子类以下方法:

    void showLoading(); // 调用此方法显示加载中的动画
    void showLoadFailed(); // 调用此方法显示加载失败界面
    void showEmpty(); // 调用此方法显示空页面
    void onClickRetry(); // 子类中实现,点击重试的回调方法 
    • 在 BaseActivity/BaseFragment 的子类中可通过上一步的封装比较方便地使用加载状态显示功能。这种使用方式耦合度太高,每个页面的布局文件中都需要添加 LoadingView,使用起来不方便而且维护成本较高,比如说有时候异常状态的布局各个页面不同,那么难以自定义处理,修改起来成本较高。
    • 同时如果是要用这种状态管理工具,则需要在需要的页面布局中添加该 LoadingView 视图。这样也能够完成需求,但是感觉有点麻烦。
  • 具体如何使用它进行状态管理呢?可以看到在对应的布局中需要写上 LoadingView

    <?xml version="1.0" encoding="utf-8"?>
    <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
    
        <com.cheoo.app.view.recyclerview.TypeRecyclerView
            android:id="@+id/mRecyclerView"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:overScrollMode="never"
            android:scrollbars="none">
    
        </com.cheoo.app.view.recyclerview.TypeRecyclerView>
    
        <com.cheoo.app.view.LoadingView
            android:id="@+id/mLoadingView"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
    
    </RelativeLayout>
  • 那么,如果某个子类不想继承 BaseActivity 类,如何使用该状态管理器呢?代码中可以这种使用。

    mLoadingView  = (LoadingView)findViewById(R.id.mLoadingView);
    mLoadingView.setStatue(LoadingView.LOADING);
    mLoadingView.setStatue(LoadingView.STOP_LOADING);
    mLoadingView.setStatue(LoadingView.NO_NETWORK);
    mLoadingView.setStatue(LoadingView.NO_DATA);

04. 如何降低偶性和入侵性

  • 让 View 状态的切换和 Activity 彻底分离开,必须把这些状态 View 都封装到一个管理类中,然后暴露出几个方法来实现 View 之间的切换。

在不同的项目中可以需要的 View 也不一样,所以考虑把管理类设计成 builder 模式来自由的添加需要的状态 View。

  • 那么如何降低耦合性,让代码入侵性低。方便维护和修改,且移植性强呢?大概具备这样的条件……

    • 可以运用在 activity 或者 fragment 中
    • 不需要在布局中添加 LoadingView,而是统一管理不同状态视图,同时暴露对外设置自定义状态视图方法,方便 UI 特定页面定制
    • 支持设置自定义不同状态视图,即使在 BaseActivity 统一处理状态视图管理,也支持单个页面定制
    • 在加载视图的时候像异常和空页面能否用 ViewStub 代替,这样减少绘制,只有等到出现异常和空页面时,才将视图给 inflate 出来
    • 当页面出现网络异常页面,空页面等,页面会有交互事件,这时候可以设置点击设置网络或者点击重新加载等等

05. 封装低入侵性状态库

5.1 自定义帧布局

  • 首先需要自定义一个状态 StateFrameLayout 布局,它是继承 FrameLayout。在这个类中,目前是设置五种不同状态的视图布局,主要的功能操作是显示或者隐藏布局。为了后期代码维护性,根据面向对象的思想,类尽量保证单一职责,所以关于状态切换,以及设置自定义状态布局,把这个功能分离处理,放到一个 StateLayoutManager 中处理。

    • 看代码可知,这个类的功能非常明确,就是隐藏或者展示视图作用。
    /**
     * <pre>
     *     @author yangchong
     *     blog  : https://github.com/yangchong211/YCStateLayout
     *     time  : 2017/7/6
     *     desc  : 自定义帧布局
     *     revise:
     * </pre>
     */
    public class StateFrameLayout extends FrameLayout {
    
        /**
         *  loading 加载 id
         */
        public static final int LAYOUT_LOADING_ID = 1;
    
        /**
         *  内容 id
         */
        public static final int LAYOUT_CONTENT_ID = 2;
    
        /**
         *  异常 id
         */
        public static final int LAYOUT_ERROR_ID = 3;
    
        /**
         *  网络异常 id
         */
        public static final int LAYOUT_NETWORK_ERROR_ID = 4;
    
        /**
         *  空数据 id
         */
        public static final int LAYOUT_EMPTY_DATA_ID = 5;
    
        /**
         *  存放布局集合
         */
        private SparseArray<View> layoutSparseArray = new SparseArray<>();
    
        //private HashMap<Integer,View> map = new HashMap<>();
    
        /**
         *  布局管理器
         */
        private StateLayoutManager mStatusLayoutManager;
    
    
        public StateFrameLayout(Context context) {super(context);
        }
    
        public StateFrameLayout(Context context, AttributeSet attrs) {super(context, attrs);
        }
    
        public StateFrameLayout(Context context, AttributeSet attrs, int defStyleAttr) {super(context, attrs, defStyleAttr);
        }
    
    
        public void setStatusLayoutManager(StateLayoutManager statusLayoutManager) {
            mStatusLayoutManager = statusLayoutManager;
            // 添加所有的布局到帧布局
            addAllLayoutToRootLayout();}
    
        private void addAllLayoutToRootLayout() {if (mStatusLayoutManager.contentLayoutResId != 0) {addLayoutResId(mStatusLayoutManager.contentLayoutResId, StateFrameLayout.LAYOUT_CONTENT_ID);
            }
            if (mStatusLayoutManager.loadingLayoutResId != 0) {addLayoutResId(mStatusLayoutManager.loadingLayoutResId, StateFrameLayout.LAYOUT_LOADING_ID);
            }
    
            if (mStatusLayoutManager.emptyDataVs != null) {addView(mStatusLayoutManager.emptyDataVs);
            }
            if (mStatusLayoutManager.errorVs != null) {addView(mStatusLayoutManager.errorVs);
            }
            if (mStatusLayoutManager.netWorkErrorVs != null) {addView(mStatusLayoutManager.netWorkErrorVs);
            }
        }
    
        private void addLayoutResId(@LayoutRes int layoutResId, int id) {View resView = LayoutInflater.from(mStatusLayoutManager.context).inflate(layoutResId, null);
            layoutSparseArray.put(id, resView);
            addView(resView);
        }
    
        /**
         *  显示 loading
         */
        public void showLoading() {if (layoutSparseArray.get(LAYOUT_LOADING_ID) != null) {showHideViewById(LAYOUT_LOADING_ID);
            }
        }
    
        /**
         *  显示内容
         */
        public void showContent() {if (layoutSparseArray.get(LAYOUT_CONTENT_ID) != null) {showHideViewById(LAYOUT_CONTENT_ID);
            }
        }
    
        /**
         *  显示空数据
         */
        public void showEmptyData(int iconImage, String textTip) {if (inflateLayout(LAYOUT_EMPTY_DATA_ID)) {showHideViewById(LAYOUT_EMPTY_DATA_ID);
                emptyDataViewAddData(iconImage, textTip);
            }
        }
    
    
        /**
         * 根据 ID 显示隐藏布局
         * @param id                        id 值
         */
        private void showHideViewById(int id) {for (int i = 0; i < layoutSparseArray.size(); i++) {int key = layoutSparseArray.keyAt(i);
                View valueView = layoutSparseArray.valueAt(i);
                // 显示该 view
                if(key == id) {valueView.setVisibility(View.VISIBLE);
                    if(mStatusLayoutManager.onShowHideViewListener != null) {mStatusLayoutManager.onShowHideViewListener.onShowView(valueView, key);
                    }
                } else {if(valueView.getVisibility() != View.GONE) {valueView.setVisibility(View.GONE);
                        if(mStatusLayoutManager.onShowHideViewListener != null) {mStatusLayoutManager.onShowHideViewListener.onHideView(valueView, key);
                        }
                    }
                }
            }
        }
    
        /**
         * 这个是处理 ViewStub 的逻辑,主要有网络异常布局,加载异常布局,空数据布局
         * @param id                        布局 id
         * @return                          布尔值
         */
        private boolean inflateLayout(int id) {
            boolean isShow = true;
            // 如果为 null,则直接返回 false
            if (layoutSparseArray.get(id) == null) {return false;}
            switch (id) {
                case LAYOUT_NETWORK_ERROR_ID:
                    if (mStatusLayoutManager.netWorkErrorVs != null) {View view = mStatusLayoutManager.netWorkErrorVs.inflate();
                        retryLoad(view, mStatusLayoutManager.netWorkErrorRetryViewId);
                        layoutSparseArray.put(id, view);
                        isShow = true;
                    } else {isShow = false;}
                    break;
                case LAYOUT_ERROR_ID:
                    if (mStatusLayoutManager.errorVs != null) {View view = mStatusLayoutManager.errorVs.inflate();
                        if (mStatusLayoutManager.errorLayout != null) {mStatusLayoutManager.errorLayout.setView(view);
                        }
                        retryLoad(view, mStatusLayoutManager.errorRetryViewId);
                        layoutSparseArray.put(id, view);
                        isShow = true;
                    } else {isShow = false;}
                    break;
                case LAYOUT_EMPTY_DATA_ID:
                    if (mStatusLayoutManager.emptyDataVs != null) {View view = mStatusLayoutManager.emptyDataVs.inflate();
                        if (mStatusLayoutManager.emptyDataLayout != null) {mStatusLayoutManager.emptyDataLayout.setView(view);
                        }
                        retryLoad(view, mStatusLayoutManager.emptyDataRetryViewId);
                        layoutSparseArray.put(id, view);
                        isShow = true;
                    } else {isShow = false;}
                    break;
                default:
                    break;
            }
            return isShow;
        }
    }

5.2 自定义状态管理器

  • 上面状态的自定义布局创建出来了,而且隐藏和展示都做了。那么如何控制设置自定义视图布局,还有如何控制不同布局之间切换,那么就需要用到这个类呢!https://github.com/yangchong2…

    • loadingLayoutResId 和 contentLayoutResId 代表等待加载和显示内容的 xml 文件
    • 几种异常状态要用 ViewStub,因为在界面状态切换中 loading 和内容 View 都是一直需要加载显示的,但是其他的 3 个只有在没数据或者网络异常的情况下才会加载显示,所以用 ViewStub 来加载他们可以提高性能。
    • 采用 builder 模式,十分简单,代码如下所示。创建 StateFrameLayout 对象,然后再设置 setStatusLayoutManager,这一步操作是传递一个 Manager 对象到 StateFrameLayout,建立连接。
    public final class StateLayoutManager {
    
        final Context context;
    
        final int netWorkErrorRetryViewId;
        final int emptyDataRetryViewId;
        final int errorRetryViewId;
        final int loadingLayoutResId;
        final int contentLayoutResId;
        final int retryViewId;
        final int emptyDataIconImageId;
        final int emptyDataTextTipId;
        final int errorIconImageId;
        final int errorTextTipId;
    
        final ViewStub emptyDataVs;
        final ViewStub netWorkErrorVs;
        final ViewStub errorVs;
        final AbsViewStubLayout errorLayout;
        final AbsViewStubLayout emptyDataLayout;
    
        private final StateFrameLayout rootFrameLayout;
        final OnShowHideViewListener onShowHideViewListener;
        final OnRetryListener onRetryListener;
    
        public static Builder newBuilder(Context context) {return new Builder(context);
        }
    
        private StateLayoutManager(Builder builder) {
            this.context = builder.context;
            this.loadingLayoutResId = builder.loadingLayoutResId;
            this.netWorkErrorVs = builder.netWorkErrorVs;
            this.netWorkErrorRetryViewId = builder.netWorkErrorRetryViewId;
            this.emptyDataVs = builder.emptyDataVs;
            this.emptyDataRetryViewId = builder.emptyDataRetryViewId;
            this.errorVs = builder.errorVs;
            this.errorRetryViewId = builder.errorRetryViewId;
            this.contentLayoutResId = builder.contentLayoutResId;
            this.onShowHideViewListener = builder.onShowHideViewListener;
            this.retryViewId = builder.retryViewId;
            this.onRetryListener = builder.onRetryListener;
            this.emptyDataIconImageId = builder.emptyDataIconImageId;
            this.emptyDataTextTipId = builder.emptyDataTextTipId;
            this.errorIconImageId = builder.errorIconImageId;
            this.errorTextTipId = builder.errorTextTipId;
            this.errorLayout = builder.errorLayout;
            this.emptyDataLayout = builder.emptyDataLayout;
    
            // 创建帧布局
            rootFrameLayout = new StateFrameLayout(this.context);
            ViewGroup.LayoutParams layoutParams = new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);
            rootFrameLayout.setLayoutParams(layoutParams);
    
            // 设置状态管理器
            rootFrameLayout.setStatusLayoutManager(this);
        }
    
    
        /**
         * 显示 loading
         */
        public void showLoading() {rootFrameLayout.showLoading();
        }
    
        /**
         * 显示内容
         */
        public void showContent() {rootFrameLayout.showContent();
        }
    
        /**
         * 显示空数据
         */
        public void showEmptyData(int iconImage, String textTip) {rootFrameLayout.showEmptyData(iconImage, textTip);
        }
    
        /**
         * 显示空数据
         */
        public void showEmptyData() {showEmptyData(0, "");
        }
    
        /**
         * 显示空数据
         */
        public void showLayoutEmptyData(Object... objects) {rootFrameLayout.showLayoutEmptyData(objects);
        }
    
        /**
         * 显示网络异常
         */
        public void showNetWorkError() {rootFrameLayout.showNetWorkError();
        }
    
        /**
         * 显示异常
         */
        public void showError(int iconImage, String textTip) {rootFrameLayout.showError(iconImage, textTip);
        }
    
        /**
         * 显示异常
         */
        public void showError() {showError(0, "");
        }
    
        public void showLayoutError(Object... objects) {rootFrameLayout.showLayoutError(objects);
        }
    
        /**
         * 得到 root 布局
         */
        public View getRootLayout() {return rootFrameLayout;}
    
        public static final class Builder {
    
            private Context context;
            private int loadingLayoutResId;
            private int contentLayoutResId;
            private ViewStub netWorkErrorVs;
            private int netWorkErrorRetryViewId;
            private ViewStub emptyDataVs;
            private int emptyDataRetryViewId;
            private ViewStub errorVs;
            private int errorRetryViewId;
            private int retryViewId;
            private int emptyDataIconImageId;
            private int emptyDataTextTipId;
            private int errorIconImageId;
            private int errorTextTipId;
            private AbsViewStubLayout errorLayout;
            private AbsViewStubLayout emptyDataLayout;
            private OnShowHideViewListener onShowHideViewListener;
            private OnRetryListener onRetryListener;
    
            Builder(Context context) {this.context = context;}
    
            /**
             * 自定义加载布局
             */
            public Builder loadingView(@LayoutRes int loadingLayoutResId) {
                this.loadingLayoutResId = loadingLayoutResId;
                return this;
            }
    
            /**
             * 自定义网络错误布局
             */
            public Builder netWorkErrorView(@LayoutRes int newWorkErrorId) {netWorkErrorVs = new ViewStub(context);
                netWorkErrorVs.setLayoutResource(newWorkErrorId);
                return this;
            }
    
            /**
             * 自定义加载空数据布局
             */
            public Builder emptyDataView(@LayoutRes int noDataViewId) {emptyDataVs = new ViewStub(context);
                emptyDataVs.setLayoutResource(noDataViewId);
                return this;
            }
    
            /**
             * 自定义加载错误布局
             */
            public Builder errorView(@LayoutRes int errorViewId) {errorVs = new ViewStub(context);
                errorVs.setLayoutResource(errorViewId);
                return this;
            }
    
            /**
             * 自定义加载内容正常布局
             */
            public Builder contentView(@LayoutRes int contentLayoutResId) {
                this.contentLayoutResId = contentLayoutResId;
                return this;
            }
    
            public Builder errorLayout(AbsViewStubLayout errorLayout) {
                this.errorLayout = errorLayout;
                this.errorVs = errorLayout.getLayoutVs();
                return this;
            }
    
            public Builder emptyDataLayout(AbsViewStubLayout emptyDataLayout) {
                this.emptyDataLayout = emptyDataLayout;
                this.emptyDataVs = emptyDataLayout.getLayoutVs();
                return this;
            }
    
            public Builder netWorkErrorRetryViewId(@LayoutRes int netWorkErrorRetryViewId) {
                this.netWorkErrorRetryViewId = netWorkErrorRetryViewId;
                return this;
            }
    
            public Builder emptyDataRetryViewId(@LayoutRes int emptyDataRetryViewId) {
                this.emptyDataRetryViewId = emptyDataRetryViewId;
                return this;
            }
    
            public Builder errorRetryViewId(@LayoutRes int errorRetryViewId) {
                this.errorRetryViewId = errorRetryViewId;
                return this;
            }
    
            public Builder retryViewId(@LayoutRes int retryViewId) {
                this.retryViewId = retryViewId;
                return this;
            }
    
            public Builder emptyDataIconImageId(@LayoutRes int emptyDataIconImageId) {
                this.emptyDataIconImageId = emptyDataIconImageId;
                return this;
            }
    
            public Builder emptyDataTextTipId(@LayoutRes int emptyDataTextTipId) {
                this.emptyDataTextTipId = emptyDataTextTipId;
                return this;
            }
    
            public Builder errorIconImageId(@LayoutRes int errorIconImageId) {
                this.errorIconImageId = errorIconImageId;
                return this;
            }
    
            public Builder errorTextTipId(@LayoutRes int errorTextTipId) {
                this.errorTextTipId = errorTextTipId;
                return this;
            }
    
            /**
             * 为状态 View 显示隐藏监听事件
             * @param listener                  listener
             * @return
             */
            public Builder onShowHideViewListener(OnShowHideViewListener listener) {
                this.onShowHideViewListener = listener;
                return this;
            }
    
            /**
             * 为重试加载按钮的监听事件
             * @param onRetryListener           listener
             * @return
             */
            public Builder onRetryListener(OnRetryListener onRetryListener) {
                this.onRetryListener = onRetryListener;
                return this;
            }
    
            /**
             * 创建对象
             * @return
             */
            public StateLayoutManager build() {return new StateLayoutManager(this);
            }
        }
    
    }

5.3 如何管理多种状态

  • 大约 5 种状态,如何管理这些状态?添加到集合中,Android 中选用 SparseArray 比 HashMap 更省内存,在某些条件下性能更好,主要是因为它避免了对 key 的自动装箱(int 转为 Integer 类型),它内部则是通过两个数组来进行数据存储的,一个存储 key,另外一个存储 value,为了优化性能,它内部对数据还采取了压缩的方式来表示稀疏数组的数据,从而节约内存空间

    /** 存放布局集合 */
    private SparseArray<View> layoutSparseArray = new SparseArray();
    
    /** 将布局添加到集合 */
    private void addLayoutResId(@LayoutRes int layoutResId, int id) {View resView = LayoutInflater.from(mStatusLayoutManager.context).inflate(layoutResId, null);
        layoutSparseArray.put(id, resView);
        addView(resView);
    }
    
    // 那么哪里从集合中取数据呢
    public void showContent() {if (layoutSparseArray.get(LAYOUT_CONTENT_ID) != null) {showHideViewById(LAYOUT_CONTENT_ID);
        }
    }

06. 封装库极致优化点说明

6.1 用 ViewStub 显示布局

  • 方法里面通过 id 判断来执行不同的代码,首先判断 ViewStub 是否为空,如果为空就代表没有添加这个 View 就返回 false,不为空就加载 View 并且添加到集合当中,然后调用 showHideViewById 方法显示隐藏 View,retryLoad 方法是给重试按钮添加事件

    • 注意,即使当你设置了多种不同状态视图,调用 setContentView 的时候,因为异常页面使用 ViewStub,所以在绘制的时候不会影响性能的。
    /**
    *  显示 loading
    */
    public void showLoading() {if (layoutSparseArray.get(LAYOUT_LOADING_ID) != null)
            showHideViewById(LAYOUT_LOADING_ID);
    }
    
    /**
    *  显示内容
    */
    public void showContent() {if (layoutSparseArray.get(LAYOUT_CONTENT_ID) != null)
            showHideViewById(LAYOUT_CONTENT_ID);
    }
    
    // 调用 inflateLayout 方法,方法返回 true 然后调用 showHideViewById 方法
    private boolean inflateLayout(int id) {
        boolean isShow = true;
        if (layoutSparseArray.get(id) != null) return isShow;
        switch (id) {
            case LAYOUT_NETWORK_ERROR_ID:
                if (mStatusLayoutManager.netWorkErrorVs != null) {View view = mStatusLayoutManager.netWorkErrorVs.inflate();
                    retryLoad(view, mStatusLayoutManager.netWorkErrorRetryViewId);
                    layoutSparseArray.put(id, view);
                    isShow = true;
                } else {isShow = false;}
                break;
            case LAYOUT_ERROR_ID:
                if (mStatusLayoutManager.errorVs != null) {View view = mStatusLayoutManager.errorVs.inflate();
                    if (mStatusLayoutManager.errorLayout != null) mStatusLayoutManager.errorLayout.setView(view);
                    retryLoad(view, mStatusLayoutManager.errorRetryViewId);
                    layoutSparseArray.put(id, view);
                    isShow = true;
                } else {isShow = false;}
                break;
            case LAYOUT_EMPTYDATA_ID:
                if (mStatusLayoutManager.emptyDataVs != null) {View view = mStatusLayoutManager.emptyDataVs.inflate();
                    if (mStatusLayoutManager.emptyDataLayout != null) mStatusLayoutManager.emptyDataLayout.setView(view);
                    retryLoad(view, mStatusLayoutManager.emptyDataRetryViewId);
                    layoutSparseArray.put(id, view);
                    isShow = true;
                } else {isShow = false;}
                break;
        }
        return isShow;
    }

6.2 处理重新加载逻辑

  • 最后看看重新加载方法

    /**
    *  重试加载
    */
    private void retryLoad(View view, int id) {View retryView = view.findViewById(mStatusLayoutManager.retryViewId != 0 ? mStatusLayoutManager.retryViewId : id);
        if (retryView == null || mStatusLayoutManager.onRetryListener == null) return;
        retryView.setOnClickListener(new OnClickListener() {
            @Override
            public void onClick(View v) {mStatusLayoutManager.onRetryListener.onRetry();
            }
        });
    }

07. 如何使用该封装库

  • 可以自由切换内容,空数据,异常错误,加载,网络错误等 5 种状态。父类 BaseActivity 直接暴露 5 中状态,方便子类统一管理状态切换,这里 fragment 的封装和 activity 差不多。

    /**
    * ================================================
    * 作    者:杨充
    * 版    本:1.0
    * 创建日期:2017/7/6
    * 描    述:抽取类
    * 修订历史:
*/
public abstract class BaseActivity extends AppCompatActivity {

    protected StatusLayoutManager statusLayoutManager;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_base_view);
        initStatusLayout();
        initBaseView();
        initToolBar();
        initView();}
    
    // 子类必须重写该方法
    protected abstract void initStatusLayout();

    protected abstract void initView();

    /**
    * 获取到布局
    */
    private void initBaseView() {LinearLayout ll_main = (LinearLayout) findViewById(R.id.ll_main);
        ll_main.addView(statusLayoutManager.getRootLayout());
    }

    // 正常展示数据状态
    protected void showContent() {statusLayoutManager.showContent();
    }

    // 加载数据为空时状态
    protected void showEmptyData() {statusLayoutManager.showEmptyData();
    }

    // 加载数据错误时状态
    protected void showError() {statusLayoutManager.showError();
    }

    // 网络错误时状态
    protected void showNetWorkError() {statusLayoutManager.showNetWorkError();
    }

    // 正在加载中状态
    protected void showLoading() {statusLayoutManager.showLoading();
    }
}
```
  • 子类继承 BaseActivity 后,该如何操作呢?具体如下所示

    @Override
    protected void initStatusLayout() {statusLayoutManager = StateLayoutManager.newBuilder(this)
                .contentView(R.layout.activity_main)
                .emptyDataView(R.layout.activity_emptydata)
                .errorView(R.layout.activity_error)
                .loadingView(R.layout.activity_loading)
                .netWorkErrorView(R.layout.activity_networkerror)
                .build();}
    
    // 或者添加上监听事件
    @Override
    protected void initStatusLayout() {statusLayoutManager = StateLayoutManager.newBuilder(this)
                .contentView(R.layout.activity_content_data)
                .emptyDataView(R.layout.activity_empty_data)
                .errorView(R.layout.activity_error_data)
                .loadingView(R.layout.activity_loading_data)
                .netWorkErrorView(R.layout.activity_networkerror)
                .onRetryListener(new OnRetryListener() {
                    @Override
                    public void onRetry() {// 为重试加载按钮的监听事件}
                })
                .onShowHideViewListener(new OnShowHideViewListener() {
                    @Override
                    public void onShowView(View view, int id) {// 为状态 View 显示监听事件}
    
                    @Override
                    public void onHideView(View view, int id) {// 为状态 View 隐藏监听事件}
                })
                .build();}
    
    // 如何切换状态呢?showContent();
    showEmptyData();
    showError();
    showLoading();
    showNetWorkError();
    
    // 或者这样操作也可以
    statusLayoutManager.showLoading();
    statusLayoutManager.showContent();
  • 那么如何设置状态页面的交互事件呢?当状态是加载数据失败时,点击可以刷新数据;当状态是无网络时,点击可以设置网络。代码如下所示:

    /**
*/
private void initErrorDataView() {statusLayoutManager.showError();
    LinearLayout ll_error_data = (LinearLayout) findViewById(R.id.ll_error_data);
    ll_error_data.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {initData();
            adapter.notifyDataSetChanged();
            showContent();}
    });
}

/**
* 点击设置网络
*/
private void initSettingNetwork() {statusLayoutManager.showNetWorkError();
    LinearLayout ll_set_network = (LinearLayout) findViewById(R.id.ll_set_network);
    ll_set_network.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {Intent intent = new Intent("android.settings.WIRELESS_SETTINGS");
            startActivity(intent);
        }
    });
}
```
  • 那有些页面想要自定义指定的状态页面 UI,又该如何操作呢?倘若有些页面想定制状态布局,也可以自由实现,很简单:

    /**
*/
private void initEmptyDataView() {statusLayoutManager.showEmptyData();
    // 此处是自己定义的状态布局
    statusLayoutManager.showLayoutEmptyData(R.layout.activity_emptydata);
    LinearLayout ll_empty_data = (LinearLayout) findViewById(R.id.ll_empty_data);
    ll_empty_data.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {initData();
            adapter.notifyDataSetChanged();
            showContent();}
    });
}
``` 


其他介绍

01. 关于博客汇总链接

  • 1. 技术博客汇总
  • 2. 开源项目汇总
  • 3. 生活博客汇总
  • 4. 喜马拉雅音频汇总
  • 5. 其他汇总

02. 关于我的博客

  • github:https://github.com/yangchong211
  • 知乎:https://www.zhihu.com/people/…
  • 简书:http://www.jianshu.com/u/b7b2…
  • csdn:http://my.csdn.net/m0_37700275
  • 喜马拉雅听书:http://www.ximalaya.com/zhubo…
  • 开源中国:https://my.oschina.net/zbj161…
  • 泡在网上的日子:http://www.jcodecraeer.com/me…
  • 邮箱:yangchong211@163.com
  • 阿里云博客:https://yq.aliyun.com/users/a… 239.headeruserinfo.3.dT4bcV
  • segmentfault 头条:https://segmentfault.com/u/xi…
  • 掘金:https://juejin.im/user/593943…

项目开源地址:https://github.com/yangchong2…

正文完
 0