Flutter依赖注入插件inject_creator的使用

inject_creator 是一个方便的代码生成器，用于简化 get_it 的依赖注入。它支持多种功能，包括单例模式、懒加载单例、可变对象、别名、工厂方法、构造后处理、销毁方法以及组件支持。

特性

• 单例模式 (Singleton)
• 懒加载单例 (LazySingleton)
• 可变对象 (Mutable)
• 别名 (Alias)
• 工厂方法 (FactoryMethod)
• 构造后处理 (PostConstruct)
• 销毁方法 (DisposeMethod)
• 组件支持 (Component)

开始使用

安装依赖

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

dependencies:
  get_it: ^6.0.0
  inject_creator: any

dev_dependencies:
  build_runner: ^2.0.0
  inject_creator_generator: any

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

flutter pub get

初始化注入器

在应用程序入口处初始化注入器。你可以选择同步或异步初始化。

同步初始化

import 'main.dep.dart';

[@EnableInjector](/user/EnableInjector)(allReady: true)
void main() {
  configDependencies(); // 同步初始化
  runApp(const MyApp());
}

异步初始化

import 'main.dep.dart';

[@EnableInjector](/user/EnableInjector)(allReady: false)
void main() async {
  await initDependencies(); // 异步初始化
  runApp(const MyApp());
}

在初始化完成后，可以通过 getXxxx() 方法获取实例：

getXxxx(); // 获取同步初始化的实例
await getSharedPreferences(); // 获取异步初始化的实例

生成注入代码

运行以下命令以生成注入代码：

flutter pub run build_runner build

示例代码

以下是一个完整的示例，展示如何使用 inject_creator。

单例模式 (Singleton)

@Singleton()
class LoginService {}

@Singleton(tag: 'customNameService')
class CustomNameService {}

abstract class AbstractService {}

@Singleton(tag: 'default', as: AbstractService)
class AbstractServiceImpl extends AbstractService {}

懒加载单例 (LazySingleton)

@LazySingleton()
class LazySingletonService {}

可变对象 (Mutable)

@Mutable()
class NoSingletonService {}

构造后处理 (PostConstruct)

@Singleton()
class LoginService {
  @PostConstruct()
  void init() {
    print('PostConstruct init'); // 构造后执行的逻辑
  }
}

工厂方法 (FactoryMethod)

@LazySingleton(tag: 'asyncService')
class AsyncService {
  @FactoryMethod()
  static Future<AsyncService> withDependencies(LoginService loginService) {
    return Future.value(AsyncService()); // 返回异步实例
  }
}

销毁方法 (DisposeMethod)

@LazySingleton()
class DbService {
  @DisposeMethod()
  void dispose() {
    print('Disposing DbService'); // 销毁时执行的逻辑
  }
}

别名 (Alias)

@LazySingleton()
class FactoryMethodService {
  @FactoryMethod()
  static Future<FactoryMethodService> withDependencies({
    @Alias('asyncService') required Future<AsyncService> asyncService,
    @Alias.by(SimpleAbstractService) required AbstractService abstractService,
  }) {
    return Future(() => FactoryMethodService());
  }
}

第三方库支持 (Component)

@Component()
class VendorComponent {
  @LazySingleton(tag: 'defaultSharedPreferences')
  Future<SharedPreferences> get sharedPreferences => SharedPreferences.getInstance();

  @DisposeMethod()
  void dispose() {
    sharedPreferences.then((value) => value.clear()); // 清理共享偏好设置
  }
}

完整示例

以下是一个完整的 Flutter 应用程序示例，展示了如何使用 inject_creator。

main.dart

import 'package:flutter/material.dart';
import 'package:inject_creator/inject_creator.dart';
import 'main.dep.dart'; // 注入代码生成文件

[@EnableInjector](/user/EnableInjector)(allReady: true) // 同步初始化
void main() {
  configDependencies();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(primarySwatch: Colors.blue),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text(widget.title)),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('You have pushed the button this many times:'),
            Text('$_counter', style: Theme.of(context).textTheme.headline4),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}