結合Jetpack，構建快速開發的MVVM框架。

專案使用Jetpack：LiveData、ViewModel、Lifecycle、Navigation元件。

支援動態載入多狀態佈局：載入中、成功、失敗、標題；

支援快速生成ListActivity、ListFragment；

支援使用外掛快速生成適用於本框架的Activity、Fragment、ListActivity、ListFragment。

前言
--

> 隨著`Google`對`Jetpack`的完善，對於開發者來說，`MVVM`顯得越來越高效與方便。
> 
> 對於使用`MVVM`的公司來說，都有一套自己的`MVVM`框架，但是我發現有些只是對框架進行非常簡單的封裝，導致在開發過程中會出現很多沒必要的冗餘程式碼。
> 
> 這篇文章主要就是分享如何從0搭建一個高效的`MVVM`框架。

基於MVVM進行快速開發， 上手即用。（重構已完成，正在編寫SampleApp）
----------------------------------------

> 對基礎框架進行模組分離, 分為 `MVVM Library`\--`MVVM Navigation Library`\--`MVVM Network Library` 可基於業務需求使用 `MVVM Library` 、`MVVM Navigation Library`、`MVVM Network Library`

如何整合
----

To get a Git project into your build:

**Step 1**. Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

```
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
```

**Step 2**. Add the dependency

