封装RxJava+Retrofit+OkHttp系列——(一)自动处理网络请求出错

完整项目Github地址：戳这里！！！

-----前言-----

使用RxJava+Retrofit+OkHttp这一套来实现APP的请求已经有一年多了，一开始的时候是到处搜索各种教程，勉强能用。到后来能看着别人的demo简单封装，一路走来收获良多。
网上关于RxJava+Retrofit+OkHttp的内容已经太多太多了，但是要么是深入Rxjava源码说了一大堆，晦涩难懂，要么是讲解retrofit注解和okhttp基本使用，老生常谈。很少有人把三者结合起来封装一下，用来实现真实项目中的各种痛点难点。比如：

  1. 每次进行网络请求都会有一大堆回调方法：onSubscribe，onNext，onErroron，Complete
  2. 每次请求完毕之后都要调用下面的代码来切换线程
.subscribeOn(Schedulers.io())
.unsubscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
  1. 如果一个Activity有多个网络请求，Activity简直是又臭又长，完全不能看
  2. 每次网络请求都要去展示一个等待的dialog，每次请求完毕之后又要去取消
  3. 网络请求出错之后还要自己去处理
  4. 等等等等

这些东西都太tm麻烦了，能不能让我只专注于onNext的回调方法，处理网络请求成功的内容，其他的都自动帮我实现好呢？答案是当然可以。
我会一步一步的来封装出我们自己的网络请求框架，解决上面提到的问题。如果你嫌麻烦，也可以直接去github下载我的代码自己研究。Github地址：戳这里！！！

首先我们来看下一般的使用方法：
如何用RxJava2.0.7和Retrofit2.2.0优雅的实现网络请求

   public void getData() {

       HttpMethods.getInstance().getJoke(new Observer<List<MyJoke>>() {
           Disposable d;

           @Override
           public void onSubscribe(Disposable d) {
               this.d = d;
           }

           @Override
           public void onNext(List<MyJoke> myJokes) {
               jokes = myJokes;
               adpter = new MyAdpter(myJokes);
               LinearLayoutManager layoutManager = new LinearLayoutManager(MainActivity.this);
               recyclerView.setLayoutManager(layoutManager);
               recyclerView.setAdapter(adpter);
               adpter.notifyDataSetChanged();
               Log.d("MAIN", "获取数据完成" + myJokes.size());
           }

           @Override
           public void onError(Throwable e) {
               Log.d("MAIN", "error" + e.toString());
               d.dispose();
           }

           @Override
           public void onComplete() {
               Log.d("MAIN", "onComplete");
               d.dispose();
           }
       });

   }

一开始的使用用的很爽，毕竟当初不会用Rxjava和retrofit时候，网络请求着实是一件十分痛苦的事情，要考虑的东西太多了。例如异步发起请求，主线程中处理UI的变化。网络请求失败后怎么办，网络很慢的时候如何展示一个通用的loading提示等等...现在大部分问题都能很好的得到解决，
但是仍然有其他不方便的地方在困扰着我们。

存在的问题

  1. 网络请求越来越多的情况下，会不停的在HttpMethods类中增加新的方法，网络请求的代码和业务逻辑紧紧的耦合在了一起，不符合我们程序员优雅的气质。能不能把HttpMethods封装好之后，不随着业务的改变而变动呢？
  2. 每次发送一个请求，都需要自己去处理rxjava中的onSubscribe(),onError(),onNext()和onComplete()方法。代码十分的冗余。其实我们大部分时候只需要关心onNext()的回调。其他的回调方法做的事情几乎一模一样。

解决办法

首先我们来看一下第一个问题：
其实HttpMethods处理业务逻辑最关键的方法是这个

public void getJoke(Observer<List<MyJoke>> observer){

        apiService.getData()
                .subscribeOn(Schedulers.io())
                .unsubscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(observer);
    }

作者：南柯一梦00
链接：https://www.jianshu.com/p/56f15db86ed3
來源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

这个方法传入了一个observer，然后用来接收回调，处理发送请求之后的逻辑。我们只需要改造这个方法，就能解决我们的第一个问题。

public <T> T getRetrofitService(Class<T> cls) {
        return createRetrofit(BASE_URL).create(cls);
    }

private Retrofit createRetrofit(String baseUrl) {
        HttpLoggingInterceptor logInterceptor = new HttpLoggingInterceptor(new HttpLogger());
        logInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient httpClient = new OkHttpClient().newBuilder()
                .readTimeout(DEFAULT_MILLISECONDS, TimeUnit.SECONDS)
                .connectTimeout(DEFAULT_MILLISECONDS, TimeUnit.SECONDS)
                .writeTimeout(DEFAULT_MILLISECONDS, TimeUnit.SECONDS)
                .retryOnConnectionFailure(true)
                .build();

        return new Retrofit.Builder()
                .baseUrl(baseUrl)
                .client(httpClient)
                .addConverterFactory(GsonConverterFactory.create(new Gson()))
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build();
    }

