[38→100]一个常规的Android页面模型：NetFragment

问题场景

Android开发中大部分页面都包含如下逻辑：

  1. 进入页面，加载网络数据，显示加载页面
  2. 加载完成后，有以下几种情况：
  3. 正常返回，有有效数据，显示“有效界面”
  4. 正常返回，有效数据为空，显示“空数据界面”
  5. 正常返回，服务器判定输入参数异常，显示“参数异常界面”，比如“用户登录失效”等，直接跳转相应的页面
  6. 异常返回，网络超时，无法访问服务器等状态，显示“加载失败页面”
  7. 无法访问网络，显示“无法访问网络界面”。

怎么解决呢？

原本想各个界面由NetFragment提供接口进行设置，后来考虑Android的界面基本xml绘制，透过id与代码绑定。那不如采用“约定优于配置原则”，直接规定好那些id标识哪些界面，NetFragment里面根据相应的id去寻找界面即可。所以最后约定id名称如下：

  • 加载界面 R.id.net_progress
  • 有效界面 R.id.net_result
  • 空数据界面 R.id.net_no_result
  • 参数异常界面 R.id.net_error
  • 加载失败页面 R.id.net_fail
  • 无法访问网络界面 R.id.net_cannot_access

基于SOLID原则中的S——单一责任原则（The Single Responsibility Principle），各个界面的点击、触摸都由各自处理，NetFragment只负责加载数据、控制各类界面显示隐藏，至于下拉刷新、上拉加载下一页数据等操作都不在此类里面内进行管理。

最后产生的代码——NetFragment.java

package lib;

import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;

import com.freetek.deepsea.R;

import panda.android.lib.base.control.SimpleSafeTask;
import panda.android.lib.base.model.ListNetResultInfo;
import panda.android.lib.base.model.NetResultInfo;
import panda.android.lib.base.model.net.BaseRepositoryCollection;
import panda.android.lib.base.ui.fragment.BaseFragment;
import panda.android.lib.base.util.DevUtil;
import panda.android.lib.base.util.Log;

/**
 * 加载网页数据的通用模型，包含 进度条控制、结果显示控制。
 *
 * @param <T>
 * @author shitianci
 */
public abstract class NetFragment<T extends NetResultInfo> extends BaseFragment {

    private static final String TAG = NetFragment.class.getSimpleName();
    protected View mViewProgress = null;  //加载界面
    protected View mViewResult = null; //有效界面
    protected View mViewNoResult = null; //空数据界面
    protected View mViewError = null; //参数异常界面
    protected View mViewFail = null; //加载失败页面
    protected View mViewCannotAccess = null; //无法访问网络

    protected SimpleSafeTask<T> netTask = null;
    private View[] mViewArray;
    private int[] mViewArrayID = new int[]{
            R.id.net_progress, //加载界面
            R.id.net_result, //有效界面
            R.id.net_no_result, //空数据界面
            R.id.net_error, //参数异常界面
            R.id.net_fail, //加载失败页面
            R.id.net_cannot_access}; //无法访问网络

    //todo 这些数据需要放到xml里面进行管理
    private String[] mViewToastString = new String[]{
            "正在加载中", //加载界面
            "加载到有效数据了", //有效界面
            "加载数据为空", //空数据界面
            "参数异常", //参数异常界面
            "无法访问服务器", //加载失败页面
            "无法访问网络"}; //无法访问网络


