Flutter未知功能插件toor的使用（注意：由于介绍为undefined，以下基于插件名进行合理推测）

🌱 什么是Toor

Toor 是一个用于管理服务定位器的库，它使服务定位器在编译时安全且易于管理。

目录

• 🚀 入门
• ✨ Toor 详细介绍
  • 定位器类型
    • 工厂
    • 懒单例
    • 可变懒单例
    • 异步工厂
    • 带参数的工厂
  • 高级用法
    • 重置懒单例
    • 重置所有懒单例
    • 创建新的Toor实例
    • 使用顶级函数注册定位器
• 🧪 使用Toor进行测试

🚀 入门

首先，在项目中的某个地方定义你的依赖项。所有的全局和静态变量默认都是惰性的，因此你不必担心注册未使用的对象会消耗内存。

final toor = Toor.instance;

final httpClientSingleton = toor.registerLazySingleton<IHttpClient>(
  DioHttpClientImpl.new,
);

final authRepositoryFactory = toor.registerFactory<IAuthRepository>(
  () => AuthRepositoryImpl(httpClient: httpClientSingleton()),
);

之后，你可以安全地访问你注册的工厂或懒单例：

void authenticate(String email, String password) {
  authRepositoryFactory().authenticate(email, password);
}

✨ Toor 详细介绍

定位器类型

Toor 目前支持两种类型的对象：工厂和懒单例。

工厂

工厂是在每次获取时创建的定位器。

使用 Toor.registerFactory 创建工厂定位器：

final toor = Toor.instance;

final authRepositoryFactory = toor.registerFactory<IAuthRepository>(
  AuthRepositoryImpl.new,
);

懒单例

懒单例是在第一次调用时创建的定位器。第一次创建的对象将在后续每次获取时返回。

使用 Toor.registerLazySingleton 创建懒单例定位器：

final toor = Toor.instance;

final credentialManager = toor.registerLazySingleton<ICredentialManager>(
  CredentialManagerImpl.new,
);

可变懒单例

在某些情况下，你可能需要你的单例是可变的（例如，多环境）。Toor 提供了可变单例。使用 Toor.registerMutableLazySingleton 创建可变懒单例，并使用 put 方法更改其值：

final toor = Toor.instance;

final appFlavor = toor.registerMutableLazySingleton(
  create: () => Flavor.dev,
);
print(appFlavor()); // Flavor.dev

appFlavor.put(Flavor.prod);

print(appFlavor()); // Flavor.prod

当调用 reset 时，可变懒单例将被重置为其初始值。

额外的清理代码与 onDispose

Toor 允许你在注册懒单例时传递一个可选的 onDispose 函数，以便进行一些清理操作（例如，关闭套接字连接、取消订阅流等）。onDispose 还可以访问当前单例的值。使用方法如下：

final toor = Toor.instance;

final permissionManager = toor.registerLazySingleton<IPermissionManager>(
  PermissionManagerImpl.new,
  onDispose: (manager) {
    manager.dispose();
  },
);

异步工厂

异步工厂是在每次获取时异步创建的定位器。

使用 Toor.registerFactoryAsync 创建异步工厂定位器：

final toor = Toor.instance;

final dataPersisterFactory = toor.registerFactoryAsync<IDataPersister>(
  () async => SharedPreferencesDataPersister(
    sharedPreferences: await SharedPreferences.getInstance(),
  ),
);

等待工厂的创建并使用它：

final dataPersister = await dataPersisterFactory();
dataPersister.saveData('big');

带参数的工厂

你还可以创建接受1个或2个参数的工厂：

final toor = Toor.instance;

final personFactory = toor.registerFactoryWithParam<Person, String>(
  (name) => Person(name),
);

final vehicleFactory = toor.registerFactoryWithTwoParams<Vehicle, String, int>(
  (name, productionYear) => Vehicle(name, productionYear),
);

class Person {
  const Person(this.name);

  final String name;
}

class Vehicle {
  const Vehicle(this.name, this.productionYear);

