Flutter依赖注入插件get_it_injector_gen的使用

Flutter依赖注入插件get_it_injector_gen的使用

get_it_injector_gen 是一个代码生成包，它通过自动化注册 get_it 包中的类来简化依赖注入。该生成器基于 get_it_injector 的注解自动生成必要的代码。

为什么使用get_it_injector_gen？

对于实际项目来说，手动管理依赖项可能会变得繁琐。get_it_injector_gen 的目标是自动化注册过程，使你能够更轻松地配置和管理依赖项。

特性

• 灵活的注册：通过 get_it_injector 注解定义类应注册为工厂、单例还是懒加载单例。生成器将为你处理代码生成。
• 注入顺序：定义类名模式以确定注入顺序，允许你控制类注入的顺序。
• 分组：将可注入对象组织到具有各自优先级的组中，提供更细粒度的依赖管理方法。

开始使用

1. 添加依赖

   在你的 pubspec.yaml 文件中添加 get_it_injector 和 get_it_injector_gen 包：

   dependencies:
       get_it_injector: # 最新版本
   
   dev_dependencies:
       get_it_injector_gen: # 最新版本
       build_runner: # 最新版本
   

2. 配置构建运行器

   在 build.yaml 文件中配置构建运行器以使用 get_it_injector_gen：

   targets:
       $default:
           builders:
               get_it_injector_gen:
                   generate_for:
                       - lib/**/*.dart
                   options:
                       # 添加你的选项
   

   注意：所有选项的大小写格式为 snake_case。

   提示：有关可用选项的更多信息，请参阅设置接口文件。

3. 向生成器提供类

   • 通过注解

     import 'package:get_it_injector/get_it_injector.dart';
     
     @singleton
     class MySingletonService {
         // 实现细节...
     }
     

   • 通过配置

     你可以使用 auto_register 选项包含所有类。

     你可以使用 groups、register、factories、singletons、lazy_singletons 和 priorities 来过滤应注册的类。每个选项接受一个正则表达式列表，用于匹配类名。

     targets:
         $default:
             builders:
                 get_it_injector_gen:
                     generate_for:
                         - lib/**/*.dart
                     options:
                         auto_register: true
                         groups:
                             - PATTERN # 正则表达式
                         register:
                             - PATTERN # 正则表达式
                         factories:
                             - PATTERN # 正则表达式
                         singletons:
                             - PATTERN # 正则表达式
                         lazy_singletons:
                             - PATTERN # 正则表达式
                         priorities:
                             - PATTERN # 正则表达式
     

     提示：有关每个输入的详细信息，请参阅设置接口文件。

4. 添加设置函数

   import 'package:get_it/get_it.dart';
   import 'package:get_it_injector/get_it_injector.dart';
   
   import 'FILE_NAME.config.dart'; // 替换为这个文件的名称
   
   final getIt = GetIt.instance;
   
   [@setup](/user/setup)
   Future<void> setup() {
      getIt.init();
   }
   

5. 运行构建命令生成注册代码

   使用以下命令运行构建命令：

   # 使用 flutter
   flutter pub run build_runner build --delete-conflicting-outputs
   
   # 使用 dart
   pub run build_runner build --delete-conflicting-outputs
   

问题和贡献

如果你遇到任何问题或有改进建议，请随时在 GitHub 上打开一个 issue 或贡献代码。

关于 build_runner 的说明

可以通过扁平化项目结构来优化构建运行器的性能，特别是如果你有嵌套文件夹。考虑在 build.yaml 中使用 exclude 选项来排除不必要的文件夹扫描。

targets:
    $default:
        builders:
            get_it_injector_gen:
                generate_for:
                    include:
                        - lib/**/*.dart
                    exclude:
                        - lib/ui/**

提示：generate_for.include 和 generate_for.exclude 是 build.yaml 格式的一部分。你可以在这里找到更多信息。

许可证

此软件根据 Apache 2.0 许可证发布。更多详情请访问 Apache 2.0 许可证。

示例代码

// --- LICENSE ---
/**
Copyright 2025 CouchSurfing International Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// --- LICENSE ---
import 'package:get_it/get_it.dart';
import 'package:get_it_injector/get_it_injector.dart';

import 'FILE_NAME.config.dart'; // 替换为这个文件的名称

final getIt = GetIt.instance;

[@setup](/user/setup)
Future<void> setup() {
  getIt.init();
}