Flutter依赖注入插件inject_annotation的使用

编译时依赖注入

编译时依赖注入是一种在编译时而不是运行时管理应用程序依赖的技术。这提供了许多好处，包括提高性能、减少代码大小和更好的编译时错误检查。在Dart和Flutter中，编译时依赖注入通过使用@inject和@provides注解以及Component和Module类来实现。

入门指南

添加依赖

要在您的Dart或Flutter项目中使用此库，需要在pubspec.yaml文件中添加依赖：

// dart
$ dart pub add inject_annotation
$ dart pub add inject_generator build_runner --dev

// flutter
$ flutter pub add inject_annotation
$ flutter pub add inject_generator build_runner --dev

生成代码

要生成代码，需要运行构建工具：

// dart
$ dart run build_runner build

// flutter
$ flutter pub run build_runner build

Component

要在Dart或Flutter应用程序中使用编译时依赖注入，需要创建一个Component类。这是一个用@component或@Component([])（如果有模块）注解的抽象类。

在Component中，可以定义返回所需类实例的方法（例如，Repository get repository在下面的示例中）。

@component
abstract class MainComponent {
  static const create = g.MainComponent$Component.create;

  @inject
  Repository get repository;
}

注入类型

要将类型添加到依赖图中，可以用@inject注解其类。例如：

@inject
class Repository {
  const Repository(this.apiClient);

  final FakeApiClient apiClient;

  Future<String> getGreeting({required String name}) => apiClient.getGreeting(name: name);
}

注意，不能将@inject注解添加到第三方库中的类。

模块

模块是用@module注解的类。在那里，可以用@provides注解定义依赖。

用@provides注解的方法告诉如何提供类的实例。函数参数是该类型的依赖。

@module
class ApiModule {
  @provides
  @singleton
  FakeApiClient apiClient() => FakeApiClient();
}

然后可以在Component中包含该模块：

@Component([ApiModule])
abstract class MainComponent {
  static const create = g.MainComponent$Component.create;

  @inject
  Repository get repository;
}

单例

@singleton注解用于指示应仅创建所提供类型的单个实例并在整个应用程序中共享。这可以通过避免不必要的对象创建来帮助提高性能和减少内存使用。

要使用@singleton，只需将其作为注解添加到提供实例的方法中：

@module
class ApiModule {
  @provides
  @singleton
  FakeApiClient apiClient() => FakeApiClient();
}

常见问题

什么是编译时？

所有依赖注入都在编译时作为构建过程的一部分进行分析、配置和生成，并不依赖于任何运行时设置或配置（如使用dart:mirrors的反射）。这在代码大小和性能方面提供了最佳体验（几乎与手写代码相同），并且允许我们在编译时提供错误和警告，而不是依赖于运行时。

示例代码

import 'package:inject_annotation/inject_annotation.dart';

import 'main.inject.dart' as g;

Future<void> main() async {
  /// 创建一个 [MainComponent] 实例以访问依赖图。
  final mainComponent = g.MainComponent$Component.create();

  /// 使用仓库获取 "World" 的问候语。
  print(await mainComponent.repository.getGreeting(name: 'World'));
}

/// 访问依赖图的入口点。
/// [Component] 声明返回所需类型实例的属性。
@Component([ApiModule])
abstract class MainComponent {
  /// 创建 [MainComponent] 实例的工厂方法。
  static const create = g.MainComponent$Component.create;

  /// 返回一个 [Repository] 实例以供其他类使用。
  @inject
  Repository get repository;
}

/// [Repository] 依赖于 [FakeApiClient] 实例。
/// 其依赖项通过构造函数注入。
@inject
class Repository {
  /// 创建一个新的 [Repository] 实例，给定 [apiClient]。
  const Repository(this.apiClient);

  /// 由该类使用的 [FakeApiClient] 实例。
  final FakeApiClient apiClient;

  /// 返回包含给定名称问候消息的 [Future]。
  Future<String> getGreeting({required String name}) => apiClient.getGreeting(name: name);
}

/// [module] 声明如何获取特定类型的实例。
/// 对于无法使用 [inject] 注解的第三方库，模块是必需的。
@module
class ApiModule {
  /// 返回一个新的 [FakeApiClient] 实例以注入到其他类中。
  @provides
  @singleton
  FakeApiClient apiClient() => FakeApiClient();
}

/// 一个假的 API 客户端，返回给定名称的问候消息。
/// 在实际实现中，这通常是来自 Chopper 等库的客户端。
class FakeApiClient {
  /// 返回包含给定名称问候消息的 [Future]。
  Future<String> getGreeting({required String name}) => Future.value('Hello $name!');
}

以上代码展示了如何在Flutter项目中使用inject_annotation进行依赖注入。通过这种方式，可以更高效地管理和使用应用程序的依赖关系。