MVP+Retrofit+Rxjava在專案中實戰解析

codeGoogle發表於2017-07-19

文章目標

MVP在android中的原理解析 MVP+Retrofit+Rxjava在專案中實戰解析 架構經驗分享

MVP簡單介紹

先說說MVC分層:
  • View:對應於佈局檔案
  • Model:業務邏輯和實體模型
  • Controllor:對應於Activity 看起來的確像那麼回事,但是細細的想想這個View對應於佈局檔案,其實能做的事情特別少,實際上關於該佈局檔案中的資料繫結的操作,事件處理的程式碼都在Activity中,造成了Activity既像View又像Controller(當然了Data-Binder的出現,可能會讓View更像View吧)。
  • 當將架構改為MVP以後,Presenter的出現,將Actvity視為View層,Presenter負責完成View層與Model層的互動。現在是這樣的:
    • View 對應於Activity,負責View的繪製以及與使用者互動 Model 依然是業務邏輯和實體模型 Presenter 負責完成View於Model間的互動

MVP模式的核心思想

MVP是模型(Model)、檢視(View)、主持人(Presenter)的縮寫,分別代表專案中3個不同的模組。

  • 模型(Model):負責處理資料的載入或者儲存,比如從網路或本地[資料庫]
    (lib.csdn.net/base/mysql)…

  • 檢視(View):負責介面資料的展示,與使用者進行互動;

  • 主持人(Presenter):相當於協調者,是模型與檢視之間的橋樑,將模型與檢視分離開來。

  如下圖所示,

  • View與Model並不直接互動,而是使用Presenter作為View與Model之間的橋樑。
  • 其中Presenter中同時持有Viwe層以及Model層的Interface的引用,
  • View層持有Presenter層Interface的引用。當View層某個介面需要展示某些資料的時候,首先會呼叫Presenter層的某個介面,然後Presenter層會呼叫Model層請求資料
  • 當Model層資料載入成功之後會呼叫Presenter層的回撥方法通知Presenter層資料載入完畢
  • 最後Presenter層再呼叫View層的介面將載入後的資料展示給使用者。
  • 這就是MVP模式的整個核心過程。

    mvp0
    mvp0

    這樣分層的好處就是大大減少了Model與View層之間的耦合度。一方面可以使得View層和Model層單獨開發與測試,互不依賴。另一方面Model層可以封裝複用,可以極大的減少程式碼量。當然,MVP還有其他的一些優點,這裡不再贅述

    MVP在真實專案中的實戰

    上面已經介紹過MVP的核心思想以及基本架構,當然我們在實際專案中不僅僅要把建構劃分出來,還要加以延伸,這樣才能夠使專案的整體架構具備可擴充套件行、可複用性、可維護性、靈活性。下面我用我在實際專案中的角度來解析我所理解的MVP。

    總體架構圖:

    Paste_Image.png
    Paste_Image.png

    ####專案目錄結構:
    mvp2
    mvp2

    1、View層
    a、Iview介面程式碼如下:

    /**
    * @Description MVP之V層 是所有VIEW的基類,其他類可以繼承該類
    * @Author ydc
    * @CreateDate 2016/10/10
    * @Version 1.0
    */
    public interface Iview<T> {
    
      /**
       * @description 全域性的顯示載入框
       * @author ydc
       * @createDate
       * @version 1.0
       */
      void showLoading();
    
      /**
       * @description 全域性的顯示載入框
       * @author ydc
       * @createDate
       * @version 1.0
       */
    
      ...
      /**
       * @description 當前fragment是否有效
       * @author ydc
       * @createDate
       * @version 1.0
       */
      boolean isActive();
      }複製程式碼

    可以看出Iview 介面是所以activity 和fragment最基本且共有的方法定義。

b、NewsView介面程式碼如下:


/**ydc 新聞列表所特有的方法定義
 * Created by Administrator on 2017/7/6.
 */

public interface NewsView extends Iview {
    void addNews(List<NewsBean> newsList);
    void showLoadFailMsg(String msg);
}複製程式碼

NewsView介面繼承自Iview介面,定義新聞列表特有的方法。

c、封裝BaseActivity基類

BaseActivity作為所以activity的基類,你可以把所以activity共有的方法和屬性提取到該中。複製程式碼

