How to test a private function, in Dart?

在Dart中，私有函数通常以下划线 _ 开头，并仅在定义它们的库中可见。由于它们的访问限制，直接测试私有函数可能有些困难。然而，有几种方法可以间接地测试这些私有函数，确保代码的质量和功能性。

方法 1：通过公共方法测试

通常，私有函数被设计为辅助函数，供库内的其他公共函数使用。因此，一个有效的测试方法是通过调用使用这些私有函数的公共方法来间接测试它们。这种方法能确保私有函数在实际使用场景中的表现。

示例：

假设你有一个类 Account，其中包含一个私有方法 _calculateInterest()，它被一个公共方法 updateBalance() 调用。

dart
class Account {
  double _balance;

  Account(this._balance);

  void updateBalance(double annualRate) {
    double interest = _calculateInterest(annualRate);
    _balance += interest;
  }

  double _calculateInterest(double rate) {
    return _balance * (rate / 100);
  }
}

在这种情况下，你可以通过测试 updateBalance() 方法来间接测试 _calculateInterest() 方法是否正确计算利息。

dart
import 'package:test/test.dart';
import 'account.dart'; // 导入Account类

void main() {
  test('Test updateBalance method', () {
    final account = Account(1000.0);
    account.updateBalance(5); // 5%年利率
    expect(account.balance, 1050.0);  // 预期余额为1050.0
  });
}

方法 2：使用 @visibleForTesting 注解

如果确实需要直接测试私有函数，可以考虑使用 Dart 的 @visibleForTesting 注解。这使得私有函数在测试环境下可见，而在其他环境下依然保持私有。

首先，需要在项目中包含 meta 包：

yaml
dependencies:
  meta: ^1.7.0

然后，在你的代码中使用注解：

dart
import 'package:meta/meta.dart';

class Account {
  double _balance;

  Account(this._balance);

  @visibleForTesting
  double calculateInterest(double rate) {
    return _balance * (rate / 100);
  }
}

现在，尽管 calculateInterest 函数标记为私有，你仍可以在测试文件中直接访问它：

dart
import 'package:test/test.dart';
import 'account.dart';

void main() {
  test('Test calculateInterest method', () {
    final account = Account(1000.0);
    double interest = account.calculateInterest(5);
    expect(interest, 50.0);
  });
}

总结

对于私有函数的测试，推荐的做法是通过其影响的公共接口进行间接测试。这不仅遵守了封装的原则，也确保了功能在实际使用场景中的正确性。如果必须直接测试，可以考虑使用 @visibleForTesting 注解，但这种做法应当谨慎使用，以避免破坏封装性。