Flutter注解绑定插件getx_binding_annotation的使用

Getx Dependencies Binding Annotation Generator

一个基于注解的代码生成插件，用于根据注解生成GetX状态管理器所需的页面和依赖项。该包旨在防止逐个添加依赖到GetX的列表中。您可以将其用于页面、控制器或其他任何依赖项。

目录:

• 入门
• 用法
• 选项
  • 一些例子
• 文档
• 关于作者
• 软件包和依赖项
• 测试

入门

在pubspec.yaml文件中添加依赖：

dependencies:
  get: ^latest
  getx_binding_annotation: ^latest

dev_dependencies:
  build_runner: ^latest
  getx_binding_annotation_generator: ^latest

通过以下命令获取更改：

flutter pub get

或者

dart pub get

用法

首先导入插件：

import 'package:getx_binding_annotation/annotation.dart';

然后，在所需的类上添加所需的@Annotation并设置所需的选项。

例如：

[@GetPut](/user/GetPut).page(isInitial: true)
class HomePage extends GetView<HomePageController> {}

[@GetPut](/user/GetPut).controller()
class SettingsController extends GetxController {}

之后，运行build_runner以生成代码，并创建相关的文件，将所有页面、控制器、组件和存储库集中在一个地方，并准备使用。

你可以使用以下命令运行构建任务：

dart pub run build_runner build --delete-conflicting-outputs

成功生成后，你将在项目根目录/lib下的main.dart旁边看到新的main.get_put.dart文件。

然后可以导入生成的文件：

import 'main.get_put.dart';

接下来，你需要在main.dart中进行以下更改：

void main() {
  GetPutBindings().dependencies();
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});
  @override
  Widget build(BuildContext context) {
    return GetMaterialApp(
      /// 你必须在你的项目中设置这四个函数和变量
      initialBinding: GetPutBindings(), // 注入所有依赖
      getPages: GetPutPages.pages, // 将所有页面添加到GetX上下文中
      initialRoute: GetPutPages.initialRoute.name, // 设置初始路由
      unknownRoute: GetPutPages.unknownRoute, // 设置未知或未定义路由的处理
    );
  }
}

你可以查看/example目录以获得更完整的示例、更多详细信息和进一步的信息。

选项

你可以在@Annotation中设置一些注解及其选项。可用选项包括：

[@GetPut](/user/GetPut).page()

• as: 更改页面在依赖项中的名称。
• route: 插件会根据页面名称生成默认名称，但你也可以设置字符串作为新路由。如果未设置route，则将使用自动生成的路由。
• isInitial: 你应该为GetX设置初始路由，应用程序将从该页面和其路由开始。这是一个必需的选项。如果你设置了两个或更多的初始页面，插件不会抛出异常，但会将第一个标记为初始页面的页面作为默认初始路由。
• isUnknown: 你可以设置未知路由，当应用程序中发生无效路由时，将显示该页面。如果你设置了两个或更多的未知页面，插件不会抛出异常，但会将第一个标记为未知页面的页面作为默认未知路由。

[@GetPut](/user/GetPut).controller()

• as: 更改控制器在依赖项中的名称。

[@GetPut](/user/GetPut).component()

• as: 更改组件在依赖项中的名称。

[@GetPut](/user/GetPut).repository()

• as: 更改存储库在依赖项中的名称。

一些例子

Settings:

[@GetPut](/user/GetPut).page()
class SettingsPage extends GetView<SettingsController> {}

[@GetPut](/user/GetPut).controller()
class NotFoundController extends GetxController {}

NotFound: 或 Unknown:

[@GetPut](/user/GetPut).page(isUnknown: true)
class NotFoundPage extends GetView<NotFoundController> {}

[@GetPut](/user/GetPut).controller()
class NotFoundController extends GetxController {}

Storage Component:

abstract class StorageComponent {}

[@GetPut](/user/GetPut).component(as: 'StorageComponent')
class StorageComponentImpl {}

Remote DataSource Repository:

[@GetPut](/user/GetPut).repository()
class RemoteDataSourceRepository {}