d、activity_main.xml佈局檔案程式碼如下:

佈局裡面僅僅放了一個RecyclerView,用來展示資料列表。

e、NewListActivity程式碼如下:


public class NewListActivity extends BaseActivity implements NewsView {

    private RecyclerView mRecyclerView;
    private LinearLayoutManager mLayoutManager;
    private NewsAdapter mAdapter;
    private List<NewsBean> mData;
    private int pageIndex = 0;


    private NewsPresenter mPresenter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mPresenter = new NewsPresenter();
        mPresenter.attachView(this);
        mPresenter.subscribe();
........
        mRecyclerView.setItemAnimator(new DefaultItemAnimator());
        mAdapter = new NewsAdapter(getApplicationContext());
        mRecyclerView.setAdapter(mAdapter);



    }
........
    @Override
    public void addNews(List<NewsBean> newsList) {
        mAdapter.isShowFooter(true);
        if(mData == null) {
            mData = new ArrayList<NewsBean>();
        }
        mData.addAll(newsList);
        if(pageIndex == 0) {
            mAdapter.setmDate(mData);
        } else {
            //如果沒有更多資料了,則隱藏footer佈局
            if(newsList == null || newsList.size() == 0) {
                mAdapter.isShowFooter(false);
            }
            mAdapter.notifyDataSetChanged();
        }
    }

    @Override
    public void showLoadFailMsg(String msg) {

    }
}複製程式碼

在NewListActivity 中我們可以看到,NewListActivity 顯示實現了NewsView 介面,實現了NewsView和Iview 未實現的方法,在程式碼中可以看出NewListActivity並沒有做一些邏輯處理工作,僅僅做了新增資料和展示資料以及一些提示訊息等工作,資料處理的工作都是呼叫 NewsPresenter 完成的。

2、Presenter層

a、Ipresenter 程式碼如下:

/**
 * @Description MVP的P層
 * @Author ydc
 * @CreateDate 2016/10/10
 * @Version 1.0
 */
public interface Ipresenter<T extends Iview> {

    /**
     * @description 關聯P與V(繫結,VIEW銷燬適合解綁)
     * @author ydc
     * @createDate
     * @version 1.0
     */
    void attachView(T view);

    /**
     * @description 取消關聯P與V(防止記憶體洩漏)
     * @author ydc
     * @createDate
     * @version 1.0
     */
    void detachView();

    /**
     * @description RX訂閱
     * @author ydc
     * @createDate
     * @version 1.0
     */
    void subscribe();

    /**
     * @description RX取消訂閱
     * @author ydc
     * @createDate
     * @version 1.0
     */
    void unsubscribe();複製程式碼

Ipresenter定義了所有presenter最基本且共有的方法。

b、BasePresenter程式碼如下:

/**
 * @Description 抽象的公用Presenter
 * @Author ydc
 * @CreateDate 20170707
 * @Version 1.0
 */
public abstract class BasePresenter<T extends Iview> implements Ipresenter<T> {
    protected T mMvpView;//所有View
    protected SubscriptionList mSubscriptions;//rx註冊中心
    protected DataRepository mDataCenter;//資料中心
    //protected abstract SubscriptionList createSubscriptionList();//引入darger後取締
  ......
    /**
     * @description p&v沒有繫結的異常
     * @author ydc
     * @createDate
     * @version 1.0
     */
    public static class MvpViewNotAttachedException extends RuntimeException {
        public MvpViewNotAttachedException() {
            super("Please call Presenter.attachView(MvpView) before requesting data to the Presenter");
        }
    }

    /**
     * @description 統一新增訂閱關聯被觀察者和觀察者
     * @author ydc
     * @createDate
     * @version 1.0
     */
    public void addSubscription(Observable observable, Subscriber subscriber) {
        if( observable!=null && subscriber!=null ){
            if (mSubscriptions == null) {
                mSubscriptions = new SubscriptionList();
            }
            mSubscriptions.clear();
            mSubscriptions.add(observable
                    .subscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .subscribe(subscriber));
        }
    }

}複製程式碼

BasePresenter是一個abstract類,在實現Ipresenter的未實現的方法之外,又擴充套件了幾個所以presenter共用的方法。

c、Presenter程式碼如下:


/**ydc 新聞類的協議也可以是介面
 * Created by Administrator on 2017/7/6.
 */
abstract class Presenter extends BasePresenter<NewsView> {
    public abstract void loadNews(int type, int page);
}複製程式碼

可以看出Presenter也是一個abstract類、繼承自BasePresenter抽象類,同時定義了新聞列表所特有的方法。

d、NewsPresenter程式碼如下:

/**
 * Created by Administrator on 2017/7/6.
 */

public class NewsPresenter extends Presenter {