现在来看第二个问题，我们发现之前是传了一个叫observer的东西，然后就能处理onSubscribe(),onError(),onNext()和onComplete()方法，那么我们可以吧observer封装一下，提前处理好nSubscribe(),onError()和onComplete()方法，最后调用的时候只需要去处理onNext()就很完美了。
具体封装逻辑如下：

public abstract class ApiObserver<T extends IResult>
        extends DisposableObserver<T>
        implements ICallBack {
    private IBaseView apiAction;

    protected ApiObserver(IBaseView apiAction) {
        this.apiAction = apiAction;
    }

    @Override
    protected void onStart() {
        super.onStart();
        apiAction.showLoading();
    }

    @Override
    public void onNext(T t) {
        if (t.isSuccess()) {
            onSuccess(t);
        } else {
            if (t.getMessage() != null) {
                onFailure(t.getMessage());
            } else {
                onFailure("未知错误(服务器未返回错误原因)" +
                        "错误代码: " +
                        t.getCode());
            }
        }
        apiAction.dismissLoading();
    }

    @Override
    public void onError(Throwable e) {
        apiAction.dismissLoading();
        //HTTP错误
        if (e instanceof HttpException) {
            onException(ExceptionReason.BAD_NETWORK);
            //连接错误
        } else if (e instanceof ConnectException || e instanceof UnknownHostException) {
            onException(ExceptionReason.CONNECT_ERROR);
            //连接超时
        } else if (e instanceof InterruptedIOException) {
            onException(ExceptionReason.CONNECT_TIMEOUT);
            //解析错误
        } else if (e instanceof JsonParseException ||
                e instanceof JSONException ||
                e instanceof ParseException) {
            onException(ExceptionReason.PARSE_ERROR);
            //未知错误
        } else {
            apiAction.log(e.getMessage());
            onException(ExceptionReason.UNKNOWN_ERROR);
        }
    }

    @Override
    public void onComplete() {
        apiAction.dismissLoading();
        complete();
    }

    /**
     * 请求成功
     *
     * @param t 返回的数据
     */
    public abstract void onSuccess(T t);

    private void complete() {

    }


    /**
     * 网络请求异常
     *
     * @param reason 原因
     */
    private void onException(ExceptionReason reason) {
        switch (reason) {
            case BAD_NETWORK:
                apiAction.showErrorToast("网络问题");
                break;
            case CONNECT_ERROR:
                apiAction.showErrorToast("连接错误");
                break;
            case CONNECT_TIMEOUT:
                apiAction.showErrorToast("连接超时");
                break;
            case PARSE_ERROR:
                apiAction.showErrorToast("解析数据失败");
                break;
            case UNKNOWN_ERROR:
            default:
                apiAction.showErrorToast("未知错误");
                break;
        }
    }

    /**
     * 枚举网络请求失败原因
     */
    public enum ExceptionReason {
        //网络问题
        BAD_NETWORK,
        //连接错误
        CONNECT_ERROR,
        //连接超时
        CONNECT_TIMEOUT,
        //解析数据失败
        PARSE_ERROR,
        //未知错误
        UNKNOWN_ERROR,
    }

ICallBack 接口，用来实现默认的错误处理

public interface ICallBack {
    /**
     * 请求成功,但是返回的code不是200的情况下,默认弹出toast提示返回的Msg
     * 也可以覆盖这个方法,自行处理错误逻辑
     *
     * @param errorMsg 错误信息
     */
    default void onFailure(String errorMsg) {
        RxToast.error(errorMsg);
    }
}

利用Java泛型的基础来进行封装，因为一般接口的返回都会带上返回码和返回信息，比如一个登录接口基本长这样：

{
    "code": 200,
    "message": "成功!",
    "result": {
        "name": "xxx",
        "nikeName": "xxx",
        "headerImg": "https://ss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/logo_top_86d58ae1.png",
        "phone": "13888888888",
        "email": "123456@qq.com",
        "vipGrade": "6",
        "autograph": "没有个性，没有签名",
        "remarks": "这是一个备注，啦啦啦啦~"
    }
}

那么IResult就可以这样来写：

public interface IResult {

    /**
     * api result success or not
     *
     * @return true for success
     */
    boolean isSuccess();

    /**
     * 获取信息
     *
     * @return 成功或者失败的信息
     */
    String getMessage();

    int getCode();
}

所以可以根据这个来判断处理接口请求的结果。

在onStart()方法中展示一个正在加载的动画

在onFailure()方法中弹出吐司提示错误信息

这个封装就算完成第一步了

运行结果：


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