Flutter依赖注入插件injectable_micropackages的使用

Flutter依赖注入插件injectable_micropackages的使用

Injectable 是一个用于 get_it 的便捷代码生成器。它受到 Angular DI、Guice DI 和 inject.dart 的启发。

目录

• 安装
• 设置
• 注册工厂
• 注册单例
• 注册异步注入对象
• 传递参数给工厂
• 绑定抽象类到实现
• 在不同环境中注册
• 使用命名工厂和静态创建函数
• 注册第三方类型
• 自动注册

安装

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  # 添加 injectable 到你的依赖项
  injectable:
  # 添加 get_it
  get_It:

dev_dependencies:
  # 添加生成器到你的 dev_dependencies
  injectable_generator:
  # 当然需要 build_runner 来运行生成器
  build_runner:

设置

1. 创建一个新的 Dart 文件，并定义一个全局变量来存储你的 GetIt 实例。
2. 定义一个顶级函数（我们称之为 configureDependencies），并用 @injectableInit 注解它。
3. 调用生成的函数 $initGetIt() 或自定义初始化名称，并将 getIt 实例传递进去。
4. 在 main 函数中调用 configureDependencies()，并在运行应用之前执行。

final getIt = GetIt.instance;

@InjectableInit(
  initializerName: r'$initGetIt', // 默认值
  preferRelativeImports: true, // 默认值
  asExtension: false, // 默认值
)
void configureDependencies() => $initGetIt(getIt);

// 如果你想告诉 injectable 处理特定目录内的文件，可以使用 generateForDir 属性
// 例如，只处理 test 文件夹中的文件
@InjectableInit(generateForDir: ['test'])
void configureDependencies() => $initGetIt(getIt);

void main() {
  configureDependencies();
  runApp(MyApp());
}

注册工厂

所有你需要做的就是使用 [@injectable](/user/injectable) 注解你的可注入类，并让生成器完成工作。

[@injectable](/user/injectable)
class ServiceA {}

[@injectable](/user/injectable)
class ServiceB {
  ServiceB(ServiceA serviceA);
}

运行生成器

使用 [watch] 标志来监视文件系统中的更改，并根据需要重新构建。

flutter packages pub run build_runner watch

如果只想运行一次生成器并退出，则使用：

flutter packages pub run build_runner build

生成文件内部

Injectable 将为你生成所需的注册函数。

final getIt = GetIt.instance;

void $initGetIt(GetIt getIt, {String environment, EnvironmentFilter environmentFilter}) {
  final gh = GetItHelper(getIt, environment);
  gh.factory<ServiceA>(() => ServiceA());
  gh.factory<ServiceB>(ServiceA(getIt<ServiceA>()));
}

注册单例

使用 [@singleton](/user/singleton) 或 @lazySingleton 注解你的单例类。

[@singleton](/user/singleton) // 或者 @lazySingleton
class ApiProvider {}

注册异步注入对象

如果实例化需要异步操作，你将需要一个静态初始化方法，因为构造函数不能是异步的。

class ApiClient {
  static Future<ApiClient> create(Deps ...) async {
    ....
    return apiClient;
  }
}

现在只需使用 [@injectable](/user/injectable) 注解你的类，并使用 [@factoryMethod](/user/factoryMethod) 注解来告诉 injectable 使用静态初始化方法作为工厂方法。

[@injectable](/user/injectable) // 或者 lazy/singleton
class ApiClient {
  [@factoryMethod](/user/factoryMethod)
  static Future<ApiClient> create(Deps ...) async {
    ....
    return apiClient;
  }
}

生成的代码：

factoryAsync<ApiClient>(() => ApiClient.create());

传递参数给工厂

如果你的工作涉及一个你可以控制的类，只需使用 @factoryParam 注解你的可变构造函数参数即可。最多可以有两个参数！

[@injectable](/user/injectable)
class BackendService {
  BackendService(@factoryParam String url);
}

生成的代码：

factoryParam<BackendService, String, dynamic>(
  (url, _) => BackendService(url),
);

绑定抽象类到实现

使用 [@Injectable](/user/Injectable)(as: ..) 注解内的 as 属性来传递由注册依赖项实现的抽象类型。

[@Injectable](/user/Injectable)(as: Service)
class ServiceImpl implements Service {}

// 或者
@Singleton(as: Service) 
class ServiceImpl implements Service {}

// 或者
@LazySingleton(as: Service) 
class ServiceImpl implements Service {}

生成的代码：

factory<Service>(() => ServiceImpl())

注册在不同环境下的对象

通过使用 @Environment('name') 注解来注册不同环境下的不同依赖项。

@Environment("dev")
[@injectable](/user/injectable)
class ServiceA {}

或者，你可以通过 env 属性来分配环境名到你的依赖项。

[@Injectable](/user/Injectable)(as: Service, env: [Environment.dev, Environment.test])
class RealServiceImpl implements Service {}
``

### 使用命名工厂和静态创建函数

默认情况下，injectable 将使用默认构造函数来构建你的依赖项，但你可以通过 `[@factoryMethod](/user/factoryMethod)` 注解来告诉 injectable 使用命名构造函数或静态创建函数。

```dart
[@injectable](/user/injectable)
class MyRepository {
  [@factoryMethod](/user/factoryMethod)
  MyRepository.from(Service s);
}

生成的代码：

factory<MyRepository>(MyRepository.from(getIt<Service>()))

注册第三方类型

为了注册第三方类型，创建一个抽象类并使用 [@module](/user/module) 注解，然后添加你的第三方类型作为属性访问器或方法。

[@module](/user/module)
abstract class RegisterModule {
  [@singleton](/user/singleton)
  ThirdPartyType get thirdPartyType;

  [@prod](/user/prod)
  [@Injectable](/user/Injectable)(as: ThirdPartyAbstract)
  ThirdPartyImpl get thirdPartyType;
}

自动注册

通过使用约定优于配置的方式，可以在微包架构中自动注册你的可注入类。

targets:
  $default:
    builders:
      injectable_generator:injectable_builder:
        options:
          auto_register: true
          class_name_pattern: "Service$|Repository$|Bloc$"
          file_name_pattern: "_service$|_repository$|_bloc$"

示例

import 'package:injectable/injectable_annotations.dart';

abstract class Service {}

[@named](/user/named)
[@prod](/user/prod)
[@Injectable](/user/Injectable)(as: Service)
class ServiceImpl1 extends Service {}

[@Injectable](/user/Injectable)(as: Service, env: [Environment.dev])
class ServiceImpl2 implements Service {}

[@injectable](/user/injectable)
class MyRepository {
  MyRepository(@Named.from(ServiceImpl1) Service service);
}