领域层

域层是一个可选层,位于 UI 层和数据层之间。

When it is included, the optional domain layer provides dependencies to
    the UI layer and depends on the data layer.
图 1. 域层在应用架构中的作用。

域层负责封装复杂的业务逻辑,或由多个 ViewModel 重用的简单业务逻辑。此层是可选的,因为并非所有应用都需要这些要求。您应该只在需要时使用它,例如,处理复杂性或偏爱可重用性。

域层提供以下优势

  • 它避免了代码重复。
  • 它提高了使用域层类的类的可读性。
  • 它提高了应用的可测试性。
  • 它通过允许您拆分职责来避免大型类。

为了使这些类保持简单和轻量级,每个用例都应只负责一项功能,并且不应包含可变数据。您应该改为在 UI 或数据层中处理可变数据。

本指南中的命名约定

在本指南中,用例以它们负责的单个操作命名。约定如下

现在时态的动词 + 名词/内容(可选) + UseCase

例如:FormatDateUseCaseLogOutUserUseCaseGetLatestNewsWithAuthorsUseCaseMakeLoginRequestUseCase

依赖项

在典型的应用架构中,用例类位于 UI 层的 ViewModel 和数据层的存储库之间。这意味着用例类通常依赖于存储库类,并且它们与 UI 层的通信方式与存储库相同——使用回调(对于 Java)或协程(对于 Kotlin)。要详细了解此信息,请参阅数据层页面

例如,在您的应用中,您可能有一个用例类,它从新闻资源库和作者资源库获取数据,并将它们组合起来。

class GetLatestNewsWithAuthorsUseCase(
  private val newsRepository: NewsRepository,
  private val authorsRepository: AuthorsRepository
) { /* ... */ }

由于用例包含可重用的逻辑,因此其他用例也可以使用它们。在域层中有多个级别的用例是很正常的。例如,下面示例中定义的用例如果 UI 层的多个类依赖于时区在屏幕上显示正确的消息,则可以使用 FormatDateUseCase 用例。

class GetLatestNewsWithAuthorsUseCase(
  private val newsRepository: NewsRepository,
  private val authorsRepository: AuthorsRepository,
  private val formatDateUseCase: FormatDateUseCase
) { /* ... */ }
GetLatestNewsWithAuthorsUseCase depends on repository classes from the
    data layer, but it also depends on FormatDataUseCase, another use case class
    that is also in the domain layer.
图 2. 依赖于其他用例的用例的示例依赖关系图。

在 Kotlin 中调用用例

在 Kotlin 中,您可以通过使用 operator 修饰符定义 invoke() 函数,使用例类实例可作为函数调用。请参见以下示例

class FormatDateUseCase(userRepository: UserRepository) {

    private val formatter = SimpleDateFormat(
        userRepository.getPreferredDateFormat(),
        userRepository.getPreferredLocale()
    )

    operator fun invoke(date: Date): String {
        return formatter.format(date)
    }
}

在此示例中,FormatDateUseCase 中的 invoke() 方法允许您像调用函数一样调用类的实例。 invoke() 方法不受任何特定签名的限制,它可以接受任意数量的参数并返回任意类型。您还可以在类中使用不同的签名重载 invoke()。您将如下调用上面示例中的用例:

class MyViewModel(formatDateUseCase: FormatDateUseCase) : ViewModel() {
    init {
        val today = Calendar.getInstance()
        val todaysDate = formatDateUseCase(today)
        /* ... */
    }
}

要详细了解 invoke() 运算符,请参阅 Kotlin 文档

生命周期

用例没有自己的生命周期。相反,它们的作用域限定为使用它们的类。这意味着您可以从 UI 层的类、服务或 Application 类本身调用用例。由于用例不应包含可变数据,因此您应该在每次将其作为依赖项传递时创建一个新的用例类实例。

线程

域层中的用例必须是主线程安全的;换句话说,它们必须可以在主线程中安全调用。如果用例类执行长时间阻塞操作,则它们负责将该逻辑移动到相应的线程。但是,在执行此操作之前,请检查这些阻塞操作是否更适合放置在层次结构的其他层中。通常,复杂的计算发生在数据层中,以鼓励可重用性或缓存。例如,如果需要缓存结果以在应用的多个屏幕上重用,则对大型列表执行资源密集型操作最好放在数据层而不是域层。

