Android 页面异常显示的简单封装

摘要

一般来说，进入一个页面大都会请求网络，请求网络便会有各种异常，比如返回数据为空、服务器异常、参数错误，等等…那么页面在得到这些返回结果后，总会要有个反馈，用来显示给用户，总不能所有的异常都用Toast来显示吧，所以界面还是要有的。
那么界面显示在哪里呢？一般一个页面会有标题栏，标题栏下面是内容，然后有的还会底部栏，标题栏和底部栏总不能被异常界面遮住，所以要展示异常的地方，必须是页面的正文部分。
但是正文部分也可能分了层，比如正文上面部分是信息展示，下面是一个数据列表，信息展示不会访问网络，但是列表就可能出现数据异常，这样一来，不能用异常界面把信息展示的部分也遮住了吧？所以我们需要的是一个十分灵活的异常展示类，他可以在想要的地方展示出异常界面，而不遮住其他组件。

实现思路

思路是这样的：自己定义一块区域作为异常展示的地方，然后通过找到这块区域的根布局，然后用异常布局替换掉这块布局就可以了。

比如这个layout_record.xml：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical" android:layout_width="match_parent"
    android:layout_height="match_parent">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        android:id="@+id/ll_content">
            <android.support.v7.widget.RecyclerView
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                android:id="@+id/rv_record">

            </android.support.v7.widget.RecyclerView>
    </LinearLayout>
</LinearLayout>

里面id为ll_content的LinearLayout里面就是页面的内容所在，即一个RecyclerView，如果数据加载异常，我只需找到RecyclerView的父布局ll_content，然后隐藏掉或者移除掉RecyclerView，再给ll_content添加上我自己定义的错误布局，显示出相应的错误信息，就可以达到效果。
说的简单点，就是把本应显示数据的RecyclerView，替换成错误布局–tipsView

代码

public class BaseViewHelper implements View.OnClickListener {

    private FrameLayout mContentLayout;
    private View mTargetView;
    private FrameLayout mTargetLayout ;
    //异常界面就一个异常图标，和一个信息文本
    private ImageView mIcon;
    private TextView mTips;

    private LayoutInflater mInflater;

    View tipsView ;
    View loadingView ;
    View targetView ;
    private Context mContext ;

    public BaseViewHelper(Context context, int layoutResID) {
        initView(context,  layoutResID, null);
    }

    public BaseViewHelper(Context context, View view) {
        initView(context, 0, view);
    }

    private void initView(Context context,  int layoutResID, View view) {
        mContext = context ;
        FrameLayout.LayoutParams layoutParam = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);

