一步步搭建Retrofit+RxJava+MVP网络请求框架(二),个人认为这次封装比较强大了...
在前面已經(jīng)初步封裝了一個(gè)MVP的網(wǎng)絡(luò)請(qǐng)求框架,那只是個(gè)雛形,還有很多功能不完善,現(xiàn)在進(jìn)一步進(jìn)行封裝。添加了網(wǎng)絡(luò)請(qǐng)求時(shí)的等待框,retrofit中添加了日志打印攔截器,添加了token攔截器,并且對(duì)DataManager類進(jìn)行了擴(kuò)展,真正體現(xiàn)它的作用,并且對(duì)大量的重復(fù)代碼做了一定封裝,減少代碼的冗余。
下面結(jié)合上篇文章,進(jìn)行下一步的封裝。
1、首先完善Result.java這個(gè)類。
通常在我們寫API接口文檔的時(shí)候,后端返回的數(shù)據(jù)格式都是
?
"code":1????//1:成功
? ? ? ? ? ? ? ? ?//-1:token驗(yàn)證失敗
“msg”:”success”, //返回的消息提示
? ? ? ? ? ?“token驗(yàn)證失敗”??
“data”:? ?//數(shù)據(jù)
{
“username”:” xdw” ,? //用戶名
"age":30? //年齡
}
具體的Result.java的代碼如下,里面還加入了一個(gè)對(duì)返回碼的判斷方法
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;}//添加對(duì)返回狀態(tài)成功的判斷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,用來處理網(wǎng)絡(luò)請(qǐng)求等待框。代碼如下
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() {@Overridepublic void onCancel(DialogInterface dialogInterface) {mProgressCancelListener.onCancelProgress();}});}if (!pd.isShowing()&&show) {pd.show();}}}private void dismissProgressDialog(){if (pd != null) {pd.dismiss();pd = null;}}@Overridepublic void handleMessage(Message msg) {switch (msg.what) {case SHOW_PROGRESS_DIALOG:initProgressDialog();break;case DISMISS_PROGRESS_DIALOG:dismissProgressDialog();break;}}}3、改寫RetrofitApiService,將返回結(jié)果由原來的UserInfo改為Result<UserInfo>。
public interface RetrofitApiService {@GET("user")Observable<Result<UserInfo>> getUserInfo(@Query("uid") int uid);}4、完善之前的RetrofitUtil,加入日志與token攔截器,token這段我注釋掉了,根據(jù)自己的實(shí)際項(xiàng)目進(jìn)行添加
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對(duì)象private Retrofit mRetrofit;//聲明RetrofitApiService對(duì)象private RetrofitApiService retrofitApiService;GsonConverterFactory factory = GsonConverterFactory.create(new GsonBuilder().create());//由于該對(duì)象會(huì)被頻繁調(diào)用,采用單例模式,下面是一種線程安全模式的單例寫法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();}//初始化Retrofitprivate void init() {//添加token攔截 /* final String token = AppSPUtils.getValueFromPrefrences(AppConstants.SP_TOKEN, "");final int uid = AppSPUtils.getValueFromPrefrences(AppConstants.SP_USERID, 0);Interceptor mTokenInterceptor = new Interceptor() {@Overridepublic Response intercept(Chain chain) throws IOException {Request authorised = chain.request().newBuilder().addHeader("userId", String.valueOf(uid)).addHeader("token", token).build();return chain.proceed(authorised);}};*///打印請(qǐng)求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。之前這個(gè)類大家可以覺得非常雞肋,因?yàn)樗裁匆矝]干,就是把RetrofitApiService和RetrofitUtil 該干的活移動(dòng)到了這類中,非但沒有減輕任務(wù)量,反而要多寫一大堆重復(fù)代碼。等現(xiàn)在封裝之后就可以發(fā)現(xiàn)它的大作用了。
我們現(xiàn)在在RetrofitApiService中的getUserInfo方法的返回值變成了Result<UserInfo>,但是實(shí)際上最后我們要的數(shù)據(jù)僅僅是UserInfo,這時(shí)可以對(duì)之前的DataManager中的getUserInfo方法修改下,如下
public Observable<UserInfo> getUserInfo(int uid){return mRetrofitService.getUserInfo(uid).map(new ResultFunc<UserInfo>() );}這里使用了rxjava中的map這個(gè)關(guān)鍵方法將數(shù)據(jù)進(jìn)行了剝離出來,不懂這個(gè)方法的請(qǐng)自己去查閱rxjava的資料。
在DataManager中同時(shí)定義了一個(gè)內(nèi)部類,如下
public class ResultFunc<T> implements Func1<Result<T>, T> {@Overridepublic T call(Result<T> result) {//在這里對(duì)對(duì)服務(wù)端返回的resultCode進(jìn)行判斷,如果返回碼不是成功,// 則拋出自定義的API異常,比如token登陸失敗時(shí)。拋出異常的異常可以統(tǒng)一// 在Subscriber的子類ProgressSubscriber中進(jìn)行處理,這樣就不用到// 每個(gè)Activity中再來進(jìn)行處理if (!result.isSuccess()) {throw new APIException(result.getCode(), result.getMsg());}return result.getData();}}這里補(bǔ)充自己定義的一個(gè)異常類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;}@Overridepublic String getMessage() {return message;}public int getCode() {return code;} }DataManager的封裝到此完成,具體它的應(yīng)用請(qǐng)看后面的UserInfoPresenter中的調(diào)用
6、在BasePresenter中添加一個(gè)addSubscription方法,這個(gè)是對(duì)每次的訂閱進(jìn)行封裝,簡化重復(fù)代碼量
//將每次的訂閱操作進(jìn)行封裝,簡化重復(fù)代碼量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、再來看看具體處理業(yè)務(wù)邏輯的UserInfoPresenter的代碼是不是會(huì)清爽很多
這個(gè)getUserInfo是不是清爽了很多,首先通過DataManager的封裝,可以很方便的獲取剝離出了核心數(shù)據(jù)的observable,然后調(diào)用父類中的addSubscription來處理具體的業(yè)務(wù)。大家看到這里會(huì)發(fā)現(xiàn)業(yè)務(wù)邏輯中的onCompleted與onError這2個(gè)核心方法怎么不見了。這些我們都統(tǒng)一封裝到了ProgressSubscriber中。繼續(xù)往下看
8、封裝ProgressSubscriber,它繼承Subscriber類,并且實(shí)現(xiàn)ProgressCancelListener接口。在該類中統(tǒng)一對(duì)報(bào)錯(cuò)(并且包括自定義的API異常)和網(wǎng)絡(luò)對(duì)話框的出現(xiàn)與消失做了處理。這樣就簡化了我們大量的操作,不用再到每個(gè)界面中單獨(dú)對(duì)其進(jìn)行判斷處理。具體代碼如下
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請(qǐng)求開始時(shí),自動(dòng)顯示一個(gè)ProgressDialog* 在Http請(qǐng)求結(jié)束時(shí),關(guān)閉ProgressDialog* 調(diào)用者自己對(duì)請(qǐng)求數(shù)據(jù)進(jìn)行處理* 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;}}/*** 訂閱開始時(shí)調(diào)用* 顯示ProgressDialog*/@Overridepublic void onStart() {showProgressDialog();}/*** 完成,隱藏ProgressDialog*/@Overridepublic void onCompleted() {dismissProgressDialog();}/*** 對(duì)錯(cuò)誤進(jìn)行統(tǒng)一處理* 隱藏ProgressDialog* @param e*/@Overridepublic void onError(Throwable e) {if (e instanceof SocketTimeoutException) {Toast.makeText(context,"網(wǎng)絡(luò)中斷,請(qǐng)檢查您的網(wǎng)絡(luò)狀態(tài)",Toast.LENGTH_SHORT).show();} else if (e instanceof ConnectException) {Toast.makeText(context,"網(wǎng)絡(luò)中斷,請(qǐng)檢查您的網(wǎng)絡(luò)狀態(tài)",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方法中的返回結(jié)果交給Activity或Fragment自己處理** @param t 創(chuàng)建Subscriber時(shí)的泛型類型*/@Overridepublic void onNext(T t) {}/*** 取消ProgressDialog的時(shí)候,取消對(duì)observable的訂閱,同時(shí)也取消了http請(qǐng)求*/@Overridepublic void onCancelProgress() {if (!this.isUnsubscribed()) {this.unsubscribe();}} }
9、由于已經(jīng)對(duì)錯(cuò)誤進(jìn)行了統(tǒng)一處理,那么這里在PresentView接口中去掉了之前定義的onError方法。
10、最后我們來看看MainActivity中的處理,基本和之前沒什么變化,就是少了個(gè)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;//定義需要調(diào)用的presenter對(duì)象private UserInfoPresenter mUserInfoPresenter =new UserInfoPresenter(this);@Overrideprotected 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創(chuàng)建的時(shí)候同時(shí)初始化presenter,這里onCreater不是指的創(chuàng)建presenter對(duì)象,// 而是做一些presenter的初始化操作,名字應(yīng)該取名init更好理解點(diǎn),我這里就不重命名了 mUserInfoPresenter.onCreate();//將presenter和PresentView進(jìn)行綁定,實(shí)際上就是將presenter和Activity視圖綁定,//這個(gè)是MVP模式中V與P交互的關(guān)鍵 mUserInfoPresenter.BindPresentView(mUserInfoPv);button.setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) {//點(diǎn)擊按鈕觸發(fā)presenter里面的方法mUserInfoPresenter.getUserInfo(1);}});}//采用內(nèi)部類方法定義presentView對(duì)象,該對(duì)象用來將Activity和presenter進(jìn)行綁定//綁定了以后主線程中就可以通過回調(diào)來獲取網(wǎng)絡(luò)請(qǐng)求的數(shù)據(jù)private UserInfoPv mUserInfoPv = new UserInfoPv(){@Overridepublic void onSuccess(UserInfo userInfo) {text.setText(userInfo.toString());}};//在Activity銷毀的時(shí)候,一定要對(duì)CompositeSubscription進(jìn)行釋放,否則會(huì)造成內(nèi)存泄漏//釋放操作封裝到了presenter的ondestroy方法中 @Overrideprotected void onDestroy(){super.onDestroy();mUserInfoPresenter.onDestroy();} }?
到此整個(gè)封裝完畢,我也用自己之前做的項(xiàng)目檢驗(yàn)了下,確實(shí)也很好用。下面跟上篇博客一樣介紹下使用方法。
?
列舉下之后像該項(xiàng)目中擴(kuò)展業(yè)務(wù)的步驟,比如加一個(gè)訂單功能。
操作步驟:
1、添加對(duì)應(yīng)的model類Order
2、RetrofitApiService中添加對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求api,此時(shí)的api格式是帶上Result的
3、將新添加的api映射到DataManager中,此時(shí)在DataManager中的api是剝離出實(shí)際數(shù)據(jù)之后的
4、添加業(yè)務(wù)對(duì)應(yīng)的PrensentView實(shí)例OrderPv
5、添加業(yè)務(wù)對(duì)應(yīng)的Presenter實(shí)例OrderPresenter
6、在需要該業(yè)務(wù)的UI線程(Activity或Fragment)中調(diào)用具體業(yè)務(wù)對(duì)應(yīng)的Presenter
?
?
其實(shí)操作步驟沒有太大變化,但是將返回結(jié)果換成了統(tǒng)一的數(shù)據(jù)格式,加入了返回碼和返回消息,方便客戶端對(duì)錯(cuò)誤進(jìn)行統(tǒng)一處理。同時(shí)添加了log與token的攔截器,并且簡化了RxJava相關(guān)的代碼操作。至此,一個(gè)完整的MVP框架封裝完成。
?
轉(zhuǎn)載于:https://www.cnblogs.com/xiadewang/p/8022777.html
總結(jié)
以上是生活随笔為你收集整理的一步步搭建Retrofit+RxJava+MVP网络请求框架(二),个人认为这次封装比较强大了...的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: CompletableFuture的正常
- 下一篇: 马士兵内部资料—《Java面试突击核心讲