    @Override
    public int getLayoutId() {
        return R.layout.panda_fragment_net;
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View createdView = super.onCreateView(inflater, container,
                savedInstanceState);
        mViewProgress = createdView.findViewById(R.id.net_progress);
        mViewResult = createdView.findViewById(R.id.net_result);
        mViewNoResult = createdView.findViewById(R.id.net_no_result);
        mViewError = createdView.findViewById(R.id.net_error);
        mViewFail = createdView.findViewById(R.id.net_fail);
        mViewCannotAccess = createdView.findViewById(R.id.net_cannot_access);
        mViewArray = new View[]{mViewProgress, mViewResult, mViewNoResult, mViewError, mViewFail, mViewCannotAccess};

        return createdView;
    }

    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        super.onActivityCreated(savedInstanceState);
        loadNetData(false);
    }

    boolean loadingNetData = false;

    public void loadNetData() {
        loadNetData(false);
    }

    public void loadNetData(final boolean useSecondModel) {
        Log.d(TAG, "loadNetData, loadingNetData = " + loadingNetData);
        if (loadingNetData) {
            return;
        }
        if (!BaseRepositoryCollection.tryToDetectNetwork(getActivity())) {
            showOnlyView(R.id.net_cannot_access, useSecondModel);
            return;
        }
        netTask = new SimpleSafeTask<T>(getActivity()) {

            protected void onPreExecuteSafely() throws Exception {
                loadingNetData = true;
                showOnlyView(R.id.net_progress, useSecondModel);
                onPreloadNetData(useSecondModel);
            }

            @Override
            protected T doInBackgroundSafely() throws Exception {
                T result = onDoInBackgroundSafely();
                return result;
            }

            @Override
            protected void onPostExecuteSafely(T result, Exception e) {
                onPostloadNetData(useSecondModel);
                super.onPostExecuteSafely(result, e);
                loadingNetData = false;
                if (e != null || result == null) {
                    showOnlyView(R.id.net_fail, useSecondModel);
                    return;
                }
                if (result.getRespCode() != NetResultInfo.RETURN_CODE_000000) {
                    showOnlyView(R.id.net_error, useSecondModel);
                    return;
                }
                if (result instanceof ListNetResultInfo && ((ListNetResultInfo) result).getList().size() == 0) {
                    showOnlyView(R.id.net_no_result, useSecondModel);
                    return;
                }
                showOnlyView(R.id.net_result, useSecondModel);
                onDisplayResult(result);
            }

            protected void onCancelled() {
                loadingNetData = false;
                showOnlyView(R.id.net_fail, useSecondModel);
            }


        };
        netTask.execute();
        return;
    }

    /**
     * -------------------------
     * START: 最重要的流程方法
     * -------------------------
     */


    /**
     * 开始加载网络数据
     * @param useSecondModel
     */
    public void onPreloadNetData(boolean useSecondModel) {
    }


    /**
     * 加载后台数据
     *
     * @return
     */
    protected abstract T onDoInBackgroundSafely();


    /**
     * 显示后台数据
     *
     * @param result
     */
    protected abstract void onDisplayResult(T result);

    /**
     * 网络数据加载结束
     * @param useSecondModel
     */
    public void onPostloadNetData(boolean useSecondModel) {

    }

    /**
     * -------------------------
     * END
     * -------------------------
     */


    /**
     * -------------------------
     * START: 纯粹的界面展示控制，不推荐外部调用、重写
     * -------------------------
     */

    /**
     * 显示指定的View，剩下的界面都隐藏。
     *
     * @param useSecondModel 是否启用第二次模式，在加载第2……n次数据时，无需切换其它界面，采用Toast显示信息即可。
     */
    protected void showOnlyView(int viewId, boolean useSecondModel) {
        int i = 0;
        for (View v : mViewArray) {
            i++;
            if (v == null) {
                continue;
            } else if (v.getId() == viewId) {
                Log.d(TAG, "showOnlyView, i = " + i);
                if (useSecondModel && (viewId != R.id.net_progress || viewId != R.id.net_result)) {
                    DevUtil.showInfo(getActivity(), mViewToastString[i-1]);
                } else {
                    v.setVisibility(View.VISIBLE);
                }

            } else {
                v.setVisibility(View.GONE);
            }
        }
    }

    protected void showProgress() {
        Log.d(TAG, "showProgress, mViewProgress = " + mViewProgress);
        if (mViewProgress != null) {
            mViewProgress.setVisibility(View.VISIBLE);
        }
    }

    protected void hiddenProgress() {
        Log.d(TAG, "hiddenProgress, mViewProgress = " + mViewProgress);
        if (mViewProgress != null) {
            mViewProgress.setVisibility(View.GONE);
        }
    }

