如何在 Dart 中测试私有函数？

Question

假设我在 dart 文件 hello.dart 中定义了一个私有函数：

_hello() {
  return "world";
}

我想在另一个文件中测试它mytest.dart：

library mytest;

import 'dart:unittest/unittest.dart';

main() {
  test('test private functions', () {
    expect(_hello(), equals("world"));
  }
}

但很遗憾，无法编译测试代码。但我确实需要测试那个私有的_hello 函数。有什么解决办法吗？

Answer 1

虽然我同意私有方法/类不应成为您的测试的一部分，但元数据包确实提供了一个 @visibleForTesting 属性，如果您尝试在其原始成员之外使用该成员，分析器会向您发出警告图书馆或测试。你可以这样使用它：

import 'package:meta/meta.dart';

@visibleForTesting
String hello() {
  return "world";
}

您的测试现在可以在没有错误或警告的情况下使用它，但如果其他人尝试使用它，他们会收到警告。

同样，关于这样做是否明智是另一个问题 - 通常，如果它是值得测试的东西，它就是值得公开的东西（或者它会通过你的公共接口进行测试，这才是真正重要的）。同时，您可能只想对您的私有方法/类进行严格的测试或测试驱动原则，所以 - Dart 让您这样做。

编辑添加：如果您正在开发一个库并且您的带有@visibleForTesting 的文件将被导出，那么您实际上是在添加公共 API。有人可以在关闭分析器的情况下使用它（或者只是忽略警告），如果您稍后将其删除，您可能会破坏它们。

Answer 2

一些人认为我们不应该直接测试私有：它应该通过公共接口进行测试。

遵循本指南的一个优点是您的测试将不依赖于您的实施。换种说法：如果你想改变你的私人而不改变你暴露给世界的东西，那么你就不必碰你的测试。

不过，根据这所学校的说法，如果您的 private 足够重要以证明单元测试的合理性，那么将它提取到一个新类中可能是有意义的。

将所有这些放在一起，您可以在这里做的是：

• 用这个hello公开的方法创建一个帮助类。然后，您可以轻松地对其进行单元测试
• 让您当前的类使用此帮助类的实例
• 测试依赖于_hello 的当前类的公共方法：如果此私有有错误，则应该被那些更高级别的测试捕获

Answer 3

建议不将方法/类设为私有，而是将要隐藏实现细节的代码移动到 lib/src 文件夹。 此文件夹被视为私有文件夹。
我在 fuchsia.dev 页面 this section 的“测试”下找到了这种方法。

如果您想向公众公开位于 src 文件夹中的那些私有方法/类，您可以将它们导出到您的 lib/main 文件中。

我尝试将我的一个库 A（项目是库）导入另一个库 B，但无法导入库 A 的 src 文件夹中的代码。 根据StackOverflow answer，仍然可以从库 B 中的 A 访问 src 文件夹。

来自dart documentation

如您所料，库代码位于 lib 目录下，并且对其他包是公开的。您可以根据需要在 lib 下创建任何层次结构。按照惯例，实现代码放在 lib/src 下。 lib/src 下的代码被认为是私有的；其他包应该永远不需要导入 src/.... 要将 lib/src 下的 API 公开，您可以从 lib 直接下的文件中导出 lib/src 文件。