MVP實戰心得---封裝Retrofit2.0+RxAndroid+RxBus

jlanglang發表於2018-01-12
MVP封裝Android

介紹:

Retrofit:

對okhttp的封裝,可以更方便的使用okhttp

RxAndroid

響應式程式設計框架,rxjava的擴充套件,很爽的鏈式程式設計 魅力在於對資料的處理,與執行緒切換的靈活性. 用來處理非同步操作(Lambda表示式不會用.用Lambda表示式程式碼會更少,但不會的人會看不懂程式碼.不是很推薦)

RxBus

用RxJava實現的EventBus

說說為什麼要配合起來用

Retrofit負責連結網路,請求網路. RxAndroid負責處理請求的結果.非同步操作 RxBus可以很方便的進行各元件之間的通訊. 我之前是用asynchttpclient做網路請求的,各種程式碼縮排,if套if,各種回撥,慘不忍睹啊. 用了Retrofit+RxAndroid我就徹底放棄asynchttpclient了.

使用

1.RxJava

傳送門:RxJava---------這個作為入門學習rxjava非常好

2.Retrofit

這個寫點基本的用法吧..

首先看用的包:

//retrofit2--看名字就知道是啥了
compile 'com.squareup.retrofit2:retrofit:2.1.0'
//CallAdapterFactory的Rx依賴包---導這個包才能配合rxAndroid使用
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
//ConverterFactory的String依賴包----這個是解析資料的工廠.用來格式化資料的,配置編碼啊,gson解析啊.
compile 'com.squareup.retrofit2:converter-scalars:2.1.0'
複製程式碼

然後是retrofit註解：(使用retrofit,註解是很重要的)

方法註解 : 包含@GET、@POST、@PUT、@DELETE、@PATCH、@HEAD、@OPTIONS、@HTTP。

這個不多講.一般用的就是@GET、@POST,很明顯,一個是get請求,一個是post請求
複製程式碼
標記註解 : 包含@FormUrlEncoded、@Multipart、@Streaming。
這個得和引數註解一起說
複製程式碼
引數註解 : 包含@Query,@QueryMap、@Body、@Field，@FieldMap、@Part，@PartMap。

@Get---------用的引數註解就@Query,@QueryMap,

@Post--------則會用到 @Body、@Field，@FieldMap、@Part，@PartMap。

@Body-------將資料轉化成Json,然後post.具體轉化根據設定的解析工廠(下面有講)
---------------------------------------------------分割線----------------------------------------------------------
@Field，@FieldMap------post上傳表單.@Field表示單個,@FieldMap表示集合.
需要新增上面的@FormUrlEncoded表示表單提交 ,
對應Content-Type:application/x-www-form-urlencoded
如:
@FormUrlEncoded
@POST("login的url")
Observable<User> login(@Field("name") String name, @FieldMap Map params);
--------------------------------------------------分割線------------------------------------------------------------
@Part，@PartMap----post上傳檔案/資料.@Part表示單個,@PartMap表示集合.
其中@Part MultipartBody.Part 型別代表檔案，@Part("key") RequestBody型別代表引數 
需要新增@Multipart表示支援檔案上傳的表單，Content-Type: multipart/form-data
@Multipart
@POST("update的url")
Observable<User> update(@Part ("file") MultipartBody.Part file, @Part("key") RequestBody key,@PartMap Map<String,RequestBody> files);
如果引數較少,使用@Part ("file")就可以解決了,如果引數較多,那就需要使用@PartMap了.
複製程式碼
其他註解 : @Path、@Header,@Headers、@Url
這幾個用處挺大的,這裡就不細說了,並不是必用的,我用的不多.
複製程式碼

Retrofit 配置程式碼.

//這個是處理網路請求的log資訊的,可以實現Interceptor介面來自定義.
 HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
            @Override
            public void log(String message) {
                HLog.i("RxJava", message);
            }
        });

OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(interceptor)
                .build();