    private Model mModel;
    public  NewsPresenter(){
        mModel=new NewsModel();
    }

    @Override
    public void loadNews(int type, int page) {
        addSubscription(mModel.loadNews("nc/article/headline/T1348647909107/0-20.html",0), new ApiCallBack<NewsRequestModel>() {

            @Override
            public void onStart() {
                getMvpView().showLoading();
            }

            @Override
            public void onSuccess(NewsRequestModel modelBean) {
                if(modelBean!=null){
                    getMvpView().addNews(modelBean.getT1348647909107());
                }

            }

            @Override
            public void onFailure(String errorMsg) {
               getMvpView().showLoadFailMsg(errorMsg);
            }

            @Override
            public void onFinished() {
                getMvpView().hideLoading();
            }
        });
    }

    @Override
    public void subscribe() {

    }
}複製程式碼

可以看出NewsPresenter持有view和model的介面或是抽象類,起到中轉的作用。

3、Model層

a、Imodel介面程式碼如下:

**
 * @Description MVP的M層
 * @Author ydc
 * @CreateDate 2016/10/10
 * @Version 1.0
 */
public interface Imodel {
}複製程式碼

我這裡其實並沒有做什麼,只是留了一個介面而已,你可以定義所以model的基本方法。

b、BaseModel程式碼如下:

/**
 * @Description 資料模型基礎類
 * @Author ydc
 * @CreateDate 2016/11/2
 * @Version 1.0
 */
public abstract class BaseModel implements Imodel {

    /**
     * @description 返回服務介面物件例項
     * @author ydc
     * @createDate
     * @version 1.0
     */
    public <T> T createService(final Class<T> clazz) {
        validateServiceInterface(clazz);
        return (T) RxService.RETROFIT.createRetrofit().create(clazz);
    }

    /**
     * @description 校驗介面合法性
     * @author ydc
     * @createDate
     * @version 1.0
     */
    public <T> void validateServiceInterface(Class<T> service) {
        if (service == null) {
            //AppToast.ShowToast("服務介面不能為空!");
        }
        if (!service.isInterface()) {
            throw new IllegalArgumentException("API declarations must be interfaces.");
        }
        if (service.getInterfaces().length > 0) {
            throw new IllegalArgumentException("API interfaces must not extend other interfaces.");
        }
    }

}複製程式碼

這個類我是用它來做Retrofit的初始化以及網路請求的工作,當然我要進一步包裝Retrofit,所以這裡只看到一個方法呼叫。

c、Model程式碼如下:

/**ydc 獲取資料的邏輯模組協議,也可以是介面,提供給P呼叫,在callback中更新V
 * Created by Administrator on 2017/7/6.
 */

public  abstract class Model extends BaseModel {
   public abstract Observable<NewsRequestModel> loadNews(String url, int type);
}複製程式碼

既然公共BaseModel的職責任命為整個網路呼叫的工作,那麼我就要在抽象一個Model抽象類來定義新聞資料處理邏輯模組協議,提供給P呼叫。

d、NewsModel程式碼如下:

/**ydc 新聞資料處理協議
 * Created by Administrator on 2017/7/6.
 */

public class NewsModel extends Model {
    private INewService service=createService(INewService.class);

    @Override
    public Observable<NewsRequestModel> loadNews(String url, int type) {
        Map<String, String> map = new HashMap<>();
        //map.put("type", type+"");
        return service.getNewList(url,map);
    }
}複製程式碼

這個類實現了Model作為具體的新聞列表資料處理層。

MVP總結:

