内容
description bug_report

Flutter 测试中的插件

内容

几乎所有Flutter 插件都有两部分

  • Dart 代码，它提供您的代码调用的 API。
  • 使用特定于平台（或“主机”）的语言（例如 Kotlin 或 Swift）编写的代码，该代码实现这些 API。

实际上，本机（或主机）语言代码将插件包与标准包区分开来。

构建和注册插件的主机部分是 Flutter 应用程序构建过程的一部分，因此插件仅在您的代码在您的应用程序中运行时才起作用，例如使用 flutter run 或运行集成测试时。在运行Dart 单元测试或小部件测试时，主机代码不可用。如果您要测试的代码调用任何插件，则通常会导致以下错误

MissingPluginException(No implementation found for method someMethodName on channel some_channel_name)

在对使用插件的代码进行单元测试时，有几种选择可以避免此异常。以下解决方案按优先顺序列出。

包装插件

在大多数情况下，最佳方法是在您自己的 API 中包装插件调用，并提供一种模拟您自己的 API 的方法。

这样做有几个优点

  • 如果插件 API 发生变化，您无需更新测试。
  • 您只测试自己的代码，因此您的测试不会因您正在使用的插件的行为而失败。
  • 无论插件如何实现，甚至对于非插件包依赖项，您都可以使用相同的方法。

模拟插件的公共 API

如果插件的 API 已基于类实例，您可以直接模拟它，但需要注意以下事项

  • 如果插件使用非类函数或静态方法，则此方法不起作用。
  • 当插件 API 发生变化时，需要更新测试。

模拟插件的平台接口

如果插件是联合插件，它将包含一个平台接口，允许注册其内部逻辑的实现。您可以注册该平台接口实现的模拟，而不是公共 API，但需要注意以下事项

  • 如果插件不是联合插件，则此方法不起作用。
  • 您的测试将包含插件代码的一部分，因此插件行为可能会给您的测试带来问题。例如，如果插件将文件作为内部缓存的一部分进行写入，则您的测试行为可能会根据您之前是否运行过测试而改变。
  • 当平台接口发生变化时，可能需要更新测试。

需要这样做的一个示例是模拟您依赖的包而不是您自己的代码所使用的插件的实现，因此您无法更改其调用方式。但是，如果可能，您应该模拟使用插件的依赖项。

模拟平台通道

如果插件使用平台通道，您可以使用TestDefaultBinaryMessenger模拟平台通道。仅当由于某种原因上述方法均不可用时才应使用此方法，因为它有几个缺点

  • 只能模拟使用平台通道的实现。这意味着，如果某些实现不使用平台通道，则您的测试在某些平台上运行时将意外地使用真实实现。
  • 平台通道通常是插件的内部实现细节。即使在插件的 bug 修复更新中，它们也可能发生重大变化，从而意外地破坏您的测试。
  • 联合插件的每个实现中的平台通道可能不同。例如，您可能设置模拟平台通道以使测试在 Windows 机器上通过，然后发现如果在 macOS 或 Linux 上运行，它们将失败。
  • 平台通道不是强类型的。例如，方法通道经常使用字典，而您必须阅读插件的实现才能知道键字符串和值类型是什么。

由于这些限制，TestDefaultBinaryMessenger 主要用于插件实现的内部测试，而不是使用插件的代码测试。

您可能还想查看测试插件。