在隔离内使用类的特定实例

Question

我通过compute() 方法使用隔离来从 API 获取、解析和排序数据（大约 10k 条目）。

我的方法getAllCards() 定义在一个类YgoProRepositoryImpl 中，该类有一个我的远程数据源类YgoProRemoteDataSource 的实例，在这个类中定义了调用我的API 的方法（这是一个简单的GET 请求） .

代码示例

ygopro_repository_impl.dart

class YgoProRepositoryImpl implements YgoProRepository {
  final YgoProRemoteDataSource remoteDataSource;

  // ...

  YgoProRepositoryImpl({
    required this.remoteDataSource,
    // ...
  });

  // ...

  static Future<List<YgoCard>> _fetchCards(_) async {
    // As I'm inside an isolate I need to re-setup my locator
    setupLocator();
    final cards = await sl<YgoProRemoteDataSource>()
        .getCardInfo(GetCardInfoRequest(misc: true));
    cards.sort((a, b) => a.name.compareTo(b.name));
    return cards;
  }

  @override
  Future<List<YgoCard>> getAllCards() async {
    final cards = await compute(_fetchCards, null);
    return cards;
  }

  // ...
}

service_locator.dart

import 'package:get_it/get_it.dart';

import 'data/api/api.dart';
import 'data/datasources/remote/ygopro_remote_data_source.dart';
import 'data/repository/ygopro_repository_impl.dart';
import 'domain/repository/ygopro_repository.dart';

final sl = GetIt.instance;

void setupLocator() {
  // ...

  _configDomain();
  _configData();

  // ...

  _configExternal();
}

void _configDomain() {
  //! Domain
  
  // ...

  // Repository
  sl.registerLazySingleton<YgoProRepository>(
    () => YgoProRepositoryImpl(
      remoteDataSource: sl(),
      // ...
    ),
  );
}

void _configData() {
  //! Data
  // Data sources
  sl.registerLazySingleton<YgoProRemoteDataSource>(
    () => YgoProRemoteDataSourceImpl(sl<RemoteClient>()),
  );

  // ...
}

void _configExternal() {
  //! External
  sl.registerLazySingleton<RemoteClient>(() => DioClient());
  
  // ...
}

代码运行正常，但 getAllCards() 不可测试，因为我无法在我的隔离内部注入 YgoProRemoteDataSource 的模拟类，因为它总是会从我的服务定位器获取引用。

如何不依赖我的服务定位器将YgoProRemoteDataSource 注入我的隔离内部并使getAllCards() 可测试？

Answer 1

做了更认真的尝试，请看repo：https://github.com/maxim-saplin/compute_sl_test_sample

基本上就 Flutter/Dart 的当前状态而言，您既不能传递闭包，也不能跨隔离边界传递包含闭包的类（然而，当 Dart 中的新功能登陆 Flutter https://github.com/dart-lang/sdk/issues/46623#issuecomment-916161528 时，这可能会改变）。这意味着如果您不希望任何测试代码成为发布版本的一部分，则您无法传递服务定位器（包含闭包）或欺骗隔离以通过闭包实例化定位器的测试版本。然而，您可以轻松地将数据源实例传递给隔离，以便在其入口点作为参数使用。

此外，我认为要求隔离来重建整个服务定位器是没有意义的。 compute() 背后的整个想法是创建一个短的离开隔离，运行计算，返回结果并终止隔离。初始化定位器是一种开销，最好避免。此外，compute() 的整个概念似乎与应用程序的其余部分尽可能隔离。

您可以克隆存储库并运行测试。关于样本的几句话：

• 基于 Flutter 计数器入门应用
• lib/classes.dart 重新创建您提供的代码 sn-p
• test/widget_test.dart 验证 YgoProRepositoryImpl 在隔离运行假数据源版本时工作正常
• YgoProRemoteDataSourceImpl 模仿真实实现，位于 classes.dart 和 YgoProRemoteDataSourceFake 模仿测试版本
• 在 flutter_test 下运行隔离需要将测试主体包装在 tester.runAsync() 中，以便实时异步执行（而不是测试默认使用的假异步并依赖抽水来推进测试时间）。在这种模式下运行测试可能会很慢（实际需要 0.5 秒的等待时间），以不使用 compute() 或未在很多测试中测试的方式构建测试是合理的

classes.dart

import 'package:flutter/foundation.dart';
import 'package:get_it/get_it.dart';

final sl = GetIt.instance;

class YgoCard {
  YgoCard(this.name);

  final String name;
}

abstract class YgoProRemoteDataSource {
  Future<List<YgoCard>> getCardInfo();
}

class YgoProRemoteDataSourceImpl extends YgoProRemoteDataSource {
  @override
  Future<List<YgoCard>> getCardInfo() {
    return Future.delayed(Duration.zero,
        () => List.generate(5, (index) => YgoCard("Impl $index")));
  }
}