以下示例显示了一个在后台线程上执行其工作的用例

class MyUseCase(
    private val defaultDispatcher: CoroutineDispatcher = Dispatchers.Default
) {

    suspend operator fun invoke(...) = withContext(defaultDispatcher) {
        // Long-running blocking operations happen on a background thread.
    }
}

常见任务

本节介绍如何执行常见的域层任务。

可重用的简单业务逻辑

您应该将 UI 层中存在的可重复业务逻辑封装到用例类中。这使得在逻辑使用的所有地方应用任何更改都变得更容易。它还允许您独立测试逻辑。

考虑前面描述的 FormatDateUseCase 示例。如果将来您关于日期格式化的业务需求发生变化,您只需在一个集中位置更改代码即可。

组合资源库

在新闻应用中,您可能拥有分别处理新闻和作者数据操作的 NewsRepositoryAuthorsRepository 类。 NewsRepository 公开的 Article 类仅包含作者的姓名,但您希望在屏幕上显示有关作者的更多信息。作者信息可以从 AuthorsRepository 获取。

GetLatestNewsWithAuthorsUseCase depends on two different repository
    classes from the data layer: NewsRepository and AuthorsRepository.
图 3. 组合来自多个资源库的数据的用例的依赖关系图。

由于逻辑涉及多个资源库并且可能变得复杂,因此您创建了一个 GetLatestNewsWithAuthorsUseCase 类以将逻辑抽象出 ViewModel 并使其更易于阅读。这还可以使逻辑更容易独立测试,并在应用的不同部分重复使用。

/**
 * This use case fetches the latest news and the associated author.
 */
class GetLatestNewsWithAuthorsUseCase(
  private val newsRepository: NewsRepository,
  private val authorsRepository: AuthorsRepository,
  private val defaultDispatcher: CoroutineDispatcher = Dispatchers.Default
) {
    suspend operator fun invoke(): List<ArticleWithAuthor> =
        withContext(defaultDispatcher) {
            val news = newsRepository.fetchLatestNews()
            val result: MutableList<ArticleWithAuthor> = mutableListOf()
            // This is not parallelized, the use case is linearly slow.
            for (article in news) {
                // The repository exposes suspend functions
                val author = authorsRepository.getAuthor(article.authorId)
                result.add(ArticleWithAuthor(article, author))
            }
            result
        }
}

该逻辑映射 news 列表中的所有项目;因此,即使数据层是主线程安全的,此工作也不应该阻塞主线程,因为您不知道它将处理多少个项目。这就是用例使用默认调度程序将工作移动到后台线程的原因。

其他使用者

除了 UI 层之外,域层还可以被其他类(例如服务和 Application 类)重复使用。此外,如果其他平台(例如电视或可穿戴设备)与移动应用共享代码库,则它们的 UI 层也可以重复使用用例以获得上述所有域层优势。

数据层访问限制

在实现域层时,另一个需要考虑的问题是您是否仍应允许 UI 层直接访问数据层,或者强制所有内容都通过域层。

UI layer cannot access data layer directly, it must go through the Domain layer
图 4. 显示 UI 层被拒绝访问数据层的依赖关系图。

实施此限制的一个优点是它阻止您的 UI 绕过域层逻辑,例如,如果您正在对对数据层的每次访问请求执行分析日志记录。

但是,潜在的重大缺点是它会强制您添加用例,即使它们只是对数据层的简单函数调用,这可能会增加复杂性而收益甚微。

一个好的方法是仅在需要时添加用例。如果您发现您的 UI 层几乎完全通过用例访问数据,那么可能只通过这种方式访问数据是有意义的。

最终,是否限制对数据层的访问取决于您的个人代码库,以及您是偏好严格规则还是更灵活的方法。

测试

测试域层时,适用 通用测试指南。对于其他 UI 测试,开发人员通常使用伪造的资源库,并且在测试域层时也使用伪造的资源库是一个好习惯。

示例

以下 Google 示例演示了域层的使用。请浏览它们以了解此指南在实践中的应用