Retrofit retrofit = new Retrofit.Builder()
                .client(client)//Retrofit需要配置一個OkHttpClient例項.
                .baseUrl(API_HOST)//需要指定一個baseUrl,一般就是伺服器的域名
                .addConverterFactory(FastjsonConverterFactory.create())//這個是資料解析工廠,我用的是fastjson
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())//支援rxJava,在第二個jar包裡面
                .build();
複製程式碼

下面是完整程式碼:

/**
* 寫成單例模式,因為並不需要多個Retrofit存在.
*/
public class RetrofitUtil {
    /**
     * 伺服器地址
     */
    private static final String API_HOST ="你的BaseUrl";
    private RetrofitUtil() {

    }
    public static Retrofit getRetrofit() {
        return Instanace.retrofit;
    }
    //靜態內部類,保證單例並在呼叫getRetrofit方法的時候才去建立.
    private static class Instanace {
        private static final Retrofit retrofit = getInstanace();
        private static Retrofit getInstanace() {
            HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger(){
                @Override
                public void log(String message) {
                    HLog.i("RxJava", message);
                }
            });
            OkHttpClient client = new OkHttpClient.Builder()
                    .addInterceptor(interceptor)
                    .build();
            Reretrofit = new Retrofit.Builder()
                    .client(client)
                    .baseUrl(API_HOST)
                    .addConverterFactory(FastjsonConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
            return retrofit;
        }
    }
}
複製程式碼

json解析工廠,程式碼太多,,具體可以見demo

3.RxAndroid

如果沒接觸的話,可以看前面的Rxjava連結.

(1).首先看Reretrofit+RxAndroid是怎麼使用的
@GET("login地址")
Observable<BaseResponse<LoginData>> login(@QueryMap HashMap<String, Object> params);
複製程式碼

其實所謂的Reretrofit+RxAndroid就是這麼回事.

沒有RxAndroid的Reretrofit請求介面是這樣寫的:

@GET("login地址")
Call<BaseResponse<LoginData>> login(@QueryMap HashMap<String, Object> params);
複製程式碼

把Call換成了Observable而已.

(2)寫一個介面類
/**
*所有的網路請求都可以寫在這個介面類裡面.
*/
public interface APIService {
     @GET("login地址")
     Observable<BaseResponse<LoginData>> login(@QueryMap HashMap<String, Object> params);
     ......
}

複製程式碼
(3)介面類的實現
/**
 * 請求生成類。Retrofit一次生成,並作為單例.
 */
public class ApiServcieImpl {
    private ApiServcieImpl() {

    }
    public static APIService getInstance() {
        return createAPIService.apiService;
    }

    /**
     * Retrofit生成介面物件.
     */
    private static class createAPIService {
        //Retrofit會根據傳入的介面類.生成例項物件.
        private static final APIService apiService = RetrofitUtil.getRetrofit().create(APIService.class);
    }
}
複製程式碼

然後就可以通過ApiServcieImpl.getInstance()去呼叫APIService裡面寫的介面了. 如:

ApiServcieImpl.getInstance().login(new HashMap<String, Object>()) //傳入引數
       .subscribe(new Action1<BaseResponse<LoginData>>() {//簡單的回撥
            @Override 
             public void call(BaseResponse<LoginData> loginDataBaseResponse) { 
                //拿到資料,做處理
            }
    });
複製程式碼

4.封裝

有沒有發現,設定泛型的是<BaseResponse>,包了一層BaseResponse 這麼做是為了請求完成後對返回的資料進行統一處理.

先看BaseResponse:

public class BaseResponse<T> {
    private boolean success;//請求是否成功
    private int resultCode;//狀態嗎
    private String msg;//返回的提示訊息
    private T data;//主要內容,因為不知道返回的會是什麼型別,所以用泛型來表示
    //get set方法就不貼了.
}
複製程式碼

怎麼處理.

 /**
 * @author jlanglang  2016/11/15 16:14
 */
public class ModelFilteredFactory {
    private final static Observable.Transformer transformer = new SimpleTransformer();

