Flutter依赖注入插件injectfy的使用

🚀 Injectfy简介

Injectfy 是一个为Dart设计的极简且易于使用的依赖注入库，用于管理单例和工厂模式。它使得在Flutter项目中管理对象的创建和生命周期变得非常简单。

🌟 功能特性

• ✅ 注册单例和工厂来管理依赖。
• 🔄 自动解析并注入依赖。
• ❌ 简单地注销不再需要的依赖。
• ⚡ 缓存频繁访问的实例以提高性能。
• 🛠️ 适用于生产环境和测试（支持mock）。

📦 安装

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

dependencies:
  injectfy: ^1.0.1

然后运行命令安装依赖：

flutter pub get

🚀 快速上手

📋 基本用法

以下是Injectfy的基本使用方法：

import 'package:injectfy/injectfy.dart';

void main() {
  // 获取Injectfy实例
  final injectfy = Injectfy.instance;

  // 注册单例
  injectfy.registerSingleton<SomeService>(() => SomeService());

  // 注册工厂
  injectfy.registerFactory<ClientsRepository>(() => ClientsRepositoryImpl());

  // 解析依赖
  final someService = injectfy.get<SomeService>();
  final clientsRepository = injectfy.get<ClientsRepository>();

  print(someService);  // 输出: Instance of 'SomeService'
  print(clientsRepository);  // 输出: Instance of 'ClientsRepositoryImpl'
}

🧱 注册单例

单例模式下，类只会被实例化一次，并在每次请求时重用相同的实例。

class SomeService {
  void doSomething() => print("Doing something...");
}

void main() {
  final injectfy = Injectfy.instance;

  injectfy.registerSingleton<SomeService>(() => SomeService());

  final service1 = Injectfy.get<SomeService>();
  final service2 = Injectfy.get<SomeService>();

  print(identical(service1, service2));  // 输出: true
}

🏢 注册工厂

工厂模式允许每次请求时创建一个新的实例。

class UserRepository {}

void main() {
  final injectfy = Injectfy.instance;

  injectfy.registerFactory<UserRepository>(() => UserRepository());

  final repo1 = Injectfy.get<UserRepository>();
  final repo2 = Injectfy.get<UserRepository>();

  print(identical(repo1, repo2));  // 输出: false
}

🧐 自动解析依赖

当调用方法时，可以自动解析依赖关系。

class SomeService {
  final SomeDependency _someDependency;

  SomeService(this._someDependency);
}

void main() {
  final injectfy = Injectfy.instance;

  injectfy.registerSingleton<SomeService>(() => SomeService(injectfy()));
}

🛠️ 注销依赖

如果不再需要某个依赖，可以通过unregister方法将其注销。

void main() {
  final injectfy = Injectfy.instance;

  injectfy.registerSingleton<SomeService>(() => SomeService());

  injectfy.unregister<SomeService>();

  try {
    final service = Injectfy.get<SomeService>();
  } catch (e) {
    print(e);  // 输出: Dependency of type SomeService not found.
  }
}

🧪 注册Mock依赖（适用于测试）

为了测试目的，可以用模拟对象替换实际依赖。

void main() {
  final injectfy = Injectfy.instance;

  final mockService = SomeService();
  injectfy.registerMock<SomeService>(mockService);

  final service = Injectfy.get<SomeService>();
  print(service == mockService);  // 输出: true
}

🖊️ API参考

🧪 测试

通过注册mock依赖来进行单元测试是十分方便的。

import 'package:test/test.dart';

void main() {
  test('Singleton works correctly', () {
    Injectfy.I.registerSingleton<SomeService>(() => SomeService());

    final service1 = Injectfy.get<SomeService>();
    final service2 = Injectfy.get<SomeService>();

    expect(identical(service1, service2), true);
  });

  test('Factory works correctly', () {
    Injectfy.I.registerFactory<UserRepository>(() => UserRepository());

    final repo1 = Injectfy.get<UserRepository>();
    final repo2 = Injectfy.get<UserRepository>();

    expect(identical(repo1, repo2), false);
  });

  test('Mock registration works correctly', () {
    final mockService = SomeService();
    Injectfy.I.registerMock<SomeService>(mockService);

    final service = Injectfy.get<SomeService>();

    expect(service, mockService);
  });
}

示例代码

这里提供了一个完整的示例，展示了如何在Flutter应用中使用Injectfy进行依赖注入。

import 'package:flutter/material.dart';
import 'package:injectfy/injectfy.dart';

// 模拟的服务类
class SomeService {
  void doSomething() => print("Doing something...");
}

// 主函数入口
void main() {
  // 初始化依赖注入容器
  Inject.inject();

  runApp(MyApp());
}

// 应用根组件
class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Injectfy Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: HomePage(),
    );
  }
}

// 首页组件
class HomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // 从注入容器中获取服务实例
    final someService = Inject.get<SomeService>();

    return Scaffold(
      appBar: AppBar(title: Text('Injectfy Example')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            someService.doSomething();
          },
          child: Text('Do Something'),
        ),
      ),
    );
  }
}

以上就是关于Injectfy的详细介绍和使用示例，希望对您有所帮助！如果您有任何问题或建议，请随时提出。