Flutter注解生成插件auto_factory_annotation的使用

通过工厂方法实现编译时依赖注入，利用了source_gen包，从而使其在每个平台上都能正常工作。此方法的优点包括性能（无需反射）和完全可调试性，因为生成的源代码易于阅读且格式良好。

安装

要使用此包，你需要在pubspec.yaml文件的dev_dependencies部分添加auto_factory和build_runner，并在dependencies部分添加auto_factory包。

然后，运行pub run build_runner build以生成部分文件。

目录

• 基本用法
• 单例模式
• 提供者模式
• 示例

基本用法

为了使类成为依赖树的一部分，需要使用@Injectable()注解标记该类。库会通过创建新实例并将其所需依赖项注入默认构造函数来满足依赖关系。

请注意，注入仅在具有位置参数的默认构造函数上有效。查看示例目录。

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

// 使用@Injectable()注解标记类
@Injectable()
class Component {
  final OtherDependency dep;

  // 构造函数接受一个位置参数
  Component(OtherDependency this.dep);

  void doSomething() {
    //...
  }
}

/// 在另一个文件中:
final component = ComponentFactory().create();

component.doSomething();

单例模式

使用@Singleton()注解的效果与@Component()相同，唯一的区别在于实例仅在第一次创建时生成。之后每次调用都会返回相同的实例。

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

// 使用@Singleton()注解标记类
@Singleton()
class Component {
  final OtherDependency dep;

  // 构造函数接受一个位置参数
  Component(OtherDependency this.dep);

  void doSomething() {
    //...
  }
}

/// 在另一个文件中:
final component = ComponentFactory().create();

component.doSomething();

提供者模式

有时你无法访问导入的对象，因此不能对其进行注解以将其作为依赖图的一部分。在这种情况下，你可以创建一个扩展@ProviderBase的类，并使用@Provider()注解，实现provide()方法。

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

// 使用@Provider()注解标记类
@Provider()
class IpProvider extends ProviderBase<String> {

  // 实现provide方法
  @override
  FutureOr<String> provide() {
    return '127.0.0.1';
  }
}

然后，可以将注入字段标记为@ProvidedBy()注解：

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

// 使用@Component()注解标记类
@Component()
class Component {
  final String ip;

  // 构造函数接受一个位置参数
  Component(@ProvidedBy(IpProvider) String this.ip);

  void doSomething() {
    //...
  }
}

/// 在另一个文件中:
final component = ComponentFactory().create();

component.doSomething();

提供者也可以通过组件和其他提供者解析其依赖项：

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

// 使用@Provider()注解标记类
@Provider()
class IpProvider extends ProviderBase<String> {

  // 接受一个配置对象作为依赖项
  final Config config;

  // 构造函数接受一个位置参数
  IpProvider(this.config);

  // 实现provide方法
  @override
  FutureOr<String> provide() {
    return this.config ? '127.0.0.1' : '11.22.33.44';
  }
}

示例

auto_factory/example目录包含一个完整的示例。

import 'lib/src/application.dart';

void main() async {
  // 创建应用实例
  final app = await ApplicationFactory().create();

  // 调用greet方法
  app.greet();
}