    /**
     * 將Observable<BaseResponse<T>>轉化Observable<T>,並處理BaseResponse
     *
     * @return 返回過濾後的Observable.
     */
    @SuppressWarnings("unchecked")
    public static <T> Observable<T> compose(Observable<BaseResponse<T>> observable) {
        return observable.compose(transformer);
    }

    /**
     * 這裡就不細講了,具體可以去看rxjava的使用.這個類的意義就是轉換Observable.
     */
    private static class SimpleTransformer<T> implements Observable.Transformer<BaseResponse<T>, T> {
        //這裡對Observable,進行一般的通用設定.不用每次用Observable都去設定執行緒以及重連設定
        @Override
        public Observable<T> call(Observable<BaseResponse<T>> observable) {
            return observable.subscribeOn(Schedulers.io())
                      .observeOn(AndroidSchedulers.mainThread())
                      .unsubscribeOn(Schedulers.io())
                      .timeout(5, TimeUnit.SECONDS)//重連間隔時間
                      .retry(5)//重連次數
                      .flatMap(new Func1<BaseResponse<T>, Observable<T>>() {
                          @Override
                          public Observable<T> call(BaseResponse<T> tBaseResponse) {
                              return flatResponse(tBaseResponse);
                          }
                      });
        }

        /**
         * 處理請求結果,BaseResponse
         * @param response 請求結果
         * @return 過濾處理, 返回只有data資料的Observable
         */
        private Observable<T> flatResponse(final BaseResponse<T> response) {
            return Observable.create(new Observable.OnSubscribe<T>() {
                @Override
                public void call(Subscriber<? super T> subscriber) {
                    if (response.isSuccess()) {//請求成功
                        if (!subscriber.isUnsubscribed()) {
                            subscriber.onNext(response.getData());
                        }
                    } else {//請求失敗
                        int resultCode = response.getResultCode();
                        if (!subscriber.isUnsubscribed()) {
                            //這裡丟擲自定義的一個異常.可以處理伺服器返回的錯誤.
                            subscriber.onError(new APIException(response.getResultCode(), response.getMsg()));
                        }
                        return;
                    }
                    if (!subscriber.isUnsubscribed()) {//請求完成
                        subscriber.onCompleted();
                    }
                }
            });
        }
    }
}
複製程式碼

僅僅只有上面那些了麼?接著看.

/**
 * @author jlanglang  2016/11/14 17:32
  * Subscriber,這個是用來處理Observable的結果的.
 */
public abstract class SimpleSubscriber<T> extends Subscriber<T> {
 
    @Override
    public void onCompleted() {//這個是請求完成時呼叫.如果走了onError()就不會走這個方法.
       
    }

    @Override
    public void onError(Throwable e) {//這裡通常就處理異常
        if (e instanceof APIException) {
            APIException exception = (APIException) e;
            ToastUtil.showToast( exception.message);
        } else if (e instanceof UnknownHostException) {
            ToastUtil.showToast("請開啟網路");
        } else if (e instanceof SocketTimeoutException) {
            ToastUtil.showToast( "請求超時");
        } else if (e instanceof ConnectException) {
            ToastUtil.showToast("連線失敗");
        } else if (e instanceof HttpException) {
            ToastUtil.showToast("請求超時");
        }else {
            ToastUtil.showToast("請求失敗");
        }
        e.printStackTrace();
    }

    @Override
    public void onNext(T t) {//這裡的是獲得了資料,方法意思很明顯,下一步幹啥
        if (t != null) {//這裡最好判斷一下是否為null.
            call(t);
        } else {
            ToastUtil.showToast("連線失敗");
        }
    }
    /**
    *因為具體的處理這裡無法得知,所以抽象.
    */
    public abstract void call(T t);
}
複製程式碼

好了,看看現在的具體使用吧:

ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(new HashMap<String, Object>()))
                .subscribe(new SimpleSubscriber<LoginData>() {
                    @Override
                    public void call(LoginData loginData) {
                  
                    }
                });
 看起來之前用起來差不多,但是卻做了很多的處理:
