Android Clean 架构浅析（基于JetPack AAC）

背景

本文基于Google官方推荐的AAC Samples 当中的Use Cases示例对Clean架构做一个简单的分析。
UserCase示例是用Kotlin编写的，使用了JetPack AAC当中的部分组件：

ViewModel
LiveData
Data Binding
Navigation
Room

什么是Clean架构

Clean 架构一般指的代码被划分为多层，类似于洋葱的形状，外层可以依赖内层，内层不能反向依赖外层，内层不知道外层的任何内容。这里插一张官网Clean的分层结构图：

image

每个组件仅依赖于其下一级的组件，例如Activity仅依赖ViewModel，ViewModel不能依赖任何视图或者跟Activity上下文有关系的类。

为什么要增加UserCase？

随着业务的不断扩张，ViewModel的内容可能会不断膨胀，那么独立出ViewModel的业务逻辑，划分到不同的领域(Use Cases)当中是有必要的，符合单一职责的指导思想，也有利于case的复用。体现到上图中，就是在ViewModel和Reposity添加一个层级，里面包含了不同的case，ViewModel通过组合、依赖注入的方式获取Cases的能力。

代码分析

以Task任务详情界面为例,分析不同层级之间的协作方式。
View包括TaskDetailFragment和taskdetail_frag.xml的内容。TaskDetailFragment部分代码如下：

class TaskDetailFragment : Fragment() {
    //Data Binding自动生成的TaskdetailFragBinding类
    private lateinit var viewDataBinding: TaskdetailFragBinding
    //通过自定义的ViewModelFactory 工厂类创建TaskDetailViewModel对象
    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>

通过Data Binding把视图和ViewModel进行了双向绑定，数据是响应式的，变化会实时反馈到界面上，视图不用再通过LiveData.observe()的方式对每个数据进行监听，代码更加简洁，ViewModel不依赖任何视图，也不会受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
    ...
    //设置task为完成状态
    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任务列表
    fun start(taskId: String?, forceRefresh: Boolean = false) {
        if (_isDataAvailable.value == true && !forceRefresh || _dataLoading.value == true) {
            return
        }
        // 展示loading框
        _dataLoading.value = true
        wrapEspressoIdlingResource {
        //viewModelScope内的协程会在ViewModel销毁后自动取消
            viewModelScope.launch {
                if (taskId != null) {
                    //根据任务id获取任务详情
                    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最终会调用Repository的函数获取数据，Repository是实现业务数据CURD的仓库，内部数据可能从网络获取也可能来自本地缓存或者数据库，Repository通过接口的形式声明，内部实现可以动态替换，比如替换网络库，更改数据存储方式等。

Clean架构的优势

自此基本流程也分析完了，Fragment、ViewModel、UseCase和Repository各司其职，互不依赖，对于提升代码的复用性、可读性、稳定性和可维护性都有很大的帮助。这样分层对于测试也是友好的，具体测试方式如下：

展示层 (Presentation Layer) : 使用robolectric进行集成和功能测试
领域层 (Domain Layer) :使用JUnit和Mockito进行单元测试

参考资料

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