Flutter依赖注入插件koin的使用

Koin.dart 是一个轻量级且灵活的依赖注入库，它是基于 Kotlin 的 Koin 库移植到 Dart 平台上的版本。它不依赖于代码生成或反射，完全用纯 Dart 编写。

Koin.dart

为什么应该使用 Koin？

1. 对象管理
   支持在不再使用对象时自动释放它们。

2. 跨平台支持
   核心部分不依赖于 Flutter，可以在任何 Dart 应用中使用。

3. 作用域控制
   可以定义变量在 widget 树的哪个部分是可访问的。

4. 与 Bloc 集成
   默认支持与 Bloc 库集成，但也可以与其他状态管理工具一起使用。

5. 开发工具支持
   提供 DevTools 工具来检查对象的状态。

6. 延迟加载
   只在需要时实例化依赖项。

7. 非侵入式
   不需要更改现有 Widget 的结构即可引入 Koin。

8. 构造函数注入
   支持通过构造函数进行依赖注入，降低耦合性并便于测试。

特性

• 模块化
• 支持作用域
• 单例提供者（定义）
• 工厂提供者（定义）
• 延迟注入
• 日志记录
• 多绑定支持
• 名称绑定支持
• Bloc 集成
• 对象状态检查工具

Koin.dart 不是什么？

Koin.dart 不是一个状态管理器。它本身不包含任何状态管理逻辑，可以与任何状态管理工具一起使用。

快速开始

基本设置

添加依赖

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

dependencies:
  koin: ^[version]

如果使用 Flutter：

dependencies:
  koin: ^[version]
  koin_flutter: ^[version]

声明 Koin 模块

// 定义一些类
class Bloc {
  final Repository service;

  Bloc(this.service);

  String getState() => "Hello";
}

class Repository {}

// 声明提供者（定义）
final myModule = Module()
  // 单例提供者（定义）：Bloc 类
  ..single((s) => Bloc(s.get()))
  // 单例提供者（定义）：Repository 类
  ..single((s) => Repository());

启动 Koin

在 Dart 应用中启动 Koin：

void main(List<String> args) {
  startKoin((app) {
    app.module(myModule);
  });
}

在 Flutter 应用中启动 Koin：

void main() {
  startKoin((app) {
    app.module(myModule);
  });
  runApp(MyApp());
}

注入依赖

class MyHomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    // 获取依赖
    final bloc = get<Bloc>();
    return Container(
      child: Text(bloc.getState()),
    );
  }
}

示例代码

以下是一个完整的示例代码，展示如何使用 Koin.dart 进行依赖注入。

import 'package:koin/koin.dart';

// 定义实体类
class Post {
  final String title;
  final String body;

  Post(this.title, this.body);
}

// 定义抽象接口
abstract class PostRepository {
  List<Post> getAll();
}

// 实现类
class RestPostRepository implements PostRepository {
  [@override](/user/override)
  List<Post> getAll() {
    return [
      Post("Title 1", "Body 1"),
      Post("Title 2", "Body 2"),
    ];
  }
}

// 声明 Koin 模块
var postModule = Module()
  ..single<PostRepository>((s) => RestPostRepository());

void main() {
  // 启动 Koin
  var koin = startKoin((app) {
    app.module(postModule);
  }).koin;

  // 获取依赖
  var postRepository = koin.get<PostRepository>();

  // 打印结果
  print(postRepository.getAll());
}

运行此代码后，将输出：

[I] PostRepository.getAll(): [Post(title: Title 1, body: Body 1), Post(title: Title 2, body: Body 2)]

Koin DevTools

Koin DevTools 允许你查看由提供者创建的对象的内部状态。

使用方法

只需在应用中插入 KoinDevTools 小部件，或者调用 showDevTools 方法。

class Page extends StatefulWidget {
  [@override](/user/override)
  _PageState createState() => _PageState();
}

class _PageState extends State<Page> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      // 插入 KoinDevTools
      endDrawer: KoinDevTools(),
      body: Center(
        child: IconButton(
          icon: Text('Show DevTools'),
          onPressed: () {
            // 或者调用 showDevTools
            showDevTools(context);
          },
        ),
      ),
    );
  }
}