搜索插件、代码仓与 APP 分类

插件详情v2.2.0

auto_injector

自动依赖注入系统,但无需 build_runner :)

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
5.1万
喜欢数
119
Pub 分数
160

安装插件

flutter pub add auto_injector

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

AutoInjector 是一个轻量级的、无需构建运行器的 Flutter 应用依赖注入系统。它通过在运行时自动注册和解析服务、仓库及其他类,简化了依赖管理流程。设计简洁易用,无需使用 build_runner 等代码生成工具,使设置更快更直接。非常适合希望以最小开销高效处理依赖注入而无需额外构建步骤的开发者。

适合场景

  • 简单的应用状态管理
  • 快速原型设计
  • 中小型 Flutter 项目
  • 减少依赖设置中的样板代码
  • 避免 build_runner 复杂性

主要特点

  • 无需 build_runner
  • 自动服务注册
  • 最小配置
  • 运行时依赖项解析
  • 支持所有 Flutter 平台

适合对象

  • 希望零构建设置的开发者
  • 项目有紧迫的截止日期
  • 偏好运行时注入而非编译时注入的团队
  • 学习依赖注入概念
  • 轻量级依赖管理

使用建议

  • 不太适合具有复杂依赖关系的大型应用
  • 与基于 build_runner 的解决方案相比,高级功能有限
  • 过多服务注册可能导致性能影响

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Auto Injector - Automatic Dependency injection system without build_runner.


Logo

A simple way to inject dependencies in your project.
Explore the docs »

Report Bug · Request Feature


Version Pub Points Flutterando Analysis

Pub Publisher



Table of Contents
  1. About The Project
  2. Sponsors
  3. Getting Started
  4. How to Use
    1. Dispose Singleton
    2. Modularization
    3. Param Transform
  5. Features
  6. Contributing
  7. Contact
  8. Acknowledgements


About The Project

Auto Injector is a Dart package that was created to make the developer's life easier, making the method of how to do dependency injection simpler and more practical. Just create the class that will be injected and declare it within some of the available "add" methods and that's it, you already have your dependency injection ready to use.

This project is distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Sponsors

Logo

(back to top)


Getting Started

To get Auto Injector in your project follow either of the instructions below:

a) Add your_package as a dependency in your Pubspec.yaml:

  dependencies:
    auto_injector: ^1.0.2

b) Use Dart Pub:

   dart pub add auto_injector

How to Use

Register instances:

final autoInjector = AutoInjector();

void main(){


    // factory
    autoInjector.add(Controller.new);
    // Singleton
    autoInjector.addSingleton(Datasource.new);
    // lazySingleton
    autoInjector.addLazySingleton(Repository.new);
    // instance
    autoInjector.instance('Instance');

    // Inform that you have finished adding instances
    autoInjector.commit();

}


class Controller {
    final Repository repository;

    Controller(this.repository);
}

class Repository {
    final Datasource datasource;

    Repository({required this.datasource});
}

class Datasource {}

Register instances with Key:


autoInjector.add(Controller.new, key: 'MyCustomName');

Get instance:

  // fetch
  final controller = autoInjector.get<Controller>();
  print(controller); // Instance of 'Controller'.

  // or use calleble function (withless .get())
  final datasource = autoInjector<Datasource>();
  print(datasource); // Instance of 'Datasource'.

Get instance by key

  // fetch
  final controller = autoInjector.get<Controller>(key: 'CustomController');
  print(controller); // Instance of 'Controller'.

Try get instance:

  // use tryGet that returns null if exception.
  final datasource = autoInjector.tryGet<Datasource>() ?? Datasource();
  print(datasource); // Instance of 'Datasource'.

Get instance and transform params. This can be used for example to replace an instance with a mock in tests.

  final datasource = autoInjector.get<Datasource>(transform: changeParam(DataSourceMock()));
  print(datasource); // Instance of 'Datasource'.
Dispose Singleton

Singletons can be terminated on request using the disposeSingleton method returning the instance for executing the dispose routine.


final deadInstance = autoInjector.disposeSingleton<MyController>();
deadInstance.close();

Modularization

For projects with multiple scopes, try uniting the instances by naming them Module or Container. With this, you can register specific instances for each module.


// app_module.dart
final appModule = AutoInjector(
  tag: 'AppModule',
  on: (i) {
    i.addInjector(productModule);
    i.addInjector(userModule);
    i.commit();
  },
);

...

// product_module.dart
final productModule = AutoInjector(
  tag: 'ProductModule',
  on: (i) {
    i.addInstance(1);
  },
);

...

// user_module.dart
final userModule = AutoInjector(
  tag: 'UserModule',
  on: (i) {
    i.addInstance(true);
  },
);

...

void main() {
  print(appModule.get<int>());
  print(appModule.get<bool>());
}

It is also possible to remove all singletons from a specific tag using the method disposeSingletonsByTag which reports each instance removed via an anonymous function:

autoInjector.disposeSingletonsByTag('ProductModule', (instance){
  // individual dispose routine
});
Param Transform

There is the possibility to listen and transform all the parameters that are being analyzed when there is an instance request (AutoInject.get()). Add transformers on the main instance:

final homeModule = AutoInjector(
  paramTransforms: [
    (param) {
    if(param is NamedParam){
        return param;
    } else if(param is PositionalParam) {
        return param;
    }
  ],
);


###
BindConfig

If there is a need to configure the dispose and notifier of the bind, use the BindConfig<T> property. This is very useful if you want to automate class disposes like BLoC or Triple Store:

final injector = AutoInjector();

final config = BindConfig<Bloc>(
  onDispose: (bloc) => bloc.close(),
  onNotifier: (bloc) => bloc.stream,
);

injector.addSingleton(ProductBloc.new, config: config);


For more examples, please refer to the Documentation

(back to top)

Features

  • ✅ Auto Dependency Injection
  • ✅ Factory Injection
  • ✅ Singleton Injection
  • ✅ Lazy Singleton Injection
  • ✅ Instance Injection

Right now this package has concluded all his intended features. If you have any suggestions or find something to report, see below how to contribute to it.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the appropriate tag. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Remember to include a tag, and to follow Conventional Commits and Semantic Versioning when uploading your commit and/or creating the issue.

(back to top)

Contact

Flutterando Community

(back to top)

Acknowledgements

Thank you to all the people who contributed to this project, whithout you this project would not be here today.


(back to top)

Maintaned by


Built and maintained by Flutterando.

所属分类

依赖

依赖清单 2 项

源码仓库

使用此插件的项目