        this.mInflater = LayoutInflater.from(context);
        mTargetLayout = new FrameLayout(context);
        if (layoutResID != 0) {
            this.mTargetView = mInflater.inflate(layoutResID, null);
        } else {
            this.mTargetView = view;
        }
        //含有target的Layout
        mTargetLayout.addView(mTargetView);
        //页面正文部分
        mContentLayout = new FrameLayout(context);
        mContentLayout.addView(mTargetLayout);
        //设置一个异常显示的界面视图
        tipsView = mInflater.inflate(R.layout.base_tips_layout, null);
        tipsView.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                mOnReloadingListener.onReloading();
            }
        });
        tipsView.setLayoutParams(layoutParam);
        tipsView.setId(R.id.view_tips);
        loadingView = mInflater.inflate(R.layout.layout_loading_view,null);
        loadingView.setId(R.id.loading_view);
        mIcon = (ImageView) tipsView.findViewById(R.id.id_base_icon);
        mTips = (TextView) tipsView.findViewById(R.id.id_base_tips);
    }

    /**
     * 显示一个进度条，此进度条会屏蔽当前界面，此时用户无法操作界面
     */
    public void showLoadingView() {
        hiedErrorView();
        if (((Activity)mContext).findViewById(R.id.loading_view) == null) {
            ViewGroup.LayoutParams params = new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);
            ((Activity) mContext).addContentView(loadingView, params);
        }
        loadingView.setVisibility(View.VISIBLE);
    }

    /**
     * 显示异常视图（tipsView）
     * @param target    想替换掉的部分，想在RecyclerView的部分显示异常，就传RecyclerView
     * @param status    服务器返回的状态码，根据不同状态码显示的错误信息不同
     */
    public void showResultView(View target, int status) {
        //得到默认的错误状态码对应的错误信息
        TErrorCode errorCode = TErrorCode.getInstance();

        showResultView(target,status,errorCode.initErrors());
    }
    /**
     * 显示异常视图（tipsView）
     * @param target    想替换掉的部分，想在RecyclerView的部分显示异常，就传RecyclerView
     * @param status    服务器返回的状态码，根据不同状态码显示的错误信息不同
     * @param msgs      自定义的错误信息，比如有的信息为空异常要显示成“该XX下没有XX”，有的要显示“您还没有XX”，自定义更方便
     */
    public void showResultView(View target, int status, Map<Integer,String> msgs) {
        //隐藏进度条
        hiedLoadingView();
        //customErrorMsg(msgs)方法，先得到默认的错误信息集合，然后用自定义的部分替换掉原有的，所以不用必须把所有的错误信息都自定义一遍，按需定义即可
        //
        TErrorCode errorCode = TErrorCode.customErrorMsg(msgs) ;
        if (targetView == null) {
            targetView = target;
            targetView.setId(R.id.target_view);
        }
        //找到target的父视图
        ViewGroup parent = (ViewGroup) target.getParent();
        View tempTips = parent.findViewById(R.id.view_tips) ;
        if (tempTips == null) {
            //给父布局上加一个tipsView，即异常显示视图
            parent.addView(tipsView);
        } else {
            tipsView.setVisibility(View.VISIBLE);
        }
        //TErrorCode.NULL_RESULTS 代表返回数据为空的状态码，int 型
        mIcon.setBackgroundResource(status == TErrorCode.NULL_RESULTS ?R.mipmap.ico_no_content:R.mipmap.ico_no_network);
        //getErrorMsg(status,errorCode)根据状态码status和自定义的错误集，来得到错误信息
        mTips.setText(TErrorCode.getErrorMsg(status,errorCode));
        //隐藏原布局，如果传进来的是RecyclerView，那么RecyclerView就会被隐藏，tipsView会被显示出来
        target.setVisibility(View.GONE);
        //如果token失效就会执行重新登录
        if (status == TErrorCode.TOKEN_OUT_OF_DATE) {
            ToolUtil.loginout((Activity) mContext,"token失效，请重新登录！");
        }
        //如果版本过低就会执行强制更新
        else if (status == TErrorCode.APP_VERSION_ERROR){
            ToolUtil.update((Activity) mContext);
        }
    }

    /**
     * 隐藏加载进度条
     */
    public void hiedLoadingView() {
        if (((Activity)mContext).findViewById(R.id.loading_view) != null) {
            ((Activity) mContext).findViewById(R.id.loading_view).setVisibility(View.GONE);
        }
        hiedErrorView();

    }

    /**
     * 隐藏异常视图tipsView
     */
    public void hiedErrorView() {
        if (((Activity)mContext).findViewById(R.id.view_tips) != null) {
            ((Activity) mContext).findViewById(R.id.view_tips).setVisibility(View.GONE);
        }
        if (((Activity)mContext).findViewById(R.id.target_view) != null) {
            ((Activity) mContext).findViewById(R.id.target_view).setVisibility(View.VISIBLE);
        }
    }



    public FrameLayout getContentLayout() {
        return mContentLayout;
    }

    public View getTargetView() {
        return mTargetView;
    }

    @Override
    public void onClick(View v) {
        if (mOnReloadingListener != null) {
            mOnReloadingListener.onReloading();
        }
    }

    public interface OnReloadingListener {
        void onReloading();
    }

    private OnReloadingListener mOnReloadingListener;

    public void setOnReloadingListener(OnReloadingListener l) {
        this.mOnReloadingListener = l;
    }
}

使用

做是做好了，怎么用呢？
比如把它封装到BaseActivity里：

public abstract class BaseActivity extends Activity implements BaseViewHelper.OnReloadingListener {

    public BaseViewHelper mViewHelper;

    @Override
    public void setContentView(int layoutResID) {
        mViewHelper = new BaseViewHelper(this, layoutResID);
        this.setContentView(mViewHelper.getContentLayout());
        init();
    }
    //设置异常界面的点击重新加载监听事件
    private void init(){
        mViewHelper.setOnReloadingListener(this);
    }

    @Override
    public void setContentView(View view) {
        mViewHelper = new BaseViewHelper(this, view);
        super.setContentView(mViewHelper.getContentLayout());
        init();
    }

    public void showResultView(View target,int status) {
        mViewHelper.showResultView(target, status);
    }
    public void showResultView(View target, int status, Map<Integer,String> msgs) {
        mViewHelper.showResultView(target, status,msgs);
    }

    public void showLoadingView() {
        mViewHelper.showLoadingView();

    }

    @Override
    public void onReloading() {
        showLoadingView();
    }
}

然后在使用时，继承他，调用showResult方法就行了。

Map<Integer,String> msgs = new HashMap<>();
//替换了默认错误信息里的“返回数据为空”这一状态码对应的显示信息
//因此错误界面会显示“暂时没有记录需要处理”
msgs.put(TErrorCode.NULL_RESULTS,"暂时没有记录需要处理") ;
showResultView(llContent,error.getStatus(),msgs);