美文网首页Android开发经验谈Android开发Android技术知识
封装RxJava+Retrofit+OkHttp系列——(一)自

封装RxJava+Retrofit+OkHttp系列——(一)自

作者: pokerfaceCmy | 来源:发表于2019-04-24 11:31 被阅读4次

    完整项目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

    相关文章

      网友评论

        本文标题:封装RxJava+Retrofit+OkHttp系列——(一)自

        本文链接:https://www.haomeiwen.com/subject/mxwwgqtx.html