パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細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 件

ソースリポジトリ

このパッケージを使用しているプロジェクト