Flutter插件yx_scope的使用_yx_scope 是一个编译安全的依赖注入（DI）框架，具有高级作用域管理能力

介绍

yx_scope 是一个编译安全的依赖注入（DI）框架，具有高级作用域管理能力。它允许开发者以声明的方式描述依赖关系树，并且支持异步初始化和嵌套作用域。

库组件

• yx_scope: 框架的核心实现。
• yx_scope_flutter: 允许将 yx_scope 容器嵌入到 Flutter 的 widget 树中的适配库。
• yx_scope_linter: 提供额外保护的一组自定义 lint 规则，防止在使用 yx_scope 时出现错误。

特性

• 纯 Dart 实现。
• 类似 DI 的设计，但不是静态也不是 ServiceLocator。
• 编译安全的依赖访问。
• 不需要代码生成。
• Flutter 友好的容器管理。
• 声明式的依赖树描述。
• 非响应式依赖树。
• 明确的行为和生命周期管理。
• 支持任意层级的作用域嵌套。
• 编译安全的作用域存在性检查。
• 支持异步依赖及其初始化。
• 编译安全的循环依赖防护。

快速开始

首先，在 pubspec.yaml 文件中添加 yx_scope 依赖：

dependencies:
  yx_scope: ^1.0.0

创建一个名为 app_scope.dart 的文件，并添加容器和依赖项的描述：

import 'package:yx_scope/yx_scope.dart';

class AppRouterDelegate {
  // Router delegate implementation
}

class AppStateObserver {
  final AppRouterDelegate routerDelegate;

  AppStateObserver(this.routerDelegate);
}

class AppScopeContainer extends ScopeContainer {
  late final routerDelegateDep = dep(() => AppRouterDelegate());

  late final appStateObserverDep = dep(
    () => AppStateObserver(routerDelegateDep.get),
  );
}

class AppScopeHolder extends ScopeHolder<AppScopeContainer> {
  @override
  AppScopeContainer createContainer() => AppScopeContainer();
}

现在，创建一个 AppScopeHolder，创建容器并访问依赖项：

void main() async {
  final appScopeHolder = AppScopeHolder();
  await appScopeHolder.create();

  final appScope = appScopeHolder.scope;
  if (appScope != null) {
    final AppStateObserver appStateObserver = appScope.appStateObserverDep.get;
    // Use the appStateObserver as needed
  }

  // When done, drop the scope to dispose dependencies
  await appScopeHolder.drop();
}

关键实体

• Dep (dependency): 存储一个特定实例的容器。
• ScopeContainer: 一组由有意义的作用域统一的隔离且不重叠的依赖项集合，共享共同的生命周期。
• ScopeHolder: 存储容器当前状态的实例，负责其初始化和销毁。

示例应用

以下是一个完整的示例应用程序，展示如何在 Flutter 中使用 yx_scope：

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

// Example classes
class AppRouterDelegate {
  String currentRoute = '/home';
}

class AppStateObserver {
  final AppRouterDelegate routerDelegate;

  AppStateObserver(this.routerDelegate);
}

// Define the scope container
class AppScopeContainer extends ScopeContainer {
  late final routerDelegateDep = dep(() => AppRouterDelegate());

  late final appStateObserverDep = dep(
    () => AppStateObserver(routerDelegateDep.get),
  );
}

// Define the scope holder
class AppScopeHolder extends ScopeHolder<AppScopeContainer> {
  @override
  AppScopeContainer createContainer() => AppScopeContainer();
}

// Main function
void main() async {
  final appScopeHolder = AppScopeHolder();
  await appScopeHolder.create();

  runApp(MyApp(appScopeHolder: appScopeHolder));
}

class MyApp extends StatelessWidget {
  final AppScopeHolder appScopeHolder;

  MyApp({required this.appScopeHolder});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(appScopeHolder: appScopeHolder),
    );
  }
}

class MyHomePage extends StatelessWidget {
  final AppScopeHolder appScopeHolder;

  MyHomePage({required this.appScopeHolder});

  @override
  Widget build(BuildContext context) {
    final appScope = appScopeHolder.scope;
    if (appScope != null) {
      final AppStateObserver appStateObserver = appScope.appStateObserverDep.get;
      return Scaffold(
        appBar: AppBar(
          title: Text('yx_scope Example'),
        ),
        body: Center(
          child: Text('Current Route: ${appStateObserver.routerDelegate.currentRoute}'),
        ),
      );
    } else {
      return Scaffold(
        appBar: AppBar(
          title: Text('Error'),
        ),
        body: Center(
          child: Text('Failed to initialize scope.'),
        ),
      );
    }
  }
}

通过这个示例，您可以了解如何在 Flutter 应用程序中使用 yx_scope 来管理依赖项和作用域。希望这对您有所帮助！