背景

本文基于Google官方推薦的AAC Samples 當(dāng)中的Use Cases示例對(duì)Clean架構(gòu)做一個(gè)簡(jiǎn)單的分析。
UserCase示例是用Kotlin編寫(xiě)的，使用了JetPack AAC當(dāng)中的部分組件：

• ViewModel
• LiveData
• Data Binding
• Navigation
• Room

什么是Clean架構(gòu)

Clean 架構(gòu)一般指的代碼被劃分為多層少漆，類似于洋蔥的形狀僧诚，外層可以依賴內(nèi)層扯俱，內(nèi)層不能反向依賴外層脖律，內(nèi)層不知道外層的任何內(nèi)容。這里插一張官網(wǎng)Clean的分層結(jié)構(gòu)圖：

image

每個(gè)組件僅依賴于其下一級(jí)的組件蟀俊，例如Activity僅依賴ViewModel钦铺，ViewModel不能依賴任何視圖或者跟Activity上下文有關(guān)系的類。

為什么要增加UserCase肢预？

隨著業(yè)務(wù)的不斷擴(kuò)張矛洞，ViewModel的內(nèi)容可能會(huì)不斷膨脹，那么獨(dú)立出ViewModel的業(yè)務(wù)邏輯烫映，劃分到不同的領(lǐng)域(Use Cases)當(dāng)中是有必要的沼本，符合單一職責(zé)的指導(dǎo)思想，也有利于case的復(fù)用锭沟。體現(xiàn)到上圖中抽兆，就是在ViewModel和Reposity添加一個(gè)層級(jí)，里面包含了不同的case族淮，ViewModel通過(guò)組合辫红、依賴注入的方式獲取Cases的能力凭涂。

代碼分析

以Task任務(wù)詳情界面為例,分析不同層級(jí)之間的協(xié)作方式。
View包括TaskDetailFragment和taskdetail_frag.xml的內(nèi)容贴妻。TaskDetailFragment部分代碼如下：

class TaskDetailFragment : Fragment() {
    //Data Binding自動(dòng)生成的TaskdetailFragBinding類
    private lateinit var viewDataBinding: TaskdetailFragBinding
    //通過(guò)自定義的ViewModelFactory 工廠類創(chuàng)建TaskDetailViewModel對(duì)象
    private val viewModel by viewModels<TaskDetailViewModel> { getViewModelFactory() }
    ....
    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        val view = inflater.inflate(R.layout.taskdetail_frag, container, false)
        viewDataBinding = TaskdetailFragBinding.bind(view).apply {
            viewmodel = viewModel
        }
        viewDataBinding.lifecycleOwner = this.viewLifecycleOwner
        viewModel.start(args.taskId)
        return view
    }
}

taskdetail_frag.xml:

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    <data>
        <import type="android.view.View" />
        <variable
            name="viewmodel"
            type="com.example.android.architecture.blueprints.todoapp.taskdetail.TaskDetailViewModel" />
    </data>

    <androidx.coordinatorlayout.widget.CoordinatorLayout
        android:id="@+id/coordinator_layout"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
        <com.example.android.architecture.blueprints.todoapp.ScrollChildSwipeRefreshLayout
            android:id="@+id/refresh_layout"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            app:onRefreshListener="@{viewmodel::refresh}"
            app:refreshing="@{viewmodel.dataLoading}">
            ....
        </com.example.android.architecture.blueprints.todoapp.ScrollChildSwipeRefreshLayout>
    </androidx.coordinatorlayout.widget.CoordinatorLayout>
</layout>

通過(guò)Data Binding把視圖和ViewModel進(jìn)行了雙向綁定切油，數(shù)據(jù)是響應(yīng)式的，變化會(huì)實(shí)時(shí)反饋到界面上名惩，視圖不用再通過(guò)LiveData.observe()的方式對(duì)每個(gè)數(shù)據(jù)進(jìn)行監(jiān)聽(tīng)白翻，代碼更加簡(jiǎn)潔，ViewModel不依賴任何視圖绢片，也不會(huì)受configuration change影響。

ViewModel和UserCase交互

class TaskDetailViewModel(
    private val getTaskUseCase: GetTaskUseCase,
    private val deleteTaskUseCase: DeleteTaskUseCase,
    private val completeTaskUseCase: CompleteTaskUseCase,
    private val activateTaskUseCase: ActivateTaskUseCase
) : ViewModel() {
    val snackbarText: LiveData<Event<Int>> = _snackbarText
    private val _task = MutableLiveData<Task>()
    val task: LiveData<Task> = _task
    ...
    //設(shè)置task為完成狀態(tài)
    fun setCompleted(completed: Boolean) = viewModelScope.launch {
        val task = _task.value ?: return@launch
        if (completed) {
            completeTaskUseCase(task)
            showSnackbarMessage(R.string.task_marked_complete)
        } else {
            activateTaskUseCase(task)
            showSnackbarMessage(R.string.task_marked_active)
        }
    }
    //初始化task任務(wù)列表
    fun start(taskId: String?, forceRefresh: Boolean = false) {
        if (_isDataAvailable.value == true && !forceRefresh || _dataLoading.value == true) {
            return
        }
        // 展示loading框
        _dataLoading.value = true
        wrapEspressoIdlingResource {
        //viewModelScope內(nèi)的協(xié)程會(huì)在ViewModel銷毀后自動(dòng)取消
            viewModelScope.launch {
                if (taskId != null) {
                    //根據(jù)任務(wù)id獲取任務(wù)詳情
                    getTaskUseCase(taskId, false).let { result ->
                        if (result is Success) {
                            onTaskLoaded(result.data)
                        } else {
                            onDataNotAvailable(result)
                        }
                    }
                }
                //隱藏loading框
                _dataLoading.value = false
            }
        }
    }
    ....
    //更新toast提示信息
    private fun showSnackbarMessage(@StringRes message: Int) {
        _snackbarText.value = Event(message)
    }
}

UseCase最終會(huì)調(diào)用Repository的函數(shù)獲取數(shù)據(jù)岛琼，Repository是實(shí)現(xiàn)業(yè)務(wù)數(shù)據(jù)CURD的倉(cāng)庫(kù)底循，內(nèi)部數(shù)據(jù)可能從網(wǎng)絡(luò)獲取也可能來(lái)自本地緩存或者數(shù)據(jù)庫(kù)，Repository通過(guò)接口的形式聲明槐瑞，內(nèi)部實(shí)現(xiàn)可以動(dòng)態(tài)替換熙涤，比如替換網(wǎng)絡(luò)庫(kù)，更改數(shù)據(jù)存儲(chǔ)方式等困檩。

Clean架構(gòu)的優(yōu)勢(shì)

自此基本流程也分析完了祠挫，F(xiàn)ragment、ViewModel悼沿、UseCase和Repository各司其職等舔，互不依賴，對(duì)于提升代碼的復(fù)用性糟趾、可讀性慌植、穩(wěn)定性和可維護(hù)性都有很大的幫助。這樣分層對(duì)于測(cè)試也是友好的义郑，具體測(cè)試方式如下：

• 展示層 (Presentation Layer) : 使用robolectric進(jìn)行集成和功能測(cè)試
• 領(lǐng)域?qū)?(Domain Layer) :使用JUnit和Mockito進(jìn)行單元測(cè)試

參考資料

android-architecture-samples：https://github.com/android/architecture-samples/tree/usecases