  • 當使用者進入到NewListActivity介面之後,介面需要展示新聞列表資訊給使用者。
  • 首先NewListActivity會呼叫NewsPresenter的loadNews方法,NewsPresenter 的loadNews方法中又會呼叫NewsModel中的loadNews方法。
  • NewsModel中的loadNews方法中就是載入資料的核心,通過Retrofit請求伺服器介面獲取資料,無論資料獲取成功與否,都會通過ApiCallBack回撥給NewsPresenter 。
  • 如果獲取成功,NewsPresenter 會呼叫NewsView的addNews方法將獲取的新聞列表資訊展示到RecyclerView。
  • 如果獲取失敗,則呼叫NewsView的showLoadFialMsg方法向使用者提示失敗資訊。

RxJava 與 Retrofit 的結合簡單介紹

  • Retrofit 是 Square 的一個著名的網路請求庫,是okHTTP的升級版,目前公認的最好的網路請求框架。

  • 響應式程式設計RxJava就更不用說,它的強大之處只有用過的人才會體會得到。

  • Retrofit 除了提供了傳統的 Callback 形式的 API,還有 RxJava 版本的 Observable 形式 API。下面我用對比的方式來介紹 Retrofit 的 RxJava 版 API 和傳統版本的區別。

  • 以獲取一個 User 物件的介面作為例子。使用Retrofit 的傳統 API,你可以用這樣的方式來定義請求:

    @GET("/user")
    public void getUser(@Query("userId") String userId, Callback<User> callback);複製程式碼

    在程式的構建過程中, Retrofit 會把自動把方法實現並生成程式碼,然後開發者就可以利用下面的方法來獲取特定使用者並處理響應:

