RxJava2 實戰知識梳理(15) 實現一個簡單的 MVP + RxJava + Retrofit 應用

澤毛發表於2017-12-21

一、前言

不知不覺,從八月二十七號的第一篇教程 RxJava2 實戰知識梳理(1) - 後臺執行耗時操作,實時通知 UI 更新 到今天剛好兩個星期,這一系列教程的目的主要是希望通過一些實際的案例,讓大家對於RxJava中的一些操作符能有比較直觀的認識。

今天這篇文章,是昨天晚上花了幾個小時,對專案中用到的MVP + RxJava + Retrofit的整個架構做了一個簡化,抽離出其中最核心的部分編寫的讀取 Gank 中拉取新聞資訊的例子。

該例子的原始碼可以通過 RxSample 的第十五章獲取,下面我們先介紹一個整個例子的框架:

RxJava2 實戰知識梳理(15)   實現一個簡單的 MVP + RxJava + Retrofit 應用

二、Model

Model對應上圖中的NewsRepository,它負責為Presenter層提供資料,因為資料有可能來自快取或者網路,因此在NewsRepository中包含了兩個資料來源,也就是LocalNewsSourceRemoteNewsSource

public class NewsRepository {

    private LocalNewsSource mLocalNewsSource;
    private RemoteNewsSource mRemoteNewsSource;

    private NewsRepository() {
        mLocalNewsSource = new LocalNewsSource();
        mRemoteNewsSource = new RemoteNewsSource();
    }

    public static NewsRepository getInstance() {
        return Holder.INSTANCE;
    }

    private static class Holder {
        private static NewsRepository INSTANCE = new NewsRepository();
    }

    public Observable<NewsEntity> getNetNews(String category) {
        return mRemoteNewsSource.getNews(category).doOnNext(new Consumer<NewsEntity>() {
            @Override
            public void accept(NewsEntity newsEntity) throws Exception {
                mLocalNewsSource.saveNews(newsEntity);
            }
        });
    }

    public Observable<NewsEntity> getCacheNews(String category) {
        return mLocalNewsSource.getNews(category);
    }

}
複製程式碼

2.1 LocalNewsSource

LocalNewsSource通過資料庫的方式實現了資訊的快取,該資料庫的表包含兩個欄位,即資訊的分類,和資訊的具體資料。

public class LocalNewsSource {

    private static final String[] QUERY_PROJECTION = new String[] { NewsContract.NewsTable.COLUMN_NAME_DATA };
    private static final String QUERY_SELECTION = NewsContract.NewsTable.COLUMN_NAME_CATEGORY + "= ?";

    private NewsDBHelper mNewsDBHelper;
    private SQLiteDatabase mSQLiteDatabase;

    public LocalNewsSource() {
        mNewsDBHelper = new NewsDBHelper(Utils.getAppContext());
        mSQLiteDatabase = mNewsDBHelper.getWritableDatabase();
    }

    public Observable<NewsEntity> getNews(String category) {
        return Observable.just(category).flatMap(new Function<String, ObservableSource<NewsEntity>>() {
            @Override
            public ObservableSource<NewsEntity> apply(String category) throws Exception {
                NewsEntity newsEntity = new NewsEntity();
                Cursor cursor = mSQLiteDatabase.query(NewsContract.NewsTable.TABLE_NAME, QUERY_PROJECTION, QUERY_SELECTION, new String[] { category }, null, null, null);
                if (cursor != null && cursor.moveToNext()) {
                    String data = cursor.getString(cursor.getColumnIndex(NewsContract.NewsTable.COLUMN_NAME_DATA));
                    newsEntity = JSON.parseObject(data, NewsEntity.class);
                }
                if (cursor != null) {
                    cursor.close();
                }
                return Observable.just(newsEntity);
            }
        });
    }


    public void saveNews(NewsEntity newsEntity) {
        Observable.just(newsEntity).observeOn(Schedulers.io()).subscribe(new Consumer<NewsEntity>() {

            @Override
            public void accept(NewsEntity newsEntity) throws Exception {
                if (newsEntity.getResults() != null && newsEntity.getResults().size() > 0) {
                    String cache = JSON.toJSONString(newsEntity);
                    ContentValues values = new ContentValues();
                    values.put(NewsContract.NewsTable.COLUMN_NAME_CATEGORY, "Android");
                    values.put(NewsContract.NewsTable.COLUMN_NAME_DATA, cache);
                    mSQLiteDatabase.insert(NewsContract.NewsTable.TABLE_NAME, null, values);
                }
            }
        });
    }
}
複製程式碼

