美文网首页
Rxjava + Retrofit网络请求封装

Rxjava + Retrofit网络请求封装

作者: 我弟是个程序员 | 来源:发表于2017-07-21 21:56 被阅读0次

    为什么说是代码提炼,而不是详解或是什么的呢,因为涉及的东西还真是比较多,要一点一点的讲,还真是一个很费工夫的事情。本人认为,先学会用得好用得爽了,道理后面就自然而然就通了。源代码 (提取码:6u5y)

    先看一下,这个优雅的实现,到底有多爽,那就要看在主线程中,我们调用接口获得数据,到底有多简洁了,如下看MainActivity.java:

    package com.dingfang.org.httputildemo;
    
    import android.os.Bundle;
    import android.support.v7.app.AppCompatActivity;
    import android.view.View;
    import android.widget.TextView;
    import android.widget.Toast;
    
    import com.dingfang.org.httputildemo.entity.Classfication;
    import com.dingfang.org.httputildemo.http.RetrofitUtils;
    import com.dingfang.org.httputildemo.http.request.ClassficationGet;
    import com.dingfang.org.httputildemo.subscribers.ProgressSubscriber;
    
    import java.util.List;
    
    public class MainActivity extends AppCompatActivity {
    
        private MainActivity _this;
    
        TextView textView;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
    
            init();
        }
    
        private void init() {
            _this = this;
            textView = (TextView) findViewById(R.id.text01);
        }
    
        public void doHttpRequest(View view) {
            //这个就是我们封装后的网络请求获取数据的部分,不能再简洁~~~此处,取代了传统的Handler接收处理数据的功能
            RetrofitUtils.getInstance().doHttp(new ClassficationGet(new ProgressSubscriber<List<Classfication>>(_this) {
                @Override
                public void onNext(List<Classfication> classfications) {
                    //get datas and do something here
                    Toast.makeText(_this, classfications.get(0).getTypeName(),Toast.LENGTH_SHORT).show();
                    textView.setText(classfications.get(0).getTypeName());
                }
    
            }));
        }
    }
    
    

    activity_main.xml文件:

    <?xml version="1.0" encoding="utf-8"?>
    <android.support.constraint.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context="com.dingfang.org.httputildemo.MainActivity">
    
        <TextView
            android:id="@+id/text01"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="Hello World!"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />
    
        <Button
            android:onClick="doHttpRequest"
            android:text="发送请求"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
    
    </android.support.constraint.ConstraintLayout>
    
    

    看吧,不能再简单了。这没有什么好解释的,那么接下来就看简洁背后的故事吧!
    首当其冲RetrofitUtils,因为上面的MainActivity 中有用到该类。先看代码RetrofitUtils.java:

    package com.dingfang.org.httputildemo.http;
    
    import java.lang.reflect.Field;
    import java.util.concurrent.TimeUnit;
    
    import okhttp3.OkHttpClient;
    import retrofit2.Retrofit;
    import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
    import retrofit2.converter.gson.GsonConverterFactory;
    import retrofit2.converter.scalars.ScalarsConverterFactory;
    import rx.android.schedulers.AndroidSchedulers;
    import rx.schedulers.Schedulers;
    
    /**
     * 基本数据请求工具类
     */
    public class RetrofitUtils {
        private static final int DEFAULT_TIMEOUT = 10;
        private RetrofitService retrofitService;
        private static RetrofitUtils INSTANCE;
    
        private RetrofitUtils(){
            retrofitService = create(RetrofitService.class);
        }
    
        /**
         * 暴露出去的单利模式
         * @return
         */
        public static RetrofitUtils getInstance(){
            if(INSTANCE == null){
                synchronized (RetrofitUtils.class){
                    if(INSTANCE == null){
                        INSTANCE = new RetrofitUtils();
                    }
                }
            }
            return INSTANCE;
        }
    
    
        /**
         * 创建被观察者 最终得到转化后的gson对象  如:User
         * @param service
         * @param <S>
         * @return
         */
        public <S> S create(Class<S> service) {
            Retrofit retrofit = new Retrofit.Builder()
                    .client(getOkHttpClient())
                    .addConverterFactory(GsonConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .baseUrl(getBaseUrl(service))
                    .build();
            return retrofit.create(service);
        }
    
        /**
         * 创建被观察者 最终得到字符串对象    如:"我时一个快乐的字符串"
         * @param service
         * @param <S>
         * @return
         */
        public <S> S create1(Class<S> service) {
            Retrofit retrofit = new Retrofit.Builder()
                    .client(getOkHttpClient())
                    .addConverterFactory(ScalarsConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .baseUrl(getBaseUrl(service))
                    .build();
            return retrofit.create(service);
        }
    
        /**
         *通过反射得到该类中的基址字符串对象
         * @param service
         * @param <S>
         * @return
         */
        private <S> String getBaseUrl(Class<S> service) {
            try {
                Field field = service.getField("BASE_URL");// 此处只能解析service类中形如 String BASE_URL = ApiInterface.API;的参数
                return (String) field.get(service);
            } catch (Exception e) {
                e.printStackTrace();
            }
            return "";
        }
    
        /**
         * 这里配置okHttp请求配置
         * @return
         */
        private OkHttpClient getOkHttpClient() {
            //配置超时拦截器
            OkHttpClient.Builder builder = new OkHttpClient.Builder();
            builder.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS);
            builder.writeTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS);
            builder.readTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS);
    
            //配置log打印拦截器
    //        HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
    //        loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
    //        builder.addInterceptor(loggingInterceptor);
            return builder.build();
        }
    
    
    
        /**
         * post、get等请求
         * @param httpResultFunc
         */
        public void doHttp(HttpResultFunc httpResultFunc){
            //通过结果来获取 Observable、Subscriber
            httpResultFunc.getObservable(retrofitService)
                    .subscribeOn(Schedulers.io())
                    .unsubscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .map(httpResultFunc)
                    .subscribe(httpResultFunc.getSubscriber());
        }
    }
    
    

    这个类的封装,针对Retrofit的,亮点太多,自己细细品味。这里主要看这一段:

        public void doHttp(HttpResultFunc httpResultFunc){
            //通过结果来获取 Observable、Subscriber
            httpResultFunc.getObservable(retrofitService)
                    .subscribeOn(Schedulers.io())
                    .unsubscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .map(httpResultFunc)
                    .subscribe(httpResultFunc.getSubscriber());
        }
    

    这里有一个HttpResultFunc 类,我看过好多大神的封装,觉得这个封装,是最让人拍案叫绝的封装方式,哈哈哈,原谅我自娱自乐一番~~~
    下面看一看这个HttpResultFunc.java类:

    package com.dingfang.org.httputildemo.http;
    
    import com.dingfang.org.httputildemo.entity.ResponseResult;
    import com.dingfang.org.httputildemo.exception.ResultErrorException;
    
    import rx.Observable;
    import rx.Subscriber;
    import rx.functions.Func1;
    
    /**
     * 所有基本数据请求实体类基类,必须继承自该类
     */
    public abstract class HttpResultFunc<T> implements Func1<ResponseResult<T>,T> {
    
        @Override
        public T call(ResponseResult<T> tResponseResult) {
            //这里的判断,要看每个用户后台给的返回数据的格式和规范而定
            if(tResponseResult.getStatus()!=1){
                throw  new ResultErrorException(tResponseResult.getReturnMsg());
            }
            return tResponseResult.getResult();
        }
    
        public abstract Observable getObservable(RetrofitService retrofitService);
    
        public abstract Subscriber getSubscriber();
    
    }
    

    这个类实际上所有网路请求接口将Rxjava中观察者和被观察者结合起来的一个类。
    下面可以来看看该类的一个实现类ClassficationGet.java:也就是具体调用接口的位置

    package com.dingfang.org.httputildemo.http.request;
    
    import com.dingfang.org.httputildemo.http.HttpResultFunc;
    import com.dingfang.org.httputildemo.http.RetrofitService;
    
    import rx.Observable;
    import rx.Subscriber;
    
    /**
     * 用来写具体些网络请求的类,请求参数都在这里声明
     */
    
    public class ClassficationGet extends HttpResultFunc {
    
        private Subscriber subscriber;
    
        public ClassficationGet(Subscriber subscriber) {
            this.subscriber = subscriber;
        }
    
        @Override
        public Observable getObservable(RetrofitService retrofitService) {
            return retrofitService.getClassfication();//调用接口
        }
    
        @Override
        public Subscriber getSubscriber() {
            return subscriber;
        }
    }
    

    上面说了,这个类是将Rxjava中观察者和被观察者结合起来的一个类。是不是很眼熟,当然了,这个类是调用接口的地方,那么不就是MainActivity中调用的那个类吗。
    那么就来看一看被观察者吧RetrofitService.java,这个类实际上市接口声明的地方,代码如下:

    package com.dingfang.org.httputildemo.http;
    
    import com.dingfang.org.httputildemo.entity.Classfication;
    import com.dingfang.org.httputildemo.entity.ResponseResult;
    
    import java.util.List;
    
    import retrofit2.http.GET;
    import rx.Observable;
    
    /**
     * 所有接口均写在该类下,类名不可修改,如需修改需在其他调用文件相应修改
     */
    public interface RetrofitService {    
    
        //接口前缀
        public String BASE_URL = "http://www.ttreader.com/ecp/rest/xxx/";
    
        //具体请求的接口
        @GET("com.cloud.bizinterface.service.IOrgService.queryCustomTypeByTypeGid(typeGid)")
        Observable<ResponseResult<List<Classfication>>> getClassfication();
    
    }
    

    所有的接口,都可以写在RetrofitService.java这个类文件中。这里用到了ResponseResult类,这个是一个金典啊,把所有的请求结果,都以统一的格式给封装了,这个类一般会根据公司内具体的返回字段而确定。我公司的返回字段如下,代码如下:

    package com.dingfang.org.httputildemo.entity;
    
    /**
     * 数据请求结果统一预处理实体类(要求服务器返回数据统一格式)
     * 如数据格式为:
     *
     *    {
     *    "status": 0,
     *    "returnMsg": "成功",
     *    "result": {}
     *    }
     *
     * result字段可以是数组字符串等,根据需求而定。
     * 可以具体需求进行更改该类字段格式
     *
     */
    public class ResponseResult<T> {
    
        private String returnMsg;
        private int status;
        private T result;
    
        public T getResult() {
            return result;
        }
    
        public void setResult(T result) {
            this.result = result;
        }
    
    
        public String getReturnMsg() {
            return returnMsg;
        }
    
        public void setReturnMsg(String returnMsg) {
            this.returnMsg = returnMsg;
        }
    
        public int getStatus() {
            return status;
        }
    
        public void setStatus(int status) {
            this.status = status;
        }
    
        @Override
        public String toString() {
            return "ResponseResult{" +
                    "returnMsg='" + returnMsg + '\'' +
                    ", status=" + status +
                    ", result=" + result +
                    '}';
        }
    }
    
    

    说完了被观察者,看面说说观察者,这里我的观察者,就是网络请求的圈圈,它观察的是网络请求的数据,在网络正常的情况下,若是数据没有到之前就转圈圈,给用户一个交互,由于这不是今天分享的内容的主要部分,就不细细分析了,直接看代码吧:

    package com.dingfang.org.httputildemo.subscribers;
    
    import android.content.Context;
    
    import com.dingfang.org.httputildemo.progress.HHProgressAlertDialog;
    import com.dingfang.org.httputildemo.progress.ProgressCancelListener;
    import com.dingfang.org.httputildemo.utils.ToastUtils;
    
    import java.lang.ref.WeakReference;
    import java.net.ConnectException;
    import java.net.SocketTimeoutException;
    
    import rx.Subscriber;
    
    /**
     * Created by:hcs on 2016/10/17 16:38
     * e_mail:aaron1539@163.com
     */
    public abstract class ProgressSubscriber<T> extends Subscriber<T> implements ProgressCancelListener {
    
        private HHProgressAlertDialog progressAlertDialog;
        private ToastUtils toast;
        private boolean isShowProgress = true;
        private WeakReference<Context> contextWeakReference;
    
        /**
         *  默认显示弹出框,不可以取消
         * @param context
         */
        public ProgressSubscriber(Context context){
            contextWeakReference = new WeakReference<Context>(context);
            init(false);
        }
    
        /**
         * 可设置弹出框是否显示取消
         * @param context
         * @param isShowProgress 是否显示弹出框
         * @param isCancel 是否可以取消
         */
        public ProgressSubscriber(Context context, boolean isShowProgress, boolean isCancel){
            this.isShowProgress = isShowProgress;
            this.contextWeakReference = new WeakReference<Context>(context);
            init(isCancel);
        }
    
        /**
         * 初始化
         * @param isCancel
         */
        private void init(boolean isCancel) {
            Context context = contextWeakReference.get();
            progressAlertDialog = new HHProgressAlertDialog(context);
            progressAlertDialog.setCancelable(isCancel);
            toast = new ToastUtils(context);
        }
    
        private void showProgress(){
            if(!isShowProgress){
                return;
            }
            if(progressAlertDialog!=null){
                if(!progressAlertDialog.isShowing()){
                    progressAlertDialog.show();
                }
            }
        }
    
        private void dismissProgress(){
            if(!isShowProgress){
                return;
            }
            if(progressAlertDialog!=null){
                if(progressAlertDialog.isShowing()){
                    progressAlertDialog.dismiss();
                }
            }
        }
    
        @Override
        public void onStart() {
            showProgress();
        }
    
        @Override
        public void onCompleted() {
            dismissProgress();
        }
    
        @Override
        public void onError(Throwable e) {
            if (e instanceof SocketTimeoutException) {
                toast.showSingleToast("网络中断,请检查您的网络状态");
            } else if (e instanceof ConnectException) {
                toast.showSingleToast("网络中断,请检查您的网络状态");
            } else {
                toast.showSingleToast("error:" + e.getMessage());
            }
            dismissProgress();
        }
    
        @Override
        public void onCancelProgress() {
            if(!this.isUnsubscribed()){
                this.unsubscribe();
            }
        }
    }
    

    到此,在MainActivity中出现了的类,都已经列出来了,当然,还有些辅助类,没有列出来。详细代码可以参考源代码 (提取码:6u5y)
    上面Rxjava的观察者和被观察者都出现了,Retrofit网络请求也贴出来了,今天的内容重点也就分享完了。是不是还不迷糊的。是的,那就下载demo跑起来看源码吧。

    相关文章

      网友评论

          本文标题:Rxjava + Retrofit网络请求封装

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