    getUser(userId, new Callback<User>() {
      @Override
      public void success(User user) {
          userView.setUser(user);
      }
    
      @Override
      public void failure(RetrofitError error) {
          // Error handling
          ...
      }
    };複製程式碼

    其實 Retrofit傳統的API呼叫與okHTTP功能和使用上沒有什麼本質的區別,它的強大之處在於與RxJava結合使用。

而使用 RxJava 形式的 API,定義同樣的請求是這樣的:

@GET("/user")
public Observable<User> getUser(@Query("userId") String userId);複製程式碼

使用的時候是這樣的:

getUser(userId)
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(new Observer<User>() {
        @Override
        public void onNext(User user) {
            userView.setUser(user);
        }

        @Override
        public void onCompleted() {
        }

        @Override
        public void onError(Throwable error) {
            // Error handling
            ...
        }
    });複製程式碼

看到區別了嗎?

當 RxJava 形式的時候,Retrofit 把請求封裝進 Observable ,在請求結束後呼叫 onNext() 或在請求失敗後呼叫 onError()。

對比來看, Callback 形式和 Observable 形式長得不太一樣,但本質都差不多,而且在細節上 Observable 形式似乎還比 Callback 形式要差點。那 Retrofit 為什麼還要提供 RxJava 的支援呢?

單個請求體現不出它的優勢所在,但是情景複雜起來, Callback 形式馬上就會開始讓人頭疼。

假設 /user 介面並不能直接訪問,而需要填入一個線上獲取的 token ,程式碼應該怎麼寫?

Callback 方式,可以使用巢狀的 Callback:

GET("/token")
public void getToken(Callback<String> callback);

@GET("/user")
public void getUser(@Query("token") String token, @Query("userId") String userId, Callback<User> callback);

...

getToken(new Callback<String>() {
    @Override
    public void success(String token) {
        getUser(token, userId, new Callback<User>() {
            @Override
            public void success(User user) {
                userView.setUser(user);
            }

            @Override
            public void failure(RetrofitError error) {
                // Error handling
                ...
            }
        };
    }

    @Override
    public void failure(RetrofitError error) {
        // Error handling
        ...
    }
});複製程式碼

倒是沒有什麼效能問題,可是迷之縮排而且充滿了無窮無盡的回撥,這種後果你懂我也懂,做過大專案的人應該更懂。

而使用 RxJava 的話,程式碼是這樣的:

@GET("/token")
public Observable<String> getToken();

@GET("/user")
public Observable<User> getUser(@Query("token") String token, @Query("userId") String userId);

...

getToken()
    .flatMap(new Func1<String, Observable<User>>() {
        @Override
        public Observable<User> onNext(String token) {
            return getUser(token, userId);
        })
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(new Observer<User>() {
        @Override
        public void onNext(User user) {
            userView.setUser(user);
        }

        @Override
        public void onCompleted() {
        }

        @Override
        public void onError(Throwable error) {
            // Error handling
            ...
        }
    });複製程式碼

用一個 flatMap() 就搞定了邏輯,整個請求都在一條鏈當中。讀者看到這裡應該明白我為什麼選擇RxJava 與 Retrofit 的結合來處理網路請求。其實RxJava有兩個比較核心的功能就是資料轉換和執行緒排程,當然它還有其它的強大之處,只是我們用的最多的是這兩個而已。

RxJava 與 Retrofit 的結合在本專案中的應用

1、建立RxService類代:

RxService類主要用來初始化Retrofit以及新增頭部和系統引數,NewsModel初始化時,順帶完成了以上工作。

2、INewService介面程式碼如下:

/**網路介面
 * Created by Administrator on 2017/7/6.
 */

public interface INewService {

    @GET
    Observable<NewsRequestModel> getNewList(@Url String url,
                                            @QueryMap Map<String, String> params);
}複製程式碼

這個類是來定義新聞列表網路介面

3、管理被觀察者和觀察者

統一新增訂閱關聯被觀察者和觀察者

 protected SubscriptionList mSubscriptions;//rx註冊中心


    /**
     * @description 統一新增訂閱關聯被觀察者和觀察者
     * @author ydc
     * @createDate
     * @version 1.0
     */
    public void addSubscription(Observable observable, Subscriber subscriber) {
        if( observable!=null && subscriber!=null ){
            if (mSubscriptions == null) {
                mSubscriptions = new SubscriptionList();
            }
            mSubscriptions.clear();
            mSubscriptions.add(observable
                    .subscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .subscribe(subscriber));
        }
    }複製程式碼

RX取消訂閱程式碼如下:

@Override
    public void unsubscribe(){
        if(mSubscriptions!=null){
            mSubscriptions.clear();
        }
    }複製程式碼

以上兩段程式碼是在BasePresenter抽象類中。

4、把請求新增到rx註冊中心SubscriptionLis中

Paste_Image.png
Paste_Image.png

5、NewsPresenter類
ApiCallBack是一個抽象類,處理網路資料處理完成後的回撥響應(即RxJava的觀察者),把它和被觀察者作為引數一起傳入到addSubscription方法中:

Paste_Image.png
Paste_Image.png

6、NewsRequestModel程式碼如下

public class NewsRequestModel extends BaseFeed {
    public List<NewsBean> getT1348647909107() {
        return T1348647909107;
    }

    public void setT1348647909107(List<NewsBean> t1348647909107) {
        T1348647909107 = t1348647909107;
    }

    private List<NewsBean> T1348647909107;
}複製程式碼

該類繼承自BaseFeed,作為新聞列表介面返回實體對映,這個需要和後臺api介面開發人員協商好再定義。

作為所以介面返回實體對映基類,這個也需要和後臺api開發人員協商好,至少我是這麼做的。複製程式碼

####RxJava 與 Retrofit 的結合小結

  • 使用NewListActivity中onResume()方法呼叫 NewsPresenter中的loadNews(0,0),
  • 接著NewsPresenter再呼叫NewsModel()中的loadNews方法發起網路請求,同時把請求中的被觀察者和觀察者新增到Rx註冊中心,註冊中心統一管理所有網路請求。
  • 接下來NewsModel()初始化Retrofit以及各種基本引數新增,同時呼叫INewService網路協議真正發起網路請求。
  • 接下來網路請求被我們的ApiCallBack觀察者所接收,然後網路資料又被觀察者回撥到NewsPresenter類中的觀察者回撥函式onSuccess中
  • 再把所獲得的網路資料使用getMvpView().addNews(modelBean.getT1348647909107())回發到NewListActivity中的addNews(List newsList)方法中,然後顯示到UI列表中
  • 最後退出時在onDestroy()中把Rx註冊中心的當前請求清除。
    效果圖:
    mvp11
    mvp11

Demo現在地址:

[download.csdn.net/download/xi…]

專案地址:

blog.csdn.net/xinanheisha…

如果你覺得此文對您有所幫助,歡迎入群 QQ交流群 :232203809
微信公眾號:終端研發部

技術+職場
技術+職場

相關文章