Flutter 测试中的插件
几乎所有Flutter 插件都包含两部分
- Dart 代码,提供您的代码调用的 API。
- 用特定于平台(或“宿主”)的语言编写的代码(例如 Kotlin 或 Swift),用于实现这些 API。
实际上,原生(或宿主)语言代码将插件包与标准包区分开来。
构建和注册插件的宿主部分是 Flutter 应用程序构建过程的一部分,因此插件仅在您的代码在应用程序中运行时才有效,例如使用 flutter run
或运行集成测试时。运行Dart 单元测试或widget 测试时,宿主代码不可用。如果您正在测试的代码调用了任何插件,这通常会导致如下错误
MissingPluginException(No implementation found for method someMethodName on channel some_channel_name)
当对使用插件的代码进行单元测试时,有几种方法可以避免此异常。以下解决方案按推荐顺序排列。
封装插件
#在大多数情况下,最好的方法是将插件调用封装到您自己的 API 中,并提供一种在测试中模拟您自己的 API 的方法。
这有几个优点
- 如果插件 API 更改,您无需更新测试。
- 您只测试自己的代码,因此您的测试不会因所用插件的行为而失败。
- 无论插件如何实现,甚至对于非插件包依赖项,您都可以使用相同的方法。
模拟插件的公共 API
#如果插件的 API 已经基于类实例,您可以直接模拟它,但有以下注意事项
- 如果插件使用非类函数或静态方法,这将不起作用。
- 当插件 API 更改时,测试需要更新。
模拟插件的平台接口
#如果插件是联合插件,它将包含一个允许注册其内部逻辑实现的平台接口。您可以注册该平台接口实现的模拟,而不是公共 API,但有以下注意事项
- 如果插件不是联合的,这将不起作用。
- 您的测试将包含插件代码的一部分,因此插件行为可能会给您的测试带来问题。例如,如果插件将文件作为内部缓存的一部分写入,则您的测试行为可能会根据您之前是否运行过测试而改变。
- 当平台接口更改时,测试可能需要更新。
这可能必要的一个例子是模拟您所依赖的包使用的插件实现,而不是您自己的代码,这样您就无法更改其调用方式。但是,如果可能,您应该模拟使用插件的依赖项。
模拟平台通道
#如果插件使用平台通道,您可以使用TestDefaultBinaryMessenger
来模拟平台通道。仅当由于某种原因上述方法均不可用时才应使用此方法,因为它有几个缺点
- 只有使用平台通道的实现才能被模拟。这意味着如果某些实现不使用平台通道,您的测试在某些平台上运行时将意外地使用真实实现。
- 平台通道通常是插件的内部实现细节。即使是插件的错误修复更新也可能大幅改变它们,从而意外地破坏您的测试。
- 联合插件的每个实现中的平台通道可能不同。例如,您可能设置模拟平台通道以使测试在 Windows 机器上通过,然后发现它们在 macOS 或 Linux 上运行时失败。
- 平台通道不是强类型的。例如,方法通道通常使用字典,您必须阅读插件的实现才能知道键字符串和值类型是什么。
由于这些限制,TestDefaultBinaryMessenger
主要用于插件实现的内部测试,而不是使用插件的代码的测试。
您可能还想查看测试插件。