2.2 RemoteNewsSource

RemoteNewsSource則負責從網路上拉取資訊資訊,這裡用到了Retrofit來實現,有需要了解的同學可以參考前面的這篇文章 RxJava2 實戰知識梳理(4) - 結合 Retrofit 請求新聞資訊

public class RemoteNewsSource {

    private NewsApi mNewsApi;

    public RemoteNewsSource() {
        mNewsApi = new Retrofit.Builder()
                .baseUrl("http://gank.io")
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build().create(NewsApi.class);
    }

    public Observable<NewsEntity> getNews(String category) {
        return mNewsApi.getNews(category, 10, 1);
    }

}
複製程式碼

三、View 和 Presenter

3.1 View 和 Presenter 的介面定義

首先,我們需要對於ViewPresenter之間的互動定義介面,這些介面我們寫在NewsMvpContract中:

public class NewsMvpContract {

    public static final int REFRESH_AUTO = 0;
    public static final int REFRESH_CACHE = 1;

    @IntDef ({REFRESH_AUTO, REFRESH_CACHE})
    public @interface RefreshType {}

    public interface View {
        void onRefreshFinished(@RefreshType int refreshType, List<NewsBean> newsEntity);
        void showTips(String message);
    }

    public interface Presenter {
        void refresh(@RefreshType int refreshType);
        void destroy();
    }

}
複製程式碼

View層定義了兩個介面,它們的含義分別為:

  • onRefreshFinished:重新整理資訊列表。
  • showTips:在發生錯誤時給予使用者提示。

Presenter層則負責在View層發起請求之後,呼叫Model層獲取資料,然後回撥View層的介面進行介面的更新,因此它提供了兩個介面:

  • refresh:用於View層發起重新整理操作。
  • destroy:在View層銷燬時,取消訂閱。

3.2 View 層實現

這裡,我們實現Activity作為View層的實現,它在有新的資訊列表回來時,通知RecyclerView進行重新整理,而需要提示時則通過SnackBar進行提示,同時它還持有一個NewsPresenter的例項,並在銷燬時呼叫它的destroy方法取消訂閱。

public class NewsMvpActivity extends AppCompatActivity implements NewsMvpContract.View {

    private CoordinatorLayout mRootLayout;
    private RecyclerView mRecyclerView;
    private NewsMvpAdapter mRecyclerAdapter;
    private List<NewsBean> mNewsBeans = new ArrayList<>();
    private NewsMvpContract.Presenter mPresenter;
    private LinearLayoutManager mLayoutMgr;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_news_mvp);
        initView();
        dispatchRefresh(NewsMvpContract.REFRESH_CACHE);
    }

    private void initView() {
        mRootLayout = (CoordinatorLayout) findViewById(R.id.cl_root);
        mRecyclerView = (RecyclerView) findViewById(R.id.rv_news);
        mRecyclerAdapter = new NewsMvpAdapter();
        mRecyclerAdapter.setNewsResult(mNewsBeans);
        mLayoutMgr = new LinearLayoutManager(this);
        mRecyclerView.addItemDecoration(new DividerItemDecoration(this, DividerItemDecoration.VERTICAL));
        mRecyclerView.setLayoutManager(mLayoutMgr);
        mRecyclerView.setAdapter(mRecyclerAdapter);
        mPresenter = new NewsPresenter(this);
    }

    @Override
    protected void onResume() {
        super.onResume();
        dispatchRefresh(NewsMvpContract.REFRESH_AUTO);
    }

    private void dispatchRefresh(@NewsMvpContract.RefreshType int refreshType) {
        mPresenter.refresh(refreshType);
    }

    @Override
    public void onRefreshFinished(@NewsMvpContract.RefreshType int refreshType, List<NewsBean> newsBeans) {
        mNewsBeans.clear();
        mNewsBeans.addAll(newsBeans);
        mRecyclerAdapter.notifyDataSetChanged();
    }

    @Override
    public void showTips(String message) {
        Snackbar.make(mRootLayout, message, Snackbar.LENGTH_SHORT).show();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mPresenter.destroy();
    }
}
複製程式碼

3.3 Presenter 層實現

