Flutter自动化工厂插件auto_factory的使用

安装

要使用此包，请在 pubspec.yaml 文件的 dev_dependencies 部分添加 auto_factory 和 build_runner，并在 dependencies 部分添加 auto_factory_annotation 包。然后运行 pub run build_runner build 来生成部分文件。

dev_dependencies:
  auto_factory:
  build_runner:

dependencies:
  auto_factory_annotation:

目录

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

基本用法

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

注意，仅在具有位置参数的默认构造函数中才会生效。参见示例目录。

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

@Injectable()
class Component {
  final OtherDependency dep;

  Component(OtherDependency this.dep);

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

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

component.doSomething();

单例

使用 @Singleton() 注解的效果与 @Component() 注解相同，只是实例只会在第一次创建。之后每次都会返回相同的实例。

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

@Singleton()
class Component {
  final OtherDependency dep;

  Component(OtherDependency this.dep);

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

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

component.doSomething();

提供者

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

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

@Provider()
class IpProvider extends ProviderBase<String> {

  @override
  Future<String> provide() async {
    return '127.0.0.1';
  }
}

然后，使用 @ProvidedBy() 注解标记注入字段：

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

@Component()
class Component {
  final String ip;

  Component(@ProvidedBy(IpProvider) String this.ip);

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

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

component.doSomething();

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

import 'package:auto_factory_annotation/auto_factory_annotation.dart';

part 'myfile.g.dart';

@Provider()
class IpProvider extends ProviderBase<String> {

  final Config config;

  IpProvider(this.config);

  @override
  Future<String> provide() async {
    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();

  app.greet();
}