Flutter - AutoRoute

介绍

What is AutoRoute?

它是一个 Flutter 导航包，支持强类型参数传递、轻松的深度链接，并使用代码生成来简化路由设置。也就是说，它只需要极少量的代码即可生成应用内部导航所需的一切。

Why AutoRoute?

如果您的应用需要深层链接、受保护的路由，或者只是需要简洁的路由设置，那么您将需要使用命名/生成路由，并且最终需要为中介参数类编写大量样板代码，检查所需参数 、 提取参数等等。AutoRoute 可以为您完成所有这些工作，甚至更多。

安装

将以下依赖项添加到您的 pubspec.yaml 文件：

1
2
3
4
5
6
dependencies:
 auto_route: [latest-version]

dev_dependencies:
 auto_route_generator: [latest-version]
 build_runner:
1
flutter pub add auto_route dev:auto_route_generator dev:build_runner

LeanBuilder 支持

auto_route_generator：（10.2.3+）现在支持 LeanBuilder 实现超快速增量构建。

要使用 lean_builder 而不是 build_runner，只需将其添加到您的 dev_dependencies 中：

1
2
3
dev_dependencies:
  auto_route_generator: <latest-version>
  lean_builder: <latest-version>

然后使用以下命令运行构建器：进行一次性构建

1
dart run lean_builder build

用于查看文件并根据更改进行重建

1
dart run lean_builder watch

要禁用 auto_route_generator 使用 build_runner，您可以将以下内容添加到 build.yaml 文件中：

1
2
3
4
5
6
7
targets:
  $default:
    builders:
      auto_route_generator:auto_route_generator:
        enabled: false
      auto_route_generator:auto_router_generator:
        enabled: false

设置和使用

  1. 创建一个路由器类并用 @AutoRouterConfig 注释它，然后从 auto_route 包中扩展“RootStackRouter”
  2. 重写路由获取并开始添加路由
1
2
3
4
5
6
7
8
@AutoRouterConfig()
class AppRouter extends RootStackRouter {

  @override
  List<AutoRoute> get routes => [
    /// routes go here
  ];
}

Using part builder

要生成部分文件，只需向 AppRouter 添加 part 指令。

注意： deferredLoading 功能不适用于部分文件设置。