```
dependencies {
	// MVVM 基類
	implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm_framework:Tag'
	// MVVM Network 只負責網路處理
	implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm_network:Tag'
	// MVVM Navigation 元件抽離
	implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm_navigation:Tag'
}
```
| 說明 | 依賴地址 | 版本號 |
| --- | --- | --- |
| MVVM 基類 | implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm\_framework:Tag' | [![MVVM](https://jitpack.io/v/Chen-Xi-g/MVVMFramework.svg)](https://link.juejin.cn/?target=https%3A%2F%2Fjitpack.io%2F%23Chen-Xi-g%2FMVVMFramework "https://jitpack.io/#Chen-Xi-g/MVVMFramework") |
| MVVM Network | implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm\_network:Tag' | [![MVVM](https://jitpack.io/v/Chen-Xi-g/MVVMFramework.svg)](https://link.juejin.cn/?target=https%3A%2F%2Fjitpack.io%2F%23Chen-Xi-g%2FMVVMFramework "https://jitpack.io/#Chen-Xi-g/MVVMFramework") |
| MVVM Navigation | implementation 'com.github.Chen-Xi-g.MVVMFramework:mvvm\_navigation:Tag' | [![MVVM](https://jitpack.io/v/Chen-Xi-g/MVVMFramework.svg)](https://link.juejin.cn/?target=https%3A%2F%2Fjitpack.io%2F%23Chen-Xi-g%2FMVVMFramework "https://jitpack.io/#Chen-Xi-g/MVVMFramework") |

依賴引入後，需要初始化依賴，下面是模組化初始化流程。

### 1.繼承BaseApplication

建立你的Application類，繼承`BaseApplication`，並且需要在`onCreate`函式中進行配置和初始化相關引數，可以在這裡配置網路請求框架的引數和UI全域性引數。比如攔截器和多域名，全域性Activity屬性。

```
// 全域性Activity設定
GlobalMVVMBuilder.initSetting(BaseActivitySetting(), BaseFragmentSetting())

private fun initHttpManager() {
    // 引數攔截器
    HttpManager.instance.setting {
        // 設定網路屬性
        setTimeUnit(TimeUnit.SECONDS) // 時間型別 秒， 框架預設值 毫秒
        setReadTimeout(30) // 讀取超時 30s， 框架預設值 10000L
        setWriteTimeout(30) // 寫入超時 30s， 框架預設值 10000L
        setConnectTimeout(30) // 連結超時 30s，框架預設值 10000L
        setRetryOnConnectionFailure(true) // 超時自動重連， 框架預設值 true
        setBaseUrl("https://www.wanandroid.com") // 預設域名
        // 多域名配置
        setDomain {
            Constant.domainList.forEach { map ->
                map.forEach {
                    if (it.key.isNotEmpty() && it.value.isNotEmpty()) {
                        put(it.key, it.value)
                    }
                }
            }
        }
        setLoggingInterceptor(
            isDebug = BuildConfig.DEBUG,
            hideVerticalLine = true,
            requestTag = "HTTP Request 請求引數",
            responseTag = "HTTP Response 返回引數"
        )
        // 新增攔截器
        setInterceptorList(hashSetOf(ResponseInterceptor(), ParameterInterceptor()))
    }
}

// 需要重寫，傳入當前是否初始Debug模式。
override fun isLogDebug(): Boolean {
    // 是否顯示日誌
    return BuildConfig.DEBUG
}
```

### 2.建立ViewModel擴充套件函式

所有模組需要依賴的base模組建立ViewModel相關的擴充套件函式VMKxt。

```
/**
 * 過濾伺服器結果，失敗拋異常
 * @param block 請求體方法，必須要用suspend關鍵字修飾
 * @param success 成功回撥
 * @param error 失敗回撥 可不傳
 * @param isLoading 是否顯示 Loading 佈局
 * @param loadingMessage 載入框提示內容
 */
fun <t> BaseViewModel.request(
    block: suspend () -> BaseResponse<t>,
    success: (T?) -> Unit,
    error: (ResponseThrowable) -> Unit = {},
    isLoading: Boolean = false,
    loadingMessage: String? = null
): Job {
    // 開始執行請求
    httpCallback.beforeNetwork.postValue(
        // 執行Loading邏輯
        LoadingEntity(
            isLoading,
            loadingMessage?.isNotEmpty() == true,
            loadingMessage ?: ""
        )
    )
    return viewModelScope.launch {
        kotlin.runCatching {
            //請求體
            block()
        }.onSuccess {
            // 網路請求成功， 結束請求
            httpCallback.afterNetwork.postValue(false)
            //校驗請求結果碼是否正確，不正確會丟擲異常走下面的onFailure
            kotlin.runCatching {
                executeResponse(it) { coroutine ->
                    success(coroutine)
                }
            }.onFailure { error ->
                // 請求時發生異常， 執行失敗回撥
                val responseThrowable = ExceptionHandle.handleException(error)
                httpCallback.onFailed.value = responseThrowable.errorMsg ?: ""
                responseThrowable.errorLog?.let { errorLog ->
                    LogUtil.e(errorLog)
                }
                // 執行失敗的回撥方法
                error(responseThrowable)
            }
        }.onFailure { error ->
            // 請求時發生異常， 執行失敗回撥
            val responseThrowable = ExceptionHandle.handleException(error)
            httpCallback.onFailed.value = responseThrowable.errorMsg ?: ""
            responseThrowable.errorLog?.let { errorLog ->
                LogUtil.e(errorLog)
            }
            // 執行失敗的回撥方法
            error(responseThrowable)
        }
    }
}

/**
 * 不過濾伺服器結果
 * @param block 請求體方法，必須要用suspend關鍵字修飾
 * @param success 成功回撥
 * @param error 失敗回撥 可不傳
 * @param isLoading 是否顯示 Loading 佈局
 * @param loadingMessage 載入框提示內容
 */
fun <t> BaseViewModel.requestNoCheck(
    block: suspend () -> T,
    success: (T) -> Unit,
    error: (ResponseThrowable) -> Unit = {},
    isLoading: Boolean = false,
    loadingMessage: String? = null
): Job {
    // 開始執行請求
    httpCallback.beforeNetwork.postValue(
        // 執行Loading邏輯
        LoadingEntity(
            isLoading,
            loadingMessage?.isNotEmpty() == true,
            loadingMessage ?: ""
        )
    )
    return viewModelScope.launch {
        runCatching {
            //請求體
            block()
        }.onSuccess {
            // 網路請求成功， 結束請求
            httpCallback.afterNetwork.postValue(false)
            //成功回撥
            success(it)
        }.onFailure { error ->
            // 請求時發生異常， 執行失敗回撥
            val responseThrowable = ExceptionHandle.handleException(error)
            httpCallback.onFailed.value = responseThrowable.errorMsg ?: ""
            responseThrowable.errorLog?.let { errorLog ->
                LogUtil.e(errorLog)
            }
            // 執行失敗的回撥方法
            error(responseThrowable)
        }
    }
}

/**
 * 請求結果過濾，判斷請求伺服器請求結果是否成功，不成功則會丟擲異常
 */
suspend fun <t> executeResponse(
    response: BaseResponse<t>,
    success: suspend CoroutineScope.(T?) -> Unit
) {
    coroutineScope {
        when {
            response.isSuccess() -> {
                success(response.getResponseData())
            }
            else -> {
                throw ResponseThrowable(
                    response.getResponseCode(),
                    response.getResponseMessage(),
                    response.getResponseMessage()
                )
            }
        }
    }
}
```

以上程式碼封裝了快速的網路請求擴充套件函式，並且可以根據自己的情況，選擇脫殼或者不脫殼的回撥處理。 呼叫示例：

```
/**
 * 載入列表資料
 */
fun getArticleListData(page: Int, pageSize: Int) {
    request(
        {
            filterArticleList(page, pageSize)
        }, {
            // 成功操作
            it?.let {
                _articleListData.postValue(it.datas)
            }
        }
    )
}
```

完成上面的操作，你就可以進入愉快的開發工作了。

### 3.引入一鍵生成程式碼外掛(可選)

每次建立Activity、Fragment、ListActivity、ListFragment都是重複的工作，為了可以更高效的開發，減少這些枯燥的操作，特地編寫的快速生成MVVM程式碼的外掛，該外掛只適用於當前MVVM框架，具體使用請前往AlvinMVVMPlugin。整合後你就可以開始像建立`EmptyActivity`這樣建立`MVVMActivity`。

框架結構
----

### mvvm

該元件對Activity和Fragment進行常用屬性封裝

*   `base`包下封裝了`MVVM`的基礎元件。
    *   `activity`實現`DataBinding + ViewModel`的封裝，以及一些其他功能。
    *   `adapter`實現`DataBinding + Adapter`的封裝。
    *   `fragment`實現`DataBinding + ViewModel`的封裝，以及一些其他功能。
    *   `livedata`實現`LiveData`的基礎功能封裝，如基本資料型別的非空返回值。
    *   `view_model`實現`BaseViewModel`的處理。
*   `help`包下封裝了元件的輔助類，在BaseApplication中進行全域性Actiivty、Fragment屬性賦值。
*   `manager`包下封裝了對Activity的管理。
*   `utils`包下封裝了LogUtil工具類，透過BaseApplication進行初始化。

#### Activity封裝

1.  `AbstractActivity`是`Activity`的抽象基類，這個類裡面的方法適用於全部`Activity`的需求。 該類中封裝了所有Activity必須實現的抽象方法。
2.  `BaseActivity`封裝了基礎的`Activity`功能，主要用來初始化`Activity`公共功能：`DataBinding`的初始化、沉浸式狀態列、`AbstractActivity`抽象方法的呼叫、螢幕適配、空白區域隱藏軟鍵盤。具體功能可以自行新增。
3.  `BaseDialogActivity`只負責顯示`Dialog Loading`彈窗，一般在提交請求或本地流處理時使用。也可以擴充套件其他的`Dialog`，比如時間選擇器之類。
4.  `BaseContentViewActivity`是對佈局進行初始化操作的`Activity`，他是我們的核心。這裡處理了每個`Activity`的每個狀態的佈局，一般情況下有：
    *   `TitleLayout` 公共標題
    *   `ContentLayout` 主要的內容佈局，使我們需要程式內容的主要容器。
    *   `ErrorLayout` 當網路請求發生錯誤，需要對使用者進行友好的提示。
    *   `LoadingLayout` 正在載入資料的佈局，給使用者一個良好的體驗，避免首次進入頁面顯示的佈局沒有資料。
5.  `BaseVMActivity`實現`ViewMode`的`Activity`基類，透過泛型對`ViewModel`進行例項化。並且透過`BaseViewModel`進行公共操作。
6.  `BaseMVVMActivity` 所有`Activity`最終需要繼承的`MVVM`類，透過傳入`DataBinding`和`ViewModel`的泛型進行初始化操作，在構造引數中還需要獲取`Layout`佈局
7.  `BaseListActivity`適用於列表的`Activity`，分頁操作、上拉載入、下拉重新整理、空佈局、頭佈局、底佈局封裝。

#### Fragment封裝

根據你的需要進行不同的封裝，我比較傾向於和`Activity`具有相同功能的封裝，也就是`Activity`封裝的功能我`Fragment`也要有。這樣在使用`Navigation`的時候可以減少`Activity`和`Fragment`的差異。這裡直接參考Activity的封裝

#### Adapter封裝

每個專案中肯定會有列表的頁面，所以還需要對`Adapter`進行`DataBinding`適配，這裡使用的Adapter是BRVAH。

```
abstract class BaseBindingListAdapter<t db="" :="" viewdatabinding="">(
    @LayoutRes private val layoutResId: Int
) : BaseQuickAdapter<t baseviewholder="">(layoutResId) {

abstract fun convert(holder: BaseViewHolder, item: T, dataBinding: DB?)

override fun convert(holder: BaseViewHolder, item: T) {
        convert(holder, item, DataBindingUtil.bind(holder.itemView))
    }
}
```

#### LiveData封裝

`LiveData`在使用的時候會出現資料倒灌的情況，用簡單的話來描述資料倒灌：A訂閱1月1日新聞資訊，B訂閱1月15日新聞資訊，但是B在1月15日同時收到了1月1日的資訊，這明顯不符合我們生活中的邏輯，所以需要對`LiveData`進行封裝，詳細的可以檢視`KunMinX`的UnPeek-LiveData。

#### Navigation封裝

透過重寫 `FragmentNavigator` 將原來的 `FragmentTransaction.replace()` 方法替換為 `hide()/Show()`

#### ViewModel封裝

在`BaseViewModel`中封裝一個網路請求需要用的`LiveData`，下面是一個簡單的示例

```
open class BaseViewModel : ViewModel() {

// 預設的網路請求LiveData
    val httpCallback: HttpCallback by lazy { HttpCallback() }

inner class HttpCallback {

/**
         * 請求發生錯誤
         *
         * String = 網路請求異常
         */
        val onFailed by lazy { StringLiveData() }

/**
         * 請求開始
         *
         * LoadingEntity 顯示loading的實體類
         */
        val beforeNetwork by lazy { EventLiveData<loadingentity>() }

/**
         * 請求結束後框架自動對 loading 進行處理
         *
         * false 關閉 loading or Dialog
         * true 不關閉 loading or Dialog
         */
        val afterNetwork by lazy { BooleanLiveData() }
    }
}
```

#### 輔助類封裝

大部分的`Activity`和`Fragment`樣式基本相同，比如佈局中的`TitleLayout`、`LoadingLayout`這些都是統一樣式。所以可以封裝全域性的輔助類來對Activity中的屬性進行抽離。

*   定義介面`ISettingBaseActivity`新增抽離的方法，並且賦於預設值。
*   定義介面`ISettingBaseFragment`新增抽離的方法，並且賦於預設值。
*   建立`ISettingBaseActivity`和`ISettingBaseFragment`的實現類，進行預設的自定義操作。
*   建立`GlobalMVVMBuilder`進行賦值

#### 管理類封裝

透過`Lifecycle`結合`AppManager`對Activity的進出棧管理。

### mvvm\_navigation

分離Navigation，透過重寫 FragmentNavigator 將原來的 FragmentTransaction.replace() 方法替換為 hide()/Show()。

### mvvm\_network

使用 `Retrofit` + `OkHttp` + `Moshi` 對網路請求進行封裝，使用密封類自定義異常處理。</loadingentity></t></t></t></t></t></t></t>

從0搭建一個實用的MVVM框架

相關文章