Flutter诊断工具插件witch_doctor的使用

Flutter诊断工具插件witch_doctor的使用

By: CenturyBoys

巫医 (Witch-doctor)

巫医是一个依赖注入的代码生成器。

主要概念：

• 容器：如何注册接口、实现、注入类型、params 和 namedParams，这些都通过其名称进行作用域划分。
• 生成器：这将为可能的可注入类创建所有必要的基础代码。

生成器 (Generator)

此库需要为可能的可注入类生成基础代码。巫医插件拥有自己的构建器 witchDoctorFactory，它将使用注解 @Antibiotic() 来生成注入代码。

你需要在你的 dev_dependencies 中添加 source_gen 和 build_runner，并运行 dart pub get。

在你的类文件中，你需要添加部分导入，并注解你的类。

part 'your_class_file_name.g.dart';

abstract class Interface {
  int sum();
}

@Antibiotic()
class Impl extends Interface {
  int a;
  int b;

  Impl(this.a, this.b);

  @override
  int sum() {
    return a + b;
  }
}

接下来，生成代码，为此运行 dart run build_runner build。

现在，如果一切顺利，你将在当前文件路径中找到一个名为 your_class_file_name.g.dart 的新文件，其中包含类 YourClassNamePythonPoison。

容器 (Container)

你必须使用容器来注册你的注入。方法 getContainer 将提供一个带有一个注册方法的容器。容器按名称进行作用域划分，如果没有提供名称，它们将使用默认容器。以下是签名：

class TopHatContainer {
  void register<T>(
      InjectionType injectionType,
      PythonPoison instanceCallback,
      [
        List<dynamic> params = const [],
        Map<Symbol, dynamic>? namedParams = const {}
      ]
      );
}

• 接口和实现的继承关系将会被检查，如果有任何问题会抛出异常。PythonPoison 类必须是从类型 T 继承的扩展类。
• 注入类型将会被检查，如果有任何问题会抛出异常。有两种类型的注入：单例（singleton）和工厂（factory）。单例类型对于每次注入都会返回相同的实例，而工厂类型则会为每次注入返回一个新的实例。

你可以创建一个容器并注册它，然后下一步是什么？

要使用容器，你需要使用 load 方法加载它。当前容器是一个加载容器的扁平聚合，这意味着如果你有两个具有相同抽象类但不同实现的容器，并且你加载了两个容器，最后加载的容器将会覆盖之前的容器。

import 'package:witch_doctor/src/witch_doctor_container.dart';
import 'package:witch_doctor/witch_doctor.dart';

part 'your_class_file_name.g.dart';

abstract class InterfaceA {
  int sum();
}

@Antibiotic()
class ImplA extends InterfaceA {
  int a;
  int b;

  ImplA(this.a, this.b);

  @override
  int sum() {
    return a + b;
  }
}

void main() {
  // 创建带有名称 "container_name" 的容器
  TopHatContainer container = WitchDoctor.getContainer(name: "container_name");

  // 注册 `<Interface>` 传递注入类型、pythonPoison、默认参数和命名参数
  container.register<InterfaceA>(InjectionType.factory, ImplAPythonPoison(), [10], {"b": 20});

  // 加载容器
  WitchDoctor.load(name: "container_name");
}

解析 (Resolve)

巫医可以在任何地方被调用以解析依赖项。为此，请使用 resolve 方法。抽象类的签名将被检查，巫医将搜索已注册的接口以注入依赖项。

class WitchDoctor {
  static T resolve<T>();
}

示例代码

import 'package:witch_doctor/witch_doctor.dart';

import 'src/impl.dart';
import 'src/interface.dart';

void main() {
  // 创建带有名称 "container_name" 的容器
  TopHatContainer container = WitchDoctor.getContainer(name: "container_name");

  // 注册 `<Interface, Implementation>` 传递注入类型和默认参数
  container.register<Interface>(
      InjectionType.factory, ImplPythonPoison(), [10, 20], {});

  // 加载容器
  WitchDoctor.load(name: "container_name");

  // 使用接口解析实例
  Interface instance = WitchDoctor.resolve<Interface>();

  // 调用实现中的抽象方法 sum
  int value = instance.sum();

  print('value: $value');
}