  final String name;
  final int productionYear;
}

void main() {
  // 两者都是编译时安全的，并且知道类型
  final driver = personFactory('Doc');
  final vehicle = vehicleFactory('DeLorean', 1981);
}

异步工厂也支持通过 registerFactoryAsyncWithParam 和 registerFactoryAsyncWithTwoParams 创建。

高级用法

重置懒单例

你可以通过 reset 方法重置懒单例。这将删除当前对象并在下次调用时创建一个新的对象。

final toor = Toor.instance;

String value = 'Initial';

final lazySingleton = toor.registerLazySingleton<String>(
  () => value,
);

// 即使我们在这里更改了 `value` 变量，
// `lazySingleton` 的值仍将是 'Initial'。
value = 'Changed';

print(lazySingleton()); // 'Initial'

// 一旦我们重置 `lazySingleton`，它在下次调用时的值将为 'Changed'。
lazySingleton.reset();

print(lazySingleton()); // 'Changed'

重置所有懒单例

Toor 允许你通过其实例上的 reset 方法一次性重置所有懒单例。这将调用每个懒单例的 reset 方法。

final toor = Toor.instance;

String value = 'Initial';

final lazySingleton = toor.registerLazySingleton<String>(
  () => value,
);

value = 'Changed';

print(lazySingleton()); // 'Initial'

// 一旦我们重置 `toor`，所有通过 `toor.registerLazySingleton` 注册的懒单例都将被重置。
toor.reset();

print(lazySingleton()); // 'Changed'

创建新的Toor实例

你可能希望创建多个独立的 Toor 实例。Toor.instance 获取器将返回默认实例，但你不必使用它。你可以通过 Toor.newInstance() 创建新的 Toor 实例。你可能希望这样做以重置与特定域相关的懒单例（例如，在登出时重置所有持有用户数据的单例）。

final authToor = Toor.newInstance();
final analyticsToor = Toor.newInstance();

final credentialManager = authToor.registerLazySingleton<ICredentialManager>(
  CredentialManagerImpl.new,
);

final sessionRecorder = authToor.registerLazySingleton<ISessionRecorder>(
  SessionRecorderImpl(upload: false),
);

void logout() {
  // `credentialManager` 将被重置，但 `sessionRecorder` 不会被重置，因为它注册在 `analyticsToor` 而不是 `authToor` 中。
  authToor.reset();
}

使用顶级函数注册定位器

Toor 提供了几种在全局 Toor 实例中注册定位器的方法：

// 你可以使用 `Toor.instance` 获取器，然后调用 `registerLazySingleton` 或其他方法。
final toor = Toor.instance;

final httpClientSingleton = toor.registerLazySingleton<IHttpClient>(
  DioHttpClientImpl.new,
);

// 或者你可以使用同名的顶级函数，它基本上会在 `Toor.instance` 上调用该方法。
final httpClientSingleton = registerLazySingleton<IHttpClient>(
  DioHttpClientImpl.new,
);

🧪 使用Toor进行测试

有时，你需要在测试中创建不同的对象（例如，模拟对象）。使用 Toor 有以下两种方法实现：

1. 根据某些变量或其他 Toor 单例决定要注册的对象（例如，多环境）：

final toor = Toor.instance;

final authManager = toor.registerLazySingleton<IAuthManager>(
  flavor.isTesting ? MockAuthManager() : AuthManagerImpl(),
);

1. 通过 toor_test 中的 override 方法覆盖已注册的对象。override 方法被注解为 visibleForTesting，因为它仅用于测试：

// dependencies.dart
import 'package:toor/toor.dart';

final toor = Toor.instance;

final authManager = toor.registerLazySingleton<IAuthManager>(
  AuthManagerImpl.new,
);

// app_test.dart
import 'package:toor/toor_test.dart';

void main() {
  setUpAll(() {
    authManager.override(() => MockAuthManager());
  });
}

希望这些信息对你有所帮助！如果你有任何问题或需要进一步的帮助，请随时提问。