网域层

网域层是位于界面层和数据层之间的可选层。

如果添加了此层,则该可选网域层会向界面层提供依赖项,而它自身依赖于数据层。
图 1. 网域层在应用架构中的作用。

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

领域层具有以下优势:

  • 避免代码重复。
  • 改善使用网域层类的类的可读性。
  • 改善应用的可测试性。
  • 让您能够划分好职责,从而避免出现大型类。

为了使这些类保持简单轻量化,每个用例都应仅负责单个功能,且不应包含可变数据。您应在界面或数据层中处理可变的数据。

本指南中的命名惯例

在本指南中,用例以其负责的单一操作命名。具体命名惯例如下:

一般现在时动词 + 名词/内容(可选)+ 用例。

例如:FormatDateUseCaseLogOutUserUseCaseGetLatestNewsWithAuthorsUseCaseMakeLoginRequestUseCase

依赖关系

在典型的应用架构中,用例类适合界面层的 ViewModel 与数据层的代码库。这意味着用例类通常依赖于代码库类,并且它们与界面层的通信方式与代码库的通信方式相同 - 使用回调(Java 代码)或协程(Kotlin 代码)。如需了解详情,请参阅数据层页面

例如,在您的应用中,可能会有一个用例类,用于从新闻代码库和作者代码库中提取数据并对它们进行组合:

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

由于用例包含可重复使用的逻辑,因此其他用例也可以使用这些用例。在网域层有多个用例层级是正常现象。例如,如果界面层中的多个类依赖时区在屏幕上显示适当的消息,则以下示例中定义的用例可以使用 FormatDateUseCase 用例:

class GetLatestNewsWithAuthorsUseCase(
  private val newsRepository: NewsRepository,
  private val authorsRepository: AuthorsRepository,
  private val formatDateUseCase: FormatDateUseCase
) { /* ... */ }
GetLatestNewsWithAuthorsUseCase 依赖于数据层中的代码库类,但它同时还依赖于同样位于网域层的另一个用例类 FormatDataUseCase。
图 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 文档

生命周期

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

线程处理

来自网域层的用例必须具有主线程安全性;换句话说,它们必须能安全地从主线程调用。如果用例类执行长期运行的阻塞操作,那么它们负责将该逻辑移至适当的线程。不过,在执行此操作之前,请检查这些阻塞操作是否最好放置在层次结构的其他层中。通常,数据层中会进行复杂的计算,以促进可重用性或缓存。例如,如果某项结果需要缓存起来,以便在应用的多个屏幕上重复使用,那么在数据层中对大列表执行资源密集型操作比在网域层中执行会更好。

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

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

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

常见任务

本部分介绍如何执行常见网域层任务。

可重复使用的简单业务逻辑

您应将界面层中存在的可重复业务逻辑封装到用例类中。这样您就可以更轻松地在使用该逻辑的所有位置应用任何更改,还可以单独测试逻辑。

考虑前面介绍的 FormatDateUseCase 示例。如果将来关于数据格式的业务要求发生变化,您只需在一个地方更改代码。

合并代码库

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

GetLatestNewsWithAuthorsUseCase 依赖于数据层中的两个不同的代码库类:NewsRepository 和 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 列表中的所有项;因此,即使数据层是主线程安全的,此工作也不会阻止主线程,因为您并不知道它会处理多少项。正因如此,该用例使用默认调度程序将工作移到后台线程。

其他使用方

除了界面层之外,网域层还可以被其他类(如服务和 Application 类)重复使用。此外,如果其他平台(如 TV 或 Wear)与移动应用共享代码库,则它们的界面层还可以重复使用用例,以取得网域层的所有上述优势。

数据层访问权限限制

实现网域层时,还需要考虑应该仍然允许从界面层直接访问数据层,还是应该强制要求所有访问都必须通过网域层进行。

界面层无法直接访问数据层,而是必须通过网域层
图 4. 显示系统拒绝界面层访问数据层的依赖关系图。

设置此限制的好处之一是,这会阻止界面绕过网域层逻辑,例如,当您对针对数据层的每个访问请求执行分析日志记录时。

不过,潜在的重要缺陷在于,您不得不添加相关用例,即使只是对数据层进行简单的函数调用时也是如此,而这可能会增加复杂性,却几乎没有什么好处。

一种很好的方法是仅在需要时才添加用例。如果您发现界面层几乎完全通过用例访问数据,那么仅以这种方式访问数据可能是合理的。

最终,是否限制对数据层的访问权限取决于您的具体代码库,以及您倾向于采用更严格的规则还是更灵活的方法。

测试

测试网域层时,请遵循通用测试指南。对于其他界面测试,开发者通常使用虚构代码库,因此在测试网域层时,最好使用虚构代码库。

示例

以下 Google 示例演示了如何使用网域层。您不妨浏览一下它们,了解如何实际运用本指南: