Flutter依赖注入插件injectable_generator_micropackages的使用

Flutter依赖注入插件injectable_generator_micropackages的使用

injectable_generator_micropackages 是一个用于生成依赖注入代码的插件，它与 injectable 库配合使用，可以简化依赖注入的过程。本文将通过一个完整的示例来展示如何使用 injectable_generator_micropackages。

1. 添加依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  injectable: ^x.x.x  # 替换为最新版本号

dev_dependencies:
  build_runner: ^x.x.x  # 替换为最新版本号
  injectable_generator: ^x.x.x  # 替换为最新版本号

然后运行以下命令以安装依赖：

flutter pub get

2. 创建服务类

接下来，创建两个服务类 ServiceImpl1 和 ServiceImpl2，它们都实现了同一个接口 Service。

// lib/service/service.dart
abstract class Service {}

// lib/service/service_impl_1.dart
import 'package:injectable/injectable_annotations.dart';

@named
@prod
@Injectable(as: Service)
class ServiceImpl1 extends Service {}

// lib/service/service_impl_2.dart
import 'package:injectable/injectable_annotations.dart';
import 'package:injectable/injectable.dart';

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

• @named：为 ServiceImpl1 注入一个名称。
• @prod：表示该类在生产环境中可用。
• @env：指定 ServiceImpl2 在开发环境（Environment.dev）中可用。

3. 创建注入器

创建一个注入器类，用于管理依赖注入。

// lib/injector.config.dart
import 'package:injectable/injectable.dart';
import 'package:injectable_generator_micropackages_example/service/service_impl_1.dart';
import 'package:injectable_generator_micropackages_example/service/service_impl_2.dart';

@injectableInit
void configureDependencies(String environment) =>
    $initInjectable(environment);

// lib/main.dart
import 'package:flutter/material.dart';
import 'package:injectable/injectable.dart';
import 'package:injectable_generator_micropackages_example/injector.config.dart';

final _getIt = GetIt.instance;

void main() {
  // 配置注入器
  configureDependencies(Environment.prod); // 设置为生产环境

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

• @injectableInit：生成初始化方法，用于配置注入器。
• configureDependencies：根据环境配置注入器。

4. 使用依赖注入

现在可以在项目中使用注入器来获取实例。

// lib/repository/my_repository.dart
import 'package:injectable/injectable.dart';
import 'package:injectable_generator_micropackages_example/service/service.dart';

@injectable
class MyRepository {
  final Service _service;

  MyRepository(this._service);
}

// lib/main.dart
import 'package:flutter/material.dart';
import 'package:injectable/injectable.dart';
import 'package:injectable_generator_micropackages_example/injector.config.dart';
import 'package:injectable_generator_micropackages_example/repository/my_repository.dart';

final _getIt = GetIt.instance;

void main() {
  configureDependencies(Environment.prod);

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  final MyRepository _repository = _getIt<MyRepository>();

  MyHomePage({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Dependency Injection Example'),
      ),
      body: Center(
        child: Text('Injected Service: ${_repository._service.runtimeType}'),
      ),
    );
  }
}

• _getIt<MyRepository>()：通过注入器获取 MyRepository 实例。
• _repository._service.runtimeType：打印注入的服务类型。

5. 运行示例

确保 Environment.prod 已正确配置，运行应用后，你应该会看到类似以下的输出：

Injected Service: ServiceImpl1