一步步搭建Retrofit+RxJava+MVP網絡請求框架（二），個人認為這次封裝比較強大了

在前面已經初步封裝了一個MVP的網絡請求框架，那只是個雛形，還有很多功能不完善，現在進一步進行封裝。添加了網絡請求時的等待框，retrofit中添加了日志打印攔截器，添加了token攔截器，並且對DataManager類進行了擴展，真正體現它的作用，並且對大量的重復代碼做了一定封裝，減少代碼的冗余。

下面結合上篇文章，進行下一步的封裝。

1、首先完善Result.java這個類。

通常在我們寫API接口文檔的時候，后端返回的數據格式都是

 

"code":1    //1：成功

                 //-1：token驗證失敗

“msg”:”success”, //返回的消息提示

           “token驗證失敗”  

“data”:   //數據

{

“username”:” xdw” ,  //用戶名

"age":30  //年齡

}

具體的Result.java的代碼如下，里面還加入了一個對返回碼的判斷方法

package com.xdw.retrofitrxmvpdemo.model;

import com.xdw.retrofitrxmvpdemo.constant.Constant;

/**
 * Created by 夏德旺 on 2017/12/8.
 */

public class Result<T> {
    private int code;
    private String msg;
    private T data;

    public Result(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    //添加對返回狀態成功的判斷
    public boolean isSuccess() {
        return code == Constant.SUCCESS;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    public T getData() {
        return data;
    }

}

2、添加ProgressDialogHandler和ProgressCancelListener，用來處理網絡請求等待框。代碼如下

ProgressCancelListener：

package com.xdw.retrofitrxmvpdemo.model;

/**
 * Created by 夏德旺 on 2017/12/8.
 */
public interface ProgressCancelListener {
    void onCancelProgress();
}

ProgressDialogHandler：

package com.xdw.retrofitrxmvpdemo.http;

import android.app.ProgressDialog;
import android.content.Context;
import android.content.DialogInterface;
import android.os.Handler;
import android.os.Message;

/**
 * Created by 夏德旺 on 2017/12/8.
 */
public class ProgressDialogHandler extends Handler {

    public static final int SHOW_PROGRESS_DIALOG = 1;
    public static final int DISMISS_PROGRESS_DIALOG = 2;

    private ProgressDialog pd;

    private Context context;
    private boolean cancelable;
    private boolean show;
    private ProgressCancelListener mProgressCancelListener;

    public ProgressDialogHandler(Context context, ProgressCancelListener mProgressCancelListener,
                                 boolean cancelable,boolean show) {
        super();
        this.context = context;
        this.mProgressCancelListener = mProgressCancelListener;
        this.cancelable = cancelable;
        this.show = show;
    }

    private void initProgressDialog(){
        if (pd == null) {
            pd = new ProgressDialog(context);

            pd.setCancelable(cancelable);

            if (cancelable) {
                pd.setOnCancelListener(new DialogInterface.OnCancelListener() {
                    @Override
                    public void onCancel(DialogInterface dialogInterface) {
                        mProgressCancelListener.onCancelProgress();
                    }
                });
            }

            if (!pd.isShowing()&&show) {
                pd.show();
            }
        }
    }

    private void dismissProgressDialog(){
        if (pd != null) {
            pd.dismiss();
            pd = null;
        }
    }

    @Override
    public void handleMessage(Message msg) {
        switch (msg.what) {
            case SHOW_PROGRESS_DIALOG:
                initProgressDialog();
                break;
            case DISMISS_PROGRESS_DIALOG:
                dismissProgressDialog();
                break;
        }
    }

}

3、改寫RetrofitApiService，將返回結果由原來的UserInfo改為Result<UserInfo>。

public interface RetrofitApiService {

    @GET("user")
    Observable<Result<UserInfo>> getUserInfo(@Query("uid") int uid);

}

4、完善之前的RetrofitUtil，加入日志與token攔截器，token這段我注釋掉了，根據自己的實際項目進行添加

package com.xdw.retrofitrxmvpdemo.http;

import android.content.Context;

import com.google.gson.GsonBuilder;
import com.xdw.retrofitrxmvpdemo.BuildConfig;
import com.xdw.retrofitrxmvpdemo.constant.UrlConstant;

import java.io.IOException;

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.logging.HttpLoggingInterceptor;
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
import retrofit2.converter.gson.GsonConverterFactory;

/**
 * Created by 夏德旺 on 2017/12/8.
 */

public class RetrofitUtil {
    private Context mCntext;
    //聲明Retrofit對象
    private Retrofit mRetrofit;
    //聲明RetrofitApiService對象
    private RetrofitApiService retrofitApiService;
    GsonConverterFactory factory = GsonConverterFactory.create(new GsonBuilder().create());
    //由於該對象會被頻繁調用，采用單例模式，下面是一種線程安全模式的單例寫法
    private volatile static RetrofitUtil instance;

    public static RetrofitUtil getInstance(Context context){
        if (instance == null) {
            synchronized (RetrofitUtil.class) {
                if (instance == null) {
                    instance = new RetrofitUtil(context);
                }
            }
        }
        return instance;
    }
    private RetrofitUtil(Context mContext){
        mCntext = mContext;
        init();
    }

    //初始化Retrofit
    private void init() {

        //添加token攔截
/*        final String token = AppSPUtils.getValueFromPrefrences(AppConstants.SP_TOKEN, "");
        final int uid = AppSPUtils.getValueFromPrefrences(AppConstants.SP_USERID, 0);
        Interceptor mTokenInterceptor = new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request authorised = chain.request().newBuilder()
                        .addHeader("userId", String.valueOf(uid))
                        .addHeader("token", token)
                        .build();
                return chain.proceed(authorised);
            }
        };*/
        //打印請求log日志
        OkHttpClient httpClient = new OkHttpClient();
        if (BuildConfig.DEBUG) {
            HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
            httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
            httpClient = new OkHttpClient.Builder()
                    .addInterceptor(httpLoggingInterceptor)
//                    .addInterceptor(mTokenInterceptor)
                    .build();
        }
        mRetrofit = new Retrofit.Builder()
                .baseUrl(UrlConstant.BASE_URL)
                .client(httpClient)
                .addConverterFactory(factory)
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();
        retrofitApiService = mRetrofit.create(RetrofitApiService.class);
    }

    public RetrofitApiService getRetrofitApiService(){
        return retrofitApiService;
    }
}

5、重要的地方來了，完善之前的DataManager。之前這個類大家可以覺得非常雞肋，因為它什么也沒干，就是把RetrofitApiService和RetrofitUtil 該干的活移動到了這類中，非但沒有減輕任務量，反而要多寫一大堆重復代碼。等現在封裝之后就可以發現它的大作用了。

我們現在在RetrofitApiService中的getUserInfo方法的返回值變成了Result<UserInfo>，但是實際上最后我們要的數據僅僅是UserInfo，這時可以對之前的DataManager中的getUserInfo方法修改下，如下

    public Observable<UserInfo>  getUserInfo(int uid){
        return mRetrofitService.getUserInfo(uid).map(new ResultFunc<UserInfo>() );
    }

這里使用了rxjava中的map這個關鍵方法將數據進行了剝離出來，不懂這個方法的請自己去查閱rxjava的資料。

在DataManager中同時定義了一個內部類，如下

 public class ResultFunc<T> implements Func1<Result<T>, T> {
        @Override
        public T call(Result<T> result) {
            //在這里對對服務端返回的resultCode進行判斷，如果返回碼不是成功，
            // 則拋出自定義的API異常，比如token登陸失敗時。拋出異常的異常可以統一
            // 在Subscriber的子類ProgressSubscriber中進行處理，這樣就不用到
            // 每個Activity中再來進行處理
            if (!result.isSuccess()) {
                throw new APIException(result.getCode(), result.getMsg());
            }
            return result.getData();
        }
    }

這里補充自己定義的一個異常類APIException的代碼，如下

package com.xdw.retrofitrxmvpdemo.util;

/**
 * 自定義異常
 * Created by 夏德旺 on 2017/12/8.
 */
public class APIException extends RuntimeException{
    public int code;
    public String message;

    public APIException(int code, String message) {
        this.code = code;
        this.message = message;
    }

    @Override
    public String getMessage() {
        return message;
    }

    public int getCode() {
        return code;
    }
}

DataManager的封裝到此完成，具體它的應用請看后面的UserInfoPresenter中的調用

6、在BasePresenter中添加一個addSubscription方法，這個是對每次的訂閱進行封裝，簡化重復代碼量

    //將每次的訂閱操作進行封裝，簡化重復代碼量
    public <T> void addSubscription(Observable<T> o, Subscriber<T> s) {
        mCompositeSubscription.add(o.unsubscribeOn(Schedulers.io())
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(s));

    }

7、再來看看具體處理業務邏輯的UserInfoPresenter的代碼是不是會清爽很多

package com.xdw.retrofitrxmvpdemo.presenter;

import android.content.Context;
import android.util.Log;

import com.xdw.retrofitrxmvpdemo.http.ProgressSubscriber;
import com.xdw.retrofitrxmvpdemo.manager.DataManager;
import com.xdw.retrofitrxmvpdemo.model.Result;
import com.xdw.retrofitrxmvpdemo.model.UserInfo;
import com.xdw.retrofitrxmvpdemo.pv.PresentView;
import com.xdw.retrofitrxmvpdemo.pv.UserInfoPv;

import rx.Observable;
import rx.Observer;
import rx.Subscriber;
import rx.android.schedulers.AndroidSchedulers;
import rx.functions.Func1;
import rx.schedulers.Schedulers;

/**
 * Created by 夏德旺 on 2017/12/8.
 */

//該類是具體業務presenter，如需增加另一個業務，比如Order
//則可以再創建一個OrderPresenter
public class UserInfoPresenter extends BasePresenter {
    private Context mContext;
    private UserInfoPv mUserInfoPv;
    private UserInfo mUserInfo;

    public UserInfoPresenter(Context context) {
        this.mContext = context;
    }

    @Override
    public void BindPresentView(PresentView presentView) {
        mUserInfoPv = (UserInfoPv) presentView;
    }

    //在presenter中實現業務邏輯，此處會調用前面封裝好的retrofit的東西
    //將處理結果綁定到對應的PresentView實例，這樣Activity和PresentView實例綁定好之后，
    //Activity->PresentView->Presenter->retrofit的關系就打通了
    public void getUserInfo(int uid) {
        Observable<UserInfo> observable = DataManager.getInstance(mContext).getUserInfo(uid);
        addSubscription(observable,new ProgressSubscriber<UserInfo>(mUserInfoPv, mContext, true) {
            @Override
            public void onNext(UserInfo userInfo) {
                super.onNext(userInfo);
                mUserInfoPv.onSuccess(userInfo);
            }
        } );
    }
}

這個getUserInfo是不是清爽了很多，首先通過DataManager的封裝，可以很方便的獲取剝離出了核心數據的observable，然后調用父類中的addSubscription來處理具體的業務。大家看到這里會發現業務邏輯中的onCompleted與onError這2個核心方法怎么不見了。這些我們都統一封裝到了ProgressSubscriber中。繼續往下看

8、封裝ProgressSubscriber，它繼承Subscriber類，並且實現ProgressCancelListener接口。在該類中統一對報錯（並且包括自定義的API異常）和網絡對話框的出現與消失做了處理。這樣就簡化了我們大量的操作，不用再到每個界面中單獨對其進行判斷處理。具體代碼如下

package com.xdw.retrofitrxmvpdemo.http;
import android.content.Context;
import android.util.Log;
import android.widget.Toast;

import com.xdw.retrofitrxmvpdemo.pv.PresentView;
import com.xdw.retrofitrxmvpdemo.util.APIException;

import java.net.ConnectException;
import java.net.SocketTimeoutException;

import rx.Subscriber;

/**
 * 用於在Http請求開始時，自動顯示一個ProgressDialog
 * 在Http請求結束時，關閉ProgressDialog
 * 調用者自己對請求數據進行處理
 * Created by 夏德旺 on 2017/12/8.
 */
public class ProgressSubscriber<T> extends Subscriber<T> implements ProgressCancelListener{

    private PresentView mPresentView;
    private ProgressDialogHandler mProgressDialogHandler;

    private Context context;

    public ProgressSubscriber(PresentView mPresentView, Context context, boolean show) {
        this.mPresentView = mPresentView;
        this.context = context;
        mProgressDialogHandler = new ProgressDialogHandler(context, this, true,show);
    }
    public ProgressSubscriber(Context context,boolean show) {
        this.context = context;
        mProgressDialogHandler = new ProgressDialogHandler(context, this, true,show);
    }

    private void showProgressDialog(){
        if (mProgressDialogHandler != null) {
            mProgressDialogHandler.obtainMessage(ProgressDialogHandler.SHOW_PROGRESS_DIALOG).sendToTarget();
        }
    }

    private void dismissProgressDialog(){
        if (mProgressDialogHandler != null) {
            mProgressDialogHandler.obtainMessage(ProgressDialogHandler.DISMISS_PROGRESS_DIALOG).sendToTarget();
            mProgressDialogHandler = null;
        }
    }

    /**
     * 訂閱開始時調用
     * 顯示ProgressDialog
     */
    @Override
    public void onStart() {
        showProgressDialog();
    }

    /**
     * 完成，隱藏ProgressDialog
     */
    @Override
    public void onCompleted() {
        dismissProgressDialog();
    }

    /**
     * 對錯誤進行統一處理
     * 隱藏ProgressDialog
     * @param e
     */
    @Override
    public void onError(Throwable e) {
        if (e instanceof SocketTimeoutException) {
            Toast.makeText(context,"網絡中斷，請檢查您的網絡狀態",Toast.LENGTH_SHORT).show();
        } else if (e instanceof ConnectException) {
            Toast.makeText(context,"網絡中斷，請檢查您的網絡狀態",Toast.LENGTH_SHORT).show();
        } else if(e instanceof APIException){
            Toast.makeText(context,e.getMessage(),Toast.LENGTH_SHORT).show();
            Log.e("xdw","apiCode="+((APIException) e).getCode());
        }else{
            Toast.makeText(context,"未知異常",Toast.LENGTH_SHORT).show();
            Log.e("xdw","apiCode="+((APIException) e).getCode());
        }
        dismissProgressDialog();

    }

    /**
     * 將onNext方法中的返回結果交給Activity或Fragment自己處理
     *
     * @param t 創建Subscriber時的泛型類型
     */
    @Override
    public void onNext(T t) {

    }

    /**
     * 取消ProgressDialog的時候，取消對observable的訂閱，同時也取消了http請求
     */
    @Override
    public void onCancelProgress() {
        if (!this.isUnsubscribed()) {
            this.unsubscribe();
        }
    }
}

9、由於已經對錯誤進行了統一處理，那么這里在PresentView接口中去掉了之前定義的onError方法。

package com.xdw.retrofitrxmvpdemo.pv;

/**
 * Created by 夏德旺 on 2017/12/8.
 */

public interface PresentView{
    //定義一個最基礎的接口，里面就包含一個出錯信息的回調
    //因為大多數時候報錯的時候都是采用一條信息提示
    //如果需要負責的報錯接口，請重載onError，是重載不是重寫
    //經過后面加入第二次封裝之后，這里的onError刪除了，統一封裝到了ProgressSubscriber中
    //如果需要特定的具體要到每個Activity中去重寫報錯信息的，可以在此再添加一個onError處理
}

10、最后我們來看看MainActivity中的處理，基本和之前沒什么變化，就是少了個onError的方法

package com.xdw.retrofitrxmvpdemo.activity;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import com.xdw.retrofitrxmvpdemo.R;
import com.xdw.retrofitrxmvpdemo.model.UserInfo;
import com.xdw.retrofitrxmvpdemo.presenter.UserInfoPresenter;
import com.xdw.retrofitrxmvpdemo.pv.UserInfoPv;

public class MainActivity extends AppCompatActivity {
    private TextView text;
    private Button button;
    //定義需要調用的presenter對象
    private UserInfoPresenter mUserInfoPresenter =new UserInfoPresenter(this);

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        text = (TextView)findViewById(R.id.text);
        button = (Button)findViewById(R.id.button);
        //在Activity創建的時候同時初始化presenter，這里onCreater不是指的創建presenter對象，
        // 而是做一些presenter的初始化操作，名字應該取名init更好理解點，我這里就不重命名了
        mUserInfoPresenter.onCreate();
        //將presenter和PresentView進行綁定，實際上就是將presenter和Activity視圖綁定，
        //這個是MVP模式中V與P交互的關鍵
        mUserInfoPresenter.BindPresentView(mUserInfoPv);
        button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //點擊按鈕觸發presenter里面的方法
                mUserInfoPresenter.getUserInfo(1);
            }
        });

    }

    //采用內部類方法定義presentView對象，該對象用來將Activity和presenter進行綁定
    //綁定了以后主線程中就可以通過回調來獲取網絡請求的數據
    private UserInfoPv mUserInfoPv = new UserInfoPv(){
        @Override
        public void onSuccess(UserInfo userInfo) {
            text.setText(userInfo.toString());
        }
    };

    //在Activity銷毀的時候，一定要對CompositeSubscription進行釋放，否則會造成內存泄漏
    //釋放操作封裝到了presenter的ondestroy方法中
    @Override
    protected void onDestroy(){
        super.onDestroy();
        mUserInfoPresenter.onDestroy();
    }
}

 

到此整個封裝完畢，我也用自己之前做的項目檢驗了下，確實也很好用。下面跟上篇博客一樣介紹下使用方法。

 

列舉下之后像該項目中擴展業務的步驟，比如加一個訂單功能。


操作步驟:


1、添加對應的model類Order


2、RetrofitApiService中添加對應的網絡請求api，此時的api格式是帶上Result的


3、將新添加的api映射到DataManager中，此時在DataManager中的api是剝離出實際數據之后的


4、添加業務對應的PrensentView實例OrderPv


5、添加業務對應的Presenter實例OrderPresenter


6、在需要該業務的UI線程（Activity或Fragment）中調用具體業務對應的Presenter

 

 

其實操作步驟沒有太大變化，但是將返回結果換成了統一的數據格式，加入了返回碼和返回消息，方便客戶端對錯誤進行統一處理。同時添加了log與token的攔截器，並且簡化了RxJava相關的代碼操作。至此，一個完整的MVP框架封裝完成。