一次搞定Retrofit Callback封装

前言

最近对Retrofit访问网络回调进行改进，主要统一后台API接口Json返回格式，错误提示模糊化。

一、统一后台台返回数据格式

{ 
  "code": 0, 
  "data": {},
  "message": "msg"
}

public class BaseCallModel<T> {
    public int code;
    public String message;
    public T data;
}

二、例子

这里使用玩安卓开发API测试一波,感谢玩安卓！

1.返回Json

{
    "data": [
        {
            "children": [],
            "courseId": 13,
            "id": 408,
            "name": "鸿洋",
            "order": 190000,
            "parentChapterId": 407,
            "userControlSetTop": false,
            "visible": 1
        },
        {
            "children": [],
            "courseId": 13,
            "id": 409,
            "name": "郭霖",
            "order": 190001,
            "parentChapterId": 407,
            "userControlSetTop": false,
            "visible": 1
        }
    ],
    "errorCode": 0,
    "errorMsg": ""
}

2.Model

public class BaseCallModel<T> {
    private int errorCode;
    private String errorMsg;
    private T data;
}

public interface ApiService {
    @GET("/wxarticle/chapters/json")
    Call<BaseCallModel<List<WxArticle>>> getWxArticle();
}

3.以前的CallBack使用

 ApiClient.getInstance().getService().getWxArticle().enqueue(new CallBack1<BaseCallModel<List<WxArticle>>>() {
            @Override
            public void success(BaseCallModel<List<WxArticle>> baseCallModel) {
                if (baseCallModel.getErrorCode() == SUCCESS_CODE) {
                    ①setData(baseCallModel.getData());
                } else {
                    ②Toast.makeText(CallBackTestActivity.this, baseCallModel.getErrorMsg(), Toast.LENGTH_SHORT).show();
                }
            }

            @Override
            public void failure(String msg) {
                ③Toast.makeText(CallBackTestActivity.this, msg, Toast.LENGTH_SHORT).show();
            }
        });

4.需求分析

这里①是获取服务器返回的数据，②
和③大部分都是错误输出提示少部分根据code做出不同的业务处理。

三、封装CallBack

根据需求我抽象出三个方法，

    // 访问服务器成功直接获取数据
    public abstract void success(T t);
    // 服务器错误返回code 和message
    public abstract void failure(int code,String msg);
    // 其他错误
    public abstract void error(String msg);

CallBack实现

public abstract class CallBack<T> implements Callback<BaseCallModel<T>> {
    public static final int SUCCESS_CODE = 0;

    public abstract void success(T t);

    public abstract void failure(int code, String msg);

    public abstract void error(String msg);

    @Override
    public void onResponse(Call<BaseCallModel<T>> call, Response<BaseCallModel<T>> response) {
        if (response.isSuccessful() && response.body() != null) {
            if (response.body().getErrorCode() == SUCCESS_CODE) {
                success(response.body().getData());
            } else {
                failure(response.body().getErrorCode()response.body().getErrorMsg());
            }
        }
        // other
    }

    @Override
    public void onFailure(Call<BaseCallModel<T>> call, Throwable t) {
        if (t instanceof SocketTimeoutException) {//超时
            error(t.getMessage());
        } else if (t instanceof ConnectException) {//连接错误
            error(t.getMessage());
        } else if (t instanceof UnknownError) { //未找到主机
            error(t.getMessage());
        } else {//其他错误
            error(t.getMessage());
        }
    }
}

使用

  ApiClient.getInstance().getService().getWxArticle().enqueue(new CallBack2<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {
                //显示数据
            }

            @Override
            public void failure(int code,String msg) {
                //提示服务器错误
            }

            @Override
            public void error(String msg) {
                //其他错误
            }
        });

当时我就考虑到showLoadingDialog 得多处 dismissLoadingDialog，抽象的方法太多了额外的增加很多其他代码，所以增加一个对象来保存错误。

  showLoadingDialog();
        ApiClient.getInstance().getService().getWxArticle().enqueue(new CallBack2<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {
                dismissLoadingDialog();
                //显示数据
            }

            @Override
            public void failure(int code, String msg) {
                dismissLoadingDialog();
                //提示服务器错误
            }

            @Override
            public void error(String msg) {
                dismissLoadingDialog();
                //其他错误
            }
        });

再次改进

   // 访问服务器成功直接获取数据
   public abstract void success(T t);
    // 服务器错误返回code 和message 和其他错误
    public abstract void failure(ApiErrorModel apiErrorModel);

四、统一错误提示

public final class ApiErrorModel {
    public static final int SERVER_ERROR = 0;
    public static final int OTHER_ERROR = 1;

    private int errorType;
    private int errorCode;
    private String errorMsg;

