Flutter插件Cherrypick介绍与使用

快速开始

Cherrypick 是一个用于Flutter应用程序的依赖注入（Dependency Injection, DI）库，它允许开发者更方便地管理应用中的依赖关系。虽然其名称为“cherrypick”，但根据提供的文档和代码示例，它并非直接用于数据筛选或选择的功能插件，而是专注于通过DI模式来简化对象创建过程。

主要组件：DI

Binding

Binding 是自定义实例配置器，包含用于配置依赖的方法。主要有两种初始化方法：

• toInstance()：接受已经初始化的实例。
• toProvide()：接受一个提供者函数（即实例构造器）。

此外还有辅助方法：

• withName()：给实例命名以便从DI容器中提取。
• singleton()：设置单例标志，确保只有一个依赖实例。

Module

Module 是用户实例的容器，用户可以在模块中实现void builder(Scope currentScope)方法来自定义绑定逻辑。

Scope

Scope 作为依赖树的存储容器，可以通过调用resolve<T>()方法获取指定类型的对象实例，并支持传递额外参数。同时，还支持子作用域（sub-scope）的概念。

示例应用

# pubspec.yaml
name: example
version: 1.0.0

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  cherrypick: ^latest_version # 请替换为实际版本号

// main.dart
import 'dart:async';
import 'package:meta/meta.dart';
import 'package:cherrypick/cherrypick.dart';

// 定义接口和实现类...
abstract class ApiClient {
  Future<String> sendRequest({required String url, String? token, Map? requestBody});
}

class ApiClientMock implements ApiClient {
  @override
  Future<String> sendRequest({required String? url, String? token, Map? requestBody}) async {
    return 'Local Data';
  }
}

class ApiClientImpl implements ApiClient {
  @override
  Future<String> sendRequest({required String? url, String? token, Map? requestBody}) async {
    return 'Network data';
  }
}

abstract class DataRepository {
  Future<String> getData();
}

class NetworkDataRepository implements DataRepository {
  final ApiClient _apiClient;
  final String _token = 'token';

  NetworkDataRepository(this._apiClient);

  @override
  Future<String> getData() async => await _apiClient.sendRequest(
      url: 'https://example.com', token: _token, requestBody: {'type': 'data'});
}

class DataBloc {
  final DataRepository _dataRepository;
  final StreamController<String> _dataController = StreamController.broadcast();

  DataBloc(this._dataRepository);

  Stream<String> get data => _dataController.stream;

  Future<void> fetchData() async {
    try {
      _dataController.sink.add(await _dataRepository.getData());
    } catch (e) {
      _dataController.sink.addError(e);
    }
  }

  void dispose() {
    _dataController.close();
  }
}

// 定义模块...
class AppModule extends Module {
  @override
  void builder(Scope currentScope) {
    bind<ApiClient>().withName("apiClientMock").toInstance(ApiClientMock());
    bind<ApiClient>().withName("apiClientImpl").toInstance(ApiClientImpl());
  }
}

class FeatureModule extends Module {
  bool isMock;

  FeatureModule({required this.isMock});

  @override
  void builder(Scope currentScope) {
    bind<DataRepository>()
        .withName("networkRepo")
        .toProvide(
          () => NetworkDataRepository(
            currentScope.resolve<ApiClient>(
              named: isMock ? "apiClientMock" : "apiClientImpl",
            ),
          ),
        )
        .singleton();
    bind<DataBloc>().toProvide(
      () => DataBloc(
        currentScope.resolve<DataRepository>(named: "networkRepo"),
      ),
    );
  }
}

void main() async {
  // 打开根作用域并安装模块
  final scope = openRootScope().installModules([
    AppModule(),
  ]);

  // 创建子作用域并安装特性模块
  final subScope = scope.openSubScope("featureScope").installModules([FeatureModule(isMock: true)]);

  // 获取并监听数据流
  final dataBloc = subScope.resolve<DataBloc>();
  dataBloc.data.listen((d) => print('Received data: $d'),
      onError: (e) => print('Error: $e'), onDone: () => print('DONE'));

  // 模拟数据请求
  await dataBloc.fetchData();

  // 清理资源
  dataBloc.dispose();
}

以上代码展示了如何使用Cherrypick进行依赖注入的基本流程。首先定义了几个抽象类及其具体实现，然后通过AppModule和FeatureModule将这些依赖关系注册到DI容器中。最后，在main()函数中演示了如何打开作用域、安装模块以及解析所需的依赖对象。

需要注意的是，尽管插件名为“cherrypick”，但从功能上看它更像是一个依赖注入工具，而不是专门用于数据筛选或选择的操作。如果你正在寻找有关数据筛选的帮助，请考虑查阅其他相关插件或直接利用Dart/Flutter内置的数据处理机制。