Flutter依赖注入插件qinject的使用

Flutter依赖注入插件qinject的使用

Qinject简介

Qinject是一个快速、灵活的Dart和Flutter应用程序开发的IoC（控制反转）库。它可以帮助您轻松地使用依赖注入（DI）和服务定位器（Service Locator）方法来开发应用程序。

主要特性

• 支持依赖注入（DI）
• 支持服务定位器
• 隐式依赖链解析；无需定义和维护“依赖于”关系
• 简单但极其灵活的依赖注册和解析机制
• 可以注册任何类型的依赖，从Flutter小部件和函数到简单的类
• 简单但强大的单元测试工具

安装

Qinject包可以在pub.dev上找到，并可以通过以下命令安装：

dart pub add qinject

或者

flutter pub add qinject

快速开始

下面的例子展示了如何在一个基本应用中同时使用DI和服务定位器模式，以及单例和解析器依赖注册。这些主题在本文档后面会有更详细的介绍。

main() {
  // 使用Qinject实例支持DI，通过将其作为构造函数参数传递给定义依赖项的类
  final qinjector = Qinject.instance();

  // 注册一个单例
  Qinject.registerSingleton(() => stdout);
  
  // 注册一个解析器
  Qinject.register((_) => DateTimeReader());
  
  // 注册Greeter类，需要Qinjector实例
  Qinject.register((_) => Greeter(qinjector));

  // 解析Greeter实例并调用其greet方法
  Qinject.use<void, Greeter>().greet();
}

class Greeter {
  // 使用服务定位器风格的解析
  final Stdout _stdout = Qinject.use<Greeter, Stdout>();

  // 使用DI风格的依赖解析
  final DateTimeReader _dateTimeReader;

  Greeter(Qinjector qinjector)
      : _dateTimeReader = qinjector.use<Greeter, DateTimeReader>();

  void greet() => _stdout.writeln("Right now it's ${_dateTimeReader.now()}");
}

class DateTimeReader {
  DateTime now() => DateTime.now();
}

依赖注册

有两种高层次的依赖注册类型：单例（Singleton）和解析器（Resolver）。单例在第一次解析时被评估一次，然后在应用程序的生命周期内返回相同的实例。

单例注册示例如下：

Qinject.registerSingleton(() => MyClass());

当use<TConsumer, MyClass>()首次调用时，将返回一个新的MyClass实例。随后调用use<TConsumer, MyClass>()时，将返回同一原始实例。

依赖使用

所有类型的依赖都通过相同的方法use<TConsumer, TDependency>进行解析。这可以从Qinject服务定位器或通过注入到类中的Qinjector实例调用。两种方法可以互换使用，因为任何已注册的依赖都可以通过任一路由访问。

使用服务定位器

服务定位器是一种简单地解耦依赖的模式。其使用基于全局可访问的服务定位器实例，在Qinject的情况下，这是Qinject类型本身，它公开了一个静态的use<TConsumer, TDependency>方法。

可以从任何可以访问Qinject类型的任何地方以如下方式解析依赖：

final DependencyType _dependency = Qinject.use<ConsumerType, DependencyType>();

对于一些复杂的应用程序，使用服务定位器可能会使测试变得困难，特别是在并发执行逻辑时。这是因为单一的全局实例需要配置适合给定测试运行的所有测试的测试替身，或者反复配置和清理。对于这样的应用程序，DI可能是更好的选择。

使用DI（依赖注入）

采用DI时，类在其构造函数中声明其依赖项，并暴露这些变量的setter。这些变量由外部实体设置，该实体负责选择、创建和管理这些抽象依赖类型的具体实现的生命周期。

下面是一个示例，说明了如何在构造函数中声明依赖项并通过注入的Qinjector实例填充它们。

main() {
    // 获取Qinjector实例
    final qinjector = Qinject.instance();

    // 注册ConsumerClass及其依赖项
    Qinject.register((_) => ConsumerClass(qinjector));
    Qinject.register((_) => DependencyA(qinjector));
    Qinject.register((_) => DependencyB());
    Qinject.register((_) => DependencyC(qinjector));
    
    final consumerClass = Qinject.use<void, ConsumerClass>(); // 解析ConsumerClass实例

    // 对consumerClass进行操作
}

class ConsumerClass {
  final DependencyA _dependencyA;
  final DependencyB _dependencyB;
  final DependencyC _dependencyC;

  ConsumerClass(Qinjector qinjector)
      : _dependencyA = qinjector.use<ConsumerClass, DependencyA>(),
        _dependencyB = qinjector.use<ConsumerClass, DependencyB>(),
        _dependencyC = qinjector.use<ConsumerClass, DependencyC>();

  // 对依赖项进行操作
}

单元测试与Qinjector

可以使用TestQinjector实例注册依赖项的测试替身，以帮助进行单元测试。TestQinjector实例可以代替默认的Qinjector实例传递给依赖项消费者。

例如，如果测试上述的Qinjector应用程序，则可以定义如下：

main() {
    test('ConsumerClass behaves as expected', () {
        // 创建一个TestQinjector实例，实现Qinjector接口
        final qinjector = TestQinjector();

        // 在TestQinjector实例上注册存根或模拟
        qinjector.registerTestDouble<DependencyA>((_) => DependencyAStub());
        qinjector.registerTestDouble<DependencyB>((_) => DependencyBMock()); 
        qinjector.registerTestDouble<DependencyC>((_) => DependencyCStub());
        
        final consumerClass = ConsumerClass(qinjector); // 使用TestQInjector创建ConsumerClass实例

        // 对consumerClass进行断言
    });
}

示例代码

以下是从示例项目中提取的主要文件示例：

import 'dart:io';

import 'package:qinject/qinject.dart';

import 'app.dart';
import 'datetime_reader.dart';
import 'greeter.dart';
import 'name_formatter.dart';

main() {
  final qinjector = Qinject.instance();

  // 注册一个Transient Resolver
  Qinject.register((_) => NameFormatter());

  // 注册一个Factory Resolver
  Qinject.register((_) => (String target) => Greeter(qinjector, target));

  // 注册一个Type Sensitive Resolver
  Qinject.register((Type consumer) => consumer.runtimeType == Greeter
      ? DateTimeReaderNow()
      : DateTimeReaderTomorrow());

  // 注册单例
  Qinject.registerSingleton(() => stdout);
  Qinject.registerSingleton(() => stdin);

  App(qinjector).run();
}