Presenter層是比較複雜的地方,當View層呼叫refresh介面時,它需要根據重新整理的型別,請求Model層不同的介面進行處理,並且在資料返回時,將其和當前的資料進行合併,再通知View層進行重新整理。

public class NewsPresenter implements NewsMvpContract.Presenter {

    private static final long AUTO_REFRESH_TIME = 1000 * 60 * 10;
    private CompositeDisposable mCompositeDisposable;
    private NewsMvpContract.View mView;
    private List<NewsBean> mNewsBeans;
    private long mLastNetUpdateTime;

    public NewsPresenter(NewsMvpContract.View view) {
        mView = view;
        mCompositeDisposable = new CompositeDisposable();
        mNewsBeans = new ArrayList<>();
    }

    @Override
    public void refresh(@RefreshType int refreshType) {
        if (refreshType == NewsMvpContract.REFRESH_CACHE) {
            NewsRepository.getInstance()
                    .getCacheNews("Android")
                    .subscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .subscribe(new RefreshObserver(refreshType));
        } else {
            if (System.currentTimeMillis() - mLastNetUpdateTime > AUTO_REFRESH_TIME) { //自動重新整理的間隔時間為十分鐘。
                NewsRepository.getInstance()
                        .getNetNews("Android")
                        .subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread())
                        .subscribe(new RefreshObserver(refreshType));
            }
        }
    }

    @Override
    public void destroy() {
        mCompositeDisposable.clear();
        mView = null;
    }

    private void updateNewsBeans(@NewsMvpContract.RefreshType int refreshType, NewsEntity newsEntity) {
        List<NewsBean> filter = new ArrayList<>();
        for (NewsResultEntity resultEntity : newsEntity.getResults()) { //對資訊進行去重,需要重寫NewsBean的對應方法。
            NewsBean newsBean = entityToBean(resultEntity);
            if (!mNewsBeans.contains(newsBean)) {
                filter.add(newsBean);
            }
        }
        if (refreshType == NewsMvpContract.REFRESH_CACHE && mNewsBeans.size() == 0) { //只有當前沒有資料時,才使用快取。
            mNewsBeans = filter;
        } else if (refreshType == NewsMvpContract.REFRESH_AUTO) { //自動重新整理的資料放在頭部。
            mNewsBeans.addAll(0, filter);
            mLastNetUpdateTime = System.currentTimeMillis();
        }
    }

    private NewsBean entityToBean(NewsResultEntity resultEntity) {
        String title = resultEntity.getDesc();
        NewsBean bean = new NewsBean();
        bean.setTitle(title);
        return bean;
    }

    private class RefreshObserver extends DisposableObserver<NewsEntity> {

        private @NewsMvpContract.RefreshType int mRefreshType;

        RefreshObserver(@NewsMvpContract.RefreshType int refreshType) {
            mRefreshType = refreshType;
        }

        @Override
        public void onNext(NewsEntity newsEntity) {
            updateNewsBeans(mRefreshType, newsEntity);
            mView.onRefreshFinished(mRefreshType, mNewsBeans);
        }

        @Override
        public void onError(Throwable throwable) {
            mView.showTips("重新整理錯誤");
        }

        @Override
        public void onComplete() {}
    }
}
複製程式碼

這裡我們之所以要定義一個重新整理型別的目的在於,在實際專案中,我們有以下幾種重新整理方式:

  • 讀取快取:只在列表為空時才新增。
  • 自動重新整理:需要根據時間判斷,每隔10分鐘進入一次介面後自動獲取。
  • 下拉重新整理:將資料新增在頭部。
  • 上拉重新整理:將資料新增在尾部。

這裡為了演示方便我們只實現了前兩種方式,大家以後在處理時,也可以借鑑相應的方式。

四、示例

下面,我們演示一下,先在聯網狀態下拉取資訊,再在斷網情況下重新進入,讀取快取的情況:

RxJava2 實戰知識梳理(15)   實現一個簡單的 MVP + RxJava + Retrofit 應用
這篇文章原理的東西不多,因為相信大家對於MVP也已經很熟悉,主要是通過一個簡單的案例演示一個如何在MVP架構當中使用RxJava,有部分沒有貼出來的程式碼大家可以檢視 RxSample 中的第十五章。


更多文章,歡迎訪問我的 Android 知識梳理系列:

相關文章