abstract class YgoProRepository {
  Future<List<YgoCard>> getAllCards();
}

class YgoProRepositoryImpl implements YgoProRepository {
  final YgoProRemoteDataSource remoteDataSource;

  YgoProRepositoryImpl({
    required this.remoteDataSource,
  });

  static Future<List<YgoCard>> _fetchCards(
      YgoProRemoteDataSource dataSource) async {
    final cards = await dataSource.getCardInfo();
    cards.sort((a, b) => a.name.compareTo(b.name));
    return cards;
  }

  @override
  Future<List<YgoCard>> getAllCards() async {
    final cards = await compute(_fetchCards, remoteDataSource);
    return cards;
  }
}

void setupLocator() {
  sl.registerLazySingleton<YgoProRepository>(
    () => YgoProRepositoryImpl(
      remoteDataSource: sl(),
    ),
  );

  sl.registerLazySingleton<YgoProRemoteDataSource>(
    () => YgoProRemoteDataSourceImpl(),
  );
}

widget_test.dart

import 'package:flutter_test/flutter_test.dart';
import 'package:test_sample/classes.dart';

import 'package:test_sample/main.dart';

void main() {
  setUpAll(() async {
    setupFakeLocator();
  });

  testWidgets('Test mocked data source', (WidgetTester tester) async {
    // Wrapping with runAync() is required to have real async in place
    await tester.runAsync(() async {
      await tester.pumpWidget(const MyApp());
      // Let the isolate spawned by compute() complete, Debug run might require longer wait
      await Future.delayed(const Duration(milliseconds: 500));
      await tester.pumpAndSettle();
      expect(find.text('Fake 9'), findsOneWidget);
    });
  });
}

class YgoProRemoteDataSourceFake extends YgoProRemoteDataSource {
  @override
  Future<List<YgoCard>> getCardInfo() {
    return Future.delayed(Duration.zero,
        () => List.generate(10, (index) => YgoCard("Fake $index")));
  }
}

void setupFakeLocator() {
  sl.registerLazySingleton<YgoProRepository>(
    () => YgoProRepositoryImpl(
      remoteDataSource: sl(),
    ),
  );

  sl.registerLazySingleton<YgoProRemoteDataSource>(
    () => YgoProRemoteDataSourceFake(),
  );
}

Answer 2

您真的需要测试getCards() 函数吗？ 你在那里真正测试什么？ compute 有效，当然希望 Dart SDK 团队对此进行测试。

剩下的_fetchCards() 和setupLocator() 也不需要测试，这是您的测试逻辑的先决条件。无论如何，您都想更改测试的设置。

所以你真正想要测试的是获取和排序。将其重组为可测试的静态函数并预先设置您的定位器。在上面打上@visibleForTesting注解。

顺便说一句，根据您在服务定位器中绑定的数量，这对于之后仅使用一个存储库可能会产生巨大的开销。

例子：

  static Future<List<YgoCard>> _fetchCards(_) async {
    // As I'm inside an isolate I need to re-setup my locator
    setupLocator();
    return reallyFetchCards();
  }

  @visibleForTesting
  static Future<List<YgoCard>> reallyFetchCards() async {
    final cards = await sl<YgoProRemoteDataSource>()
        .getCardInfo(GetCardInfoRequest(misc: true));
    cards.sort((a, b) => a.name.compareTo(b.name));
    return cards;
  }

  @override
  Future<List<YgoCard>> getAllCards() async {
    final cards = await compute(_fetchCards, null);
    return cards;
  }

测试：

// Setup SL and datasource
...

final cards = await YgoProRepositoryImpl.reallyFetchCrads();

// Expect stuff

Answer 3

据我了解，您有两个选择，要么通过参数注入 static Future<List<YgoCard>> _fetchCards(_) async 所需的依赖项，要么在定位器本身中模拟对象。我会选择第一个选项，并有类似的东西：

  static Future<List<YgoCard>> _fetchCards(_,YgoProRemoteDataSource remote) async {
    // No need to set up locator as you passed the needed dependencies
    // setupLocator();
    final cards = await remote
        .getCardInfo(GetCardInfoRequest(misc: true));
    cards.sort((a, b) => a.name.compareTo(b.name));
    return cards;
  }

  @override
  Future<List<YgoCard>> getAllCards() async {
    final cards = await compute(_fetchCards, null);
    return cards;
  }

编辑

刚刚更新了答案，因为在这里编辑它比在 cmets 中更容易...

嗯，我能想到的唯一解决方法是将 setupLocator() 函数作为参数传递给 YgoProRepositoryImpl 类：

final Function setupLocator;
  YgoProRepositoryImpl({
    required this.remoteDataSource,
required this.setupLocator;
    // ...
  });

这样你可以传递一个模拟来设置你的模拟类或你的service_locator.dart 的真实setupLocator。这可能不太优雅。但它应该使它可测试，因为现在你可以模拟设置并且它不是在函数中硬编码