Flutter多模块依赖注入插件flutter_multi_module_di的使用

Flutter多模块依赖注入插件flutter_multi_module_di的使用

安装

在你的 pubspec.yaml 文件的 dependencies: 部分添加以下行：

dependencies:
    flutter_multi_module_di: latest_version

重要提示：

从 2.0.0 版本开始，flutter_multi_module_di 使用了 null-safe 代码。

多模块示例

你可以为整个应用程序、小部件和组件使用依赖树。

使用

基础用法

创建一个主页面并使用 ChildInjectorStatefulWidget 包装它。这将创建一个包含子模块和父依赖项的单例模块。

class MainPage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return ChildInjectorStatefulWidget(
      childModuleBuilder: () => MainModule(context), // 子模块构建器
      injectorBuilder: (i) => _MainWidget(i.get(), i.get(name: "test_1")), // 注入器构建器
    );
  }
}

class _MainWidget extends StatelessWidget {
  final MainBloc _bloc;
  final String _testSrt;

  _MainWidget(this._bloc, this._testSrt);

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 构建小部件...
    return Container();
  }
}

配置依赖项

你可以通过扩展 WidgetModule 类来配置依赖项。

class MainModule extends WidgetModule {
  MainModule(BuildContext context) : super(context);

  [@override](/user/override)
  void configureWidget(Binder binder) {
    binder
      ..bindLazySingleton((i, _) => MainBloc(i.get(), i.get())..add(MainPageOpenedEvent()))
      ..bindLazySingleton((i, _) => MainNavigator(i.get()));
  }
}

或者使用普通的 Dart 模块。

class TestModule extends Module {
  [@override](/user/override)
  void configure(Binder binder) {
    // 配置依赖项...
  }
}

获取依赖项

你可以在任何地方引用注入器，就像引用其他 InheritedWidget 一样。

class SomeWidget extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    final injector = InjectorWidget.of(context);
    final apiKey = injector.get(name: "api_key");
    return SomeContainerNeedingTheKey(apiKey);
  }
}

你也可以使用 InjectorWidgetMixin。

class SomeWidget extends StatelessWidget with InjectorWidgetMixin {
  [@override](/user/override)
  Widget buildWithInjector(BuildContext context, Injector injector) {
    final object = injector.get<Object>();
    print(object);
    return Container();
  }
}

全部API

ChildInjectorStatefulWidget

创建一个包含子模块和父依赖项的单例模块。

class MainPage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return ChildInjectorStatefulWidget(
      childModuleBuilder: () => MainModule(context),
      injectorBuilder: (i) => _MainWidget(i.get(), i.get(name: "test_1")),
    );
  }
}

ChildInjectorWidget

创建一个新的模块，包含子模块和父依赖项。

class MainPage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return ChildInjectorWidget(
      childModule: MainModule(context),
      injectorBuilder: (injector) {
        // 在这里配置注入器...
        return Container();
      },
    );
  }
}

InjectorWidget

创建一个包含注入器的小部件。

[@override](/user/override)
Widget build(BuildContext context) {
  return InjectorWidget(
    child: Text(""),
    injector: Injector.fromModule(module: ...),
    autoDispose: true, // 默认值为 true
  );
}

InjectorWidgetMixin

使用注入器混合类。

class TestWidget with InjectorWidgetMixin {
  [@override](/user/override)
  Widget buildWithInjector(BuildContext context, Injector injector) {
    injector.get(name: "test_key");
    return Container();
  }
}

WithInjectorWidget & WithInstanceWidget

使用注入器的小部件。

[@override](/user/override)
Widget build(BuildContext context) {
  return WithInjectorWidget(
    builder: (injector) {
      injector.get(name: "test");
      return Container();
    },
  );
}

[@override](/user/override)
Widget build(BuildContext context) {
  return WithInstanceWidget<SharedPreferences>(
    builder: (sharedPrefs) {
      return Container();
    },
  );
}

ModuleWidget

创建一个模块小部件。

class TestWidget extends ModuleWidget {
  [@override](/user/override)
  void configure(Binder binder) {
    // 配置依赖项...
  }
}

完整示例代码

import 'package:flutter/material.dart';
import 'package:flutter_multi_module_di/flutter_multi_module_di.dart';
import 'package:flutter_multi_module_di_example/widget/main_page.dart';

import 'di/app_module.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Material(
        child: FutureBuilder<Module>(
          future: AppModule.create(context),
          builder: (context, future) {
            if (future?.data == null) {
              return Container();
            }

            return InjectorWidget(
              injector: Injector.fromModule(module: future.data),
              child: MainPage(),
            );
          },
        ),
      ),
    );
  }
}