    public ApiErrorModel(int errorType, String errorMsg) {
        this.errorType = errorType;
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public ApiErrorModel(int httpCode, int errorCode, String errorMsg) {
        this.errorType = errorType;
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public boolean isOtherError() {
        return getErrorType() == OTHER_ERROR;
    }

    public int getErrorType() {
        return errorType;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }
}

public abstract class CallBack<T> implements Callback<BaseCallModel<T>> {
    public static final int SUCCESS_CODE = 0;

    public abstract void success(T t);

    public abstract void failure(ApiErrorModel apiErrorModel);

    @Override
    public void onResponse(Call<BaseCallModel<T>> call, Response<BaseCallModel<T>> response) {
        if (response.isSuccessful() && response.body() != null) {
            if (response.body().getErrorCode() == SUCCESS_CODE) {
                success(response.body().getData());
            } else {
                failure(new ApiErrorModel(ApiErrorModel.SERVER_ERROR, response.body().getErrorCode(), response.body().getErrorMsg()));
            }
        }
    }

    @Override
    public void onFailure(Call<BaseCallModel<T>> call, Throwable t) {
        ApiErrorModel apiErrorModel;
        if (t instanceof SocketTimeoutException) {//超时
            apiErrorModel = new ApiErrorModel(ApiErrorModel.SERVER_ERROR, "超时");
        } else if (t instanceof ConnectException) {//连接错误
            apiErrorModel = new ApiErrorModel(ApiErrorModel.SERVER_ERROR, "连接错误");
        } else if (t instanceof UnknownError) { //未找到主机
            apiErrorModel = new ApiErrorModel(ApiErrorModel.SERVER_ERROR, "未找到主机");
        } else {//其他错误
            apiErrorModel = new ApiErrorModel(ApiErrorModel.SERVER_ERROR, "未知错误");
        }
        failure(apiErrorModel);
    }
}

使用

  ApiClient.getInstance().getService().getWxArticle().enqueue(new CallBack<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {
                //显示数据
            }

            @Override
            public void failure(ApiErrorModel apiErrorModel) {
                // 提示
                Toast.makeText(CallBackTestActivity.this, apiErrorModel.getErrorMsg(), Toast.LENGTH_SHORT).show();

            }
        });

带Code处理

ApiClient.getInstance().getService().getWxArticle().enqueue(new CallBack<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {
                //显示数据
            }

            @Override
            public void failure(ApiErrorModel apiErrorModel) {
                if (apiErrorModel.isOtherError()) {
                    // 提示
                    Toast.makeText(CallBackTestActivity.this, apiErrorModel.getErrorMsg(), Toast.LENGTH_SHORT).show();
                    return;
                }
                // 处理业务
                int code = apiErrorModel.getErrorCode();
                ......

            }
        });

五、模糊化错误提示

我以为就这样完事的时候，告诉我需要模糊化错误提示，不能明确的告诉用户准确的错误。好吧！继续改进

1.通过枚举类管理所以的用户提示错误。

public enum ApiErrorType {
    NETWORK_NOT_CONNECT(1, R.string.network_not_connection), // 请检查网络连接
    NETWORK_ERROR(2, R.string.network_error), // 网络异常，请稍后再试！
    SERVER_ERROR(3, R.string.server_error), // 服务器发生错误
    UNKNOWN_ERROR(4, R.string.unknown_error); // 未知错误

    private final int code;
    private final int messageId;

    public int getMessageId() {
        return messageId;
    }

    ApiErrorType(int code, @StringRes int messageId) {
        this.code = code;
        this.messageId = messageId;
    }

    public ApiErrorModel getApiErrorModel() {
        Context context = App.getInstance().getApplicationContext();
        return new ApiErrorModel(ApiErrorModel.OTHER_ERROR, code, context.getString(messageId));
    }
}

2.发生错误时模糊化提示


public abstract class CompleteCallBack<T> implements Callback<BaseCallModel<T>> {
    public static final int SUCCESS_CODE = 0;

    public abstract void success(T t);

    public abstract void failure(ApiErrorModel apiErrorModel);

    @Override
    public void onResponse(Call<BaseCallModel<T>> call, Response<BaseCallModel<T>> response) {
        if (response.isSuccessful() && response.body() != null) {
            if (response.body().getErrorCode() == SUCCESS_CODE) {
                success(response.body().getData());
            } else {
                failure(new ApiErrorModel(ApiErrorModel.SERVER_ERROR, response.body().getErrorCode(), response.body().getErrorMsg()));
            }
        }
    }

    @Override
    public void onFailure(Call<BaseCallModel<T>> call, Throwable t) {
        ApiErrorType apiErrorType;
        if (t instanceof UnknownHostException) {
            apiErrorType = ApiErrorType.SERVER_ERROR;
        } else if (t instanceof ConnectException) {
            apiErrorType = ApiErrorType.NETWORK_NOT_CONNECT;
        } else if (t instanceof SocketTimeoutException) {
            apiErrorType = ApiErrorType.NETWORK_ERROR;
        } else {
            apiErrorType = ApiErrorType.UNKNOWN_ERROR;
        }
        failure(apiErrorType.getApiErrorModel());
    }
}

3.具体使用--依旧没变

提示

   ApiClient.getInstance().getService().getWxArticle().enqueue(new CompleteCallBack<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {

            }

            @Override
            public void failure(ApiErrorModel apiErrorModel) {
                Toast.makeText(MainActivity.this, apiErrorModel.getErrorMsg(), Toast.LENGTH_SHORT).show();
            }
        });

带code

ApiClient.getInstance().getService().getWxArticle().enqueue(new CompleteCallBack<List<WxArticle>>() {
            @Override
            public void success(List<WxArticle> wxArticles) {

            }

            @Override
            public void failure(ApiErrorModel apiErrorModel) {
                if (apiErrorModel.isOtherError()) {
                    // 提示
                    Toast.makeText(MainActivity.this, apiErrorModel.getErrorMsg(), Toast.LENGTH_SHORT).show();
                    return;
                }
                // 处理业务
                int code = apiErrorModel.getErrorCode();
                ......

            }
        });

总结

简单的封装一下CallBack，分离了CallBack中业务处理。在success只关注获取数据，failure处理网络连接中的异常。

由于本人水平有限，如果有错误和需要改进的地方，还希望大家多多指教，共同进步。

GitHub：

最后编辑于：2019.04.15 15:53:29

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