1.對Observable做了通用設定.網路重連次數,執行緒設定,重連時間.
2.做了對伺服器返回結果的統一處理.比如根據resultcode,處理登陸過期啊啥的.
3.判斷了data是否為null,不會在call()裡面擔心loginData是否為null
4.統一處理了請求的各種異常.
複製程式碼

5.用到MVP中.

你以為上面那些就完了嗎?NO!
如果我們在Presenter中這樣呼叫其實是很不科學的.
ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(new HashMap<String, Object>()))
複製程式碼
這個轉換我們應該放在Modle和ModleImpl中去寫
public class LoginContract{
     ....//view介面省略
    public interface Model {  
      /**   
      * 獲取登陸資料  
      * @return Observable<LoginData> 
      */  
      Observable<LoginData> login(HashMap<String, Object> treeMap);
    }
    ....//prensent介面省略
}

public class LoginModelImpl implements LoginContract.Model { 
   @Override 
   public Observable<LoginData> login(HashMap<String, Object> hashMap) {     
       return ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(hashMap));   
 }}
複製程式碼
那麼我們在presenter中呼叫就可以這樣:
public class LoginPresenterImpl exdents BasePresenter implements LoginContract.Presenter{
     .....
     private  LoginModelImpl  loginModelImpl;
     public void onCreate(){
       loginModelImpl = new LoginModelImpl();//建立modle例項
     }
     public void login(){
        //通過modle請求介面
        loginModelImpl.login(new HashMap<String, Object>()))
                .subscribe(new SimpleSubscriber<LoginData>() {
                    @Override
                    public void call(LoginData loginData) {
                          //處理請求的資料,繫結檢視 
                    }
                });
        }
    ....
}  
複製程式碼

6.管理Observable的生命週期,也就是網路請求的生命週期.

Observable是不是很高大上,然而如果你不進行處理,可是會記憶體洩漏的 RxAndroid也不會自動的根據Activity/frgament的生命週期結束非同步請求. 但處理其實很簡單.

使用CompositeSubscription

只需要將Observable,非同步處理到最後返回的subscribe新增到CompositeSubscription例項裡就行了.

  public void login(){
    Subscription subscribe = loginModelImpl.login(new HashMap<String, Object>()))
                .subscribe(new SimpleSubscriber<LoginData>() {
                    @Override
                    public void call(LoginData loginData) {
                          //處理請求的資料,繫結檢視 
                    }
                });
      compositeSubscription.add(subscribe);//新增訂閱
  }
  //在銷燬的時候,結束訂閱事件.
  public void onDestroy() {
    compositeSubscription.unsubscribe();//結束所有add的subscribe事件
 } 
複製程式碼

那麼,實戰心得(二)中的BasePresenter就可以進行改進了,具體見:

傳送門:實戰心得(二)

/**
 * @author jlanglang  2016/11/11 15:10
 */
public abstract class BasePresenter<T extends BaseView> {
   protected T mView;
   protected CompositeSubscription compositeSubscription;
    /**
     * 繫結View
     */
    public void onAttch(T view) {
        this.mView = view;
        compositeSubscription = new CompositeSubscription ();
    }
    /**
     * 做初始化的操作,需要在V的檢視初始化完成之後才能呼叫
     * presenter進行初始化.
     */
    public abstract void onCreate();
    /** 
    * 在這裡結束非同步操作
    */
    public void onDestroy(){
        compositeSubscription.unsubscribe();//結束非同步請求.
    }
    /**
     * 在V銷燬的時候呼叫,解除繫結
    */
    public void onDetach() {  
       mView = null;
    }
    /**
    * 容易被回收掉時儲存資料
    */
    public abstract void onSaveInstanceState(Bundle outState);
}
複製程式碼

7 RxBus

沒什麼特別值得提的,用法自行搜尋,哈哈,個人在專案中用的也不是很多,某些情況會用一下,但真心好用.

再附上githubdemo地址,時不時更新.

mvpDemo

您的喜歡與回覆是我最大的動力－＿－

相關文章