簡介
背景
這幾年 MVP 架構在安卓界非常流行,幾乎已經成為主流框架,它讓業務邏輯 和 UI操作相對獨立,使得代碼結構更清晰。
MVVM 在前端火得一塌糊涂,而在安卓這邊卻基本沒見到幾個人在用,看到介紹 MVVM 也最多是講 DataBinding 或 介紹思想的。偶爾看到幾篇提到應用的,還是對谷歌官網的Architecture Components 文章的翻譯。
相信大家看別人博客或官方文檔的時候,總會碰到一些坑。要么入門教程寫得太復雜(無力吐槽,前面寫一堆原理,各種高大上的圖,然并卵,到實踐部分一筆帶過,你確定真的是入門教程嗎)。要么就是簡單得就是一個 hello world,然后就沒有下文了(看了想罵人)。
實在看不下去的我,決定插手你的人生。
目錄
《安卓-深入淺出MVVM教程》大致分兩部分:應用篇、原理篇。
采用循序漸進方式,內容深入淺出,符合人類學習規律,希望大家用最少時間掌握 MVVM。
應用篇:
01 Hello MVVM (快速入門)
02 Repository (數據倉庫)
03 Cache (本地緩存)
04 State Lcee (加載/空/錯誤/內容視圖)
05 Simple Data Source (簡單的數據源)
06 Load More (加載更多)
07 DataBinding (數據與視圖綁定)
08 RxJava2
09 Dragger2
10 Abstract (抽象)
11 Demo (例子)
12-n 待定(歡迎 github 提建議)
原理篇
01 MyLiveData(最簡單的LiveData)
02-n 待定(并不是解讀源碼,那樣太無聊了,打算帶你從0擼一個 Architecture)
關于提問
本人水平和精力有限,如果有大佬發現哪里寫錯了或有好的建議,歡迎在本教程附帶的 github倉庫 提issue。
What?為什么不在博客留言?考慮到國內轉載基本無視版權的情況,一般來說你都不是在源出處看到這篇文章,所以留言我也一般是看不到的。
教程附帶代碼
https://github.com/ittianyu/MVVM
應用篇放在 app 模塊下,原理篇放在 implementation 模塊下。
每一節代碼采用不同包名,相互獨立。
前言
上一節我們加入了緩存。這一節我來回答上一次的問題。
重新請求數據
下拉刷新 或者 重發請求 是常見的需求。
怎么在 MVVM 中實現呢?
其實第一節就有提到,LiveData 直接調用 setValue 或 PostValue 就會觸發一次數據更新操作。
為了使得 username 可以改變,我們要把他定義為一個可變的 LiveData。
那么我們怎么在 username 改變的時候去更新 user 呢?
我們可以通過 Transformations.switchMap 來生成一個監聽 username 的 LiveData
public class UserViewModel extends ViewModel {
private UserRepository userRepository = UserRepository.getInstance();
private MutableLiveData<String> ldUsername;
private LiveData<User> ldUser;
public LiveData<User> getUser() {
if (null == ldUser) {
ldUsername = new MutableLiveData<>();
ldUser = Transformations.switchMap(ldUsername, new Function<String, LiveData<User>>() {
@Override
public LiveData<User> apply(String username) {
return userRepository.getUser(username);
}
});
}
return ldUser;
}
public void reload(String username) {
ldUsername.setValue(username);
}
}
當需要請求數據的時候,View 中調用 reload 方法即可觸發。
這里不再往下講了,因為還要加入多狀態。
多狀態視圖
最常見的狀態是 Loading Content Empty Error
Bean
所以首先想到的是定義枚舉類型
public enum Status {
Loading,
Content,
Empty,
Error,
}
有了類型該怎么使用?
作為 MVVM 架構,核心思想是根據 Data 渲染 View,所以很自然想到根據狀態和數據來渲染 View。然而狀態和數據是難以分離的,所以一般會想到通過一個 bean 來把數據和狀態包裝起來。
public class Lcee<T> {
public final Status status;
public final T data;
public final Throwable error;
public Lcee(Status status, T data, Throwable error) {
this.status = status;
this.data = data;
this.error = error;
}
}
為了方便外部使用,我們再定義一些工廠方法。
public static <T> Lcee<T> content(T data) {
return new Lcee<>(Status.Content, data, null);
}
public static <T> Lcee<T> error(T data, Throwable error) {
return new Lcee<>(Status.Error, data, error);
}
public static <T> Lcee<T> error(Throwable error) {
return error(null, error);
}
public static <T> Lcee<T> empty(T data) {
return new Lcee<>(Status.Empty, data, null);
}
public static <T> Lcee<T> empty() {
return empty(null);
}
public static <T> Lcee<T> loading(T data) {
return new Lcee<>(Status.Loading, data, null);
}
public static <T> Lcee<T> loading() {
return loading(null);
}
Model
DataSource
因為 bean 變了,所以 DataSource 和實現都得修改。
先把接口的返回值改成 LiveData<Lcee<User>>
public interface UserDataSource {
LiveData<Lcee<User>> queryUserByUsername(String username);
}
UserRepository
UserRepository 里面的返回值也要改
public LiveData<Lcee<User>> getUser(String username) {
...
}
LocalUserDataSource
然后先改本地數據源 LocalUserDataSource
這里出現了一個 MediatorLiveData,這是什么鬼?
它也是一個 LiveData,不過可以添加多個數據源
我沒聽錯吧?他自己不是數據源嗎?
是的,他可以觀察其他數據。
因為這樣,我們就可以實現 LiveData<User> 轉換為 LiveData<Lcee<User>>
@Override
public LiveData<Lcee<User>> queryUserByUsername(String username) {
final MediatorLiveData<Lcee<User>> data = new MediatorLiveData<>();
data.setValue(Lcee.<User>loading());
data.addSource(userService.queryByUsername(username), new Observer<User>() {
@Override
public void onChanged(@Nullable User user) {
if (null == user) {
data.setValue(Lcee.<User>empty());
} else {
data.setValue(Lcee.content(user));
}
}
});
return data;
}
RemoteUserDataSource
而遠程數據源就不用轉換了,只需要修改一下 LiveData 的類型。
@Override
public LiveData<Lcee<User>> queryUserByUsername(String username) {
final MutableLiveData<Lcee<User>> data = new MutableLiveData<>();
data.setValue(Lcee.<User>loading());
userApi.queryUserByUsername(username)
.enqueue(new Callback<User>() {
@Override
public void onResponse(Call<User> call, Response<User> response) {
User user = response.body();
if (null == user) {
data.setValue(Lcee.<User>empty());
return;
}
data.setValue(Lcee.content(user));
// update cache
LocalUserDataSource.getInstance().addUser(user);
}
@Override
public void onFailure(Call<User> call, Throwable t) {
t.printStackTrace();
data.setValue(Lcee.<User>error(t));
}
});
return data;
}
ViewModel
因為數據變了,ViewModel 也得做小修改,實際上就是改了返回值
public LiveData<Lcee<User>> getUser() {
...
}
View
View 要根據數據渲染,現在數據改了, View 自然也要改。
重新請求數據
為了可以實現輸入用戶名然后進行重新請求數據,我們得不得加入編輯框和按鈕,其實就是 左邊輸入框,右邊按鈕
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center_vertical"
android:orientation="horizontal">
<EditText
android:id="@+id/et_username"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_weight="1"
android:imeOptions="actionSearch"
android:singleLine = "true"
android:text="ittianyu" />
<Button
android:id="@+id/btn_search"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="search" />
</LinearLayout>
相應的,在 Activity 中初始化
etUsername = (EditText) findViewById(R.id.et_username);
為了方便取值,定義一個方法
private String getUsername() {
return etUsername.getText().toString();
}
還記得一開始說的,重新請求數據嗎,現在可以調用這樣一個方法就實現重新請求數據了。
private void reload() {
// reload
userViewModel.reload(getUsername());
}
多狀態視圖
XML
為了顯示4種狀態視圖,我們需要先定義
把狀態視圖整合到一起后就是這樣的。
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center_vertical"
android:orientation="horizontal">
<EditText
android:id="@+id/et_username"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_weight="1"
android:imeOptions="actionSearch"
android:singleLine = "true"
android:text="ittianyu" />
<Button
android:id="@+id/btn_search"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="search" />
</LinearLayout>
<FrameLayout
android:id="@+id/v_root"
android:layout_width="match_parent"
android:layout_height="match_parent">
<LinearLayout
android:id="@+id/v_content"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:orientation="vertical">
<TextView
android:id="@+id/tv_id"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center" />
<TextView
android:id="@+id/tv_name"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center" />
</LinearLayout>
<FrameLayout
android:id="@+id/v_error"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:text="Network error, click to reload" />
</FrameLayout>
<FrameLayout
android:id="@+id/v_empty"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:text="User not exist" />
</FrameLayout>
<FrameLayout
android:id="@+id/v_loading"
android:layout_width="match_parent"
android:layout_height="match_parent">
<ProgressBar
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center" />
</FrameLayout>
</FrameLayout>
</LinearLayout>
初始化View
然后記得初始化
vContent = findViewById(R.id.v_content);
vError = findViewById(R.id.v_error);
vLoading = findViewById(R.id.v_loading);
vEmpty = findViewById(R.id.v_empty);
修改觀察的數據類型
這里也要修改觀察的數據類型
private void initData() {
...
userViewModel.getUser().observe(this, new Observer<Lcee<User>>() {
@Override
public void onChanged(@Nullable Lcee<User> data) {
updateView(data);
}
});
reload();
}
響應事件
具體怎么渲染的等下再說,我們還需要處理一些用戶點擊事件。
- 用戶點擊 錯誤/空 視圖后,觸發重新加載。
- 點擊搜索按鈕/鍵盤回車后,隱藏鍵盤,觸發重新加載
private void initEvent() {
View.OnClickListener reloadClickListener = new View.OnClickListener() {
@Override
public void onClick(View view) {
hideKeyboard();
reload();
}
};
vError.setOnClickListener(reloadClickListener);
vEmpty.setOnClickListener(reloadClickListener);
findViewById(R.id.btn_search).setOnClickListener(reloadClickListener);
etUsername.setOnKeyListener(new View.OnKeyListener() {
@Override
public boolean onKey(View v, int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_ENTER) {
hideKeyboard();
reload();
return true;
}
return false;
}
});
}
private void hideKeyboard() {
((InputMethodManager) getSystemService(INPUT_METHOD_SERVICE))
.hideSoftInputFromWindow(UserActivity.this.getCurrentFocus().getWindowToken(),
InputMethodManager.HIDE_NOT_ALWAYS);
}
渲染
接下來就是重點,渲染 view
根據四種狀態去渲染
private void updateView(Lcee<User> lcee) {
switch (lcee.status) {
case Content: {
showContent();
tvId.setText(lcee.data.getId() + "");
tvName.setText(lcee.data.getName());
break;
}
case Empty: {
showEmpty();
break;
}
case Error: {
showError();
break;
}
case Loading: {
showLoading();
break;
}
}
}
同時為了方便調用,我們封裝 4 個方法來切換 4 種視圖
private void showContent() {
vContent.setVisibility(View.VISIBLE);
vEmpty.setVisibility(View.GONE);
vError.setVisibility(View.GONE);
vLoading.setVisibility(View.GONE);
}
private void showEmpty() {
vContent.setVisibility(View.GONE);
vEmpty.setVisibility(View.VISIBLE);
vError.setVisibility(View.GONE);
vLoading.setVisibility(View.GONE);
}
private void showError() {
vContent.setVisibility(View.GONE);
vEmpty.setVisibility(View.GONE);
vError.setVisibility(View.VISIBLE);
vLoading.setVisibility(View.GONE);
}
private void showLoading() {
vContent.setVisibility(View.GONE);
vEmpty.setVisibility(View.GONE);
vError.setVisibility(View.GONE);
vLoading.setVisibility(View.VISIBLE);
}
總結
到此為止,我們解決了一大難題。
What?你已經掌握 MVVM 了?
好戲才剛剛開始