//    protected void showResult() {
//        Log.d(TAG, "showResult");
//        if (mViewResult != null) {
//            mViewResult.setVisibility(View.VISIBLE);
//        }
//    }
//
//    protected void hiddenResult() {
//        Log.d(TAG, "hiddenResult");
//        if (mViewResult != null) {
//            mViewResult.setVisibility(View.GONE);
//        }
//    }
//
//    protected void showNoResult() {
//        Log.d(TAG, "showNoResult");
//        if (mViewNoResult != null) {
//            mViewNoResult.setVisibility(View.VISIBLE);
//        }
//    }
//
//    protected void hiddenNoResult() {
//        Log.d(TAG, "hiddenNoResult");
//        if (mViewNoResult != null) {
//            mViewNoResult.setVisibility(View.GONE);
//        }
//    }
//
//    public void showError() {
//        Log.d(TAG, "showNetErrResult");
//        if (mViewError != null) {
//            mViewError.setVisibility(View.VISIBLE);
//        }
//    }
//
//    private void hiddenError() {
//        if (mViewError != null) {
//            mViewError.setVisibility(View.GONE);
//        }
//    }
//
//    public void showFail() {
//        Log.d(TAG, "showFail");
//        if (mViewFail != null) {
//            mViewFail.setVisibility(View.VISIBLE);
//        }
//    }
//
//    public void hiddenFail() {
//        Log.d(TAG, "hiddenFail");
//        if (mViewFail != null) {
//            mViewFail.setVisibility(View.GONE);
//        }
//    }
//
//    public void showCannotAccess() {
//        if (mViewCannotAccess != null) {
//            mViewCannotAccess.setVisibility(View.VISIBLE);
//        }
//    }
//
//    public void hiddenCannotAccess() {
//        if (mViewCannotAccess != null) {
//            mViewCannotAccess.setVisibility(View.GONE);
//        }
//    }

    /**
     * -------------------------
     * END
     * -------------------------
     */

}

后续拓展

可以从开发者使用角度考虑，内置一系列子类，达到各种场景中“One Step”集成的效果。比如默认效果为：

  • 加载界面：弹出一个透明背景的加载框
  • 有效界面：支持 下拉刷新、上拉加载下一页
  • 空数据界面：支持图文格式
  • 参数异常界面：采用Toast提示
  • 加载失败页面：提醒用户网速过慢，建议切换网络
  • 无法访问网络界面：提醒用户打开网络

Panda
2016-06-03

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 200,527评论 5赞 470
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 84,314评论 2赞 377
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 147,535评论 0赞 332
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,006评论 1赞 272
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,961评论 5赞 360
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,220评论 1赞 277
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,664评论 3赞 392
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,351评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,481评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,397评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,443评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,123评论 3赞 315
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,713评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,801评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,010评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,494评论 2赞 346
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,075评论 2赞 341

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,284评论 25赞 707
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,566评论 18赞 139
  • Java初级面试题
    1. Java基础部分 基础部分的顺序：基本语法，类相关的语法，内部类的语法，继承相关的语法，异常的语法，线程的语...
    子非鱼_t_阅读 31,537评论 18赞 399
  • 盼西归
    《盼西归》 东起盼西归，空了色达阶。 遥望吾师榻，何年再叩首。 何一鸥/17.4.22
    土登根珠阅读 328评论 0赞 0
  • 练口才没思路怎么办
    口才的好坏，最基本的还在于多练习，那么练习以那为主哪？其实要想脱口成章表达的流利就是脑和嘴的协调能力，没有思路也就...
    佰荷阅读 245评论 0赞 0