Flutter路由管理插件go_router_module的使用

安装

如果 juneflow 项目不存在，请按照此指南创建它。
在 juneflow 项目的根目录打开终端，输入以下命令：

june add go_router_module

使用

在 lib/util/config/go_router_module/_.dart 文件中配置路由。

示例代码

以下是一个完整的示例，展示如何使用 go_router_module 插件来管理 Flutter 应用的路由。

1. 配置路由文件

在 lib/util/config/go_router_module/_.dart 文件中定义路由：

// 导入必要的库
import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';

// 定义路由配置
final GoRouter _router = GoRouter(
  routes: [
    // 路由路径为 '/' 的首页
    GoRoute(
      path: '/',
      builder: (context, state) => const HomePage(),
    ),
    // 路由路径为 '/second' 的第二个页面
    GoRoute(
      path: '/second',
      builder: (context, state) => const SecondPage(),
    ),
  ],
);

// 导出路由对象
GoRouter get router => _router;

2. 创建首页组件

创建一个名为 HomePage 的组件，作为应用的首页：

// 导入必要的库
import 'package:flutter/material.dart';

// 定义首页组件
class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('首页'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 导航到 '/second' 页面
            Navigator.pushNamed(context, '/second');
          },
          child: const Text('跳转到第二页'),
        ),
      ),
    );
  }
}

3. 创建第二个页面组件

创建一个名为 SecondPage 的组件，作为应用的第二个页面：

// 导入必要的库
import 'package:flutter/material.dart';

// 定义第二个页面组件
class SecondPage extends StatelessWidget {
  const SecondPage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('第二页'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 返回到首页
            Navigator.pop(context);
          },
          child: const Text('返回首页'),
        ),
      ),
    );
  }
}

4. 在主应用中使用路由

在 main.dart 文件中初始化并使用路由：

// 导入必要的库
import 'package:flutter/material.dart';
import 'util/config/go_router_module/_.dart'; // 导入路由配置

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp.router(
      // 使用 go_router_module 提供的路由
      routerConfig: router,
    );
  }
}

phonegap100 1楼•17 天前

更多关于Flutter路由管理插件go_router_module的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

go_router_module 是一个用于 Flutter 应用的路由管理插件，它基于 go_router 库，提供了更模块化和易于管理的路由配置方式。通过 go_router_module，你可以将路由配置分解为多个模块，从而更好地组织和管理大型应用中的路由。

安装

首先，你需要在 pubspec.yaml 文件中添加 go_router_module 依赖：

dependencies:
  flutter:
    sdk: flutter
  go_router_module: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

基本使用

1. 创建路由模块

你可以通过继承 GoRouterModule 类来创建路由模块。每个模块可以定义自己的路由和页面。

import 'package:flutter/material.dart';
import 'package:go_router_module/go_router_module.dart';

class HomeModule extends GoRouterModule {
  [@override](/user/override)
  List<GoRoute> get routes => [
    GoRoute(
      path: '/home',
      builder: (context, state) => const HomePage(),
    ),
  ];
}

class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Home')),
      body: const Center(child: Text('Welcome to the Home Page!')),
    );
  }
}

2. 注册路由模块

在 main.dart 中，你可以通过 GoRouterModuleRegistry 来注册所有的路由模块。

import 'package:flutter/material.dart';
import 'package:go_router_module/go_router_module.dart';
import 'home_module.dart'; // 导入你定义的路由模块

void main() {
  final registry = GoRouterModuleRegistry();
  registry.register(HomeModule());

  final goRouter = GoRouter(
    routes: registry.routes,
  );

  runApp(MyApp(goRouter: goRouter));
}

class MyApp extends StatelessWidget {
  final GoRouter goRouter;

  const MyApp({Key? key, required this.goRouter}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp.router(
      routerConfig: goRouter,
    );
  }
}

3. 导航

你可以使用 GoRouter 提供的导航方法来进行页面跳转。

import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';

class AnotherPage extends StatelessWidget {
  const AnotherPage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Another Page')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            context.go('/home');
          },
          child: const Text('Go to Home'),
        ),
      ),
    );
  }
}

高级用法

嵌套路由

go_router_module 支持嵌套路由，你可以在一个模块中定义子路由。

class ProfileModule extends GoRouterModule {
  [@override](/user/override)
  List<GoRoute> get routes => [
    GoRoute(
      path: '/profile',
      builder: (context, state) => const ProfilePage(),
      routes: [
        GoRoute(
          path: 'details',
          builder: (context, state) => const ProfileDetailsPage(),
        ),
      ],
    ),
  ];
}

路由守卫

你可以通过 GoRouter 的 redirect 参数来实现路由守卫。

class AuthModule extends GoRouterModule {
  [@override](/user/override)
  List<GoRoute> get routes => [
    GoRoute(
      path: '/login',
      builder: (context, state) => const LoginPage(),
    ),
  ];

  [@override](/user/override)
  String? redirect(BuildContext context, GoRouterState state) {
    final isLoggedIn = false; // 假设这里有一个登录状态检查
    if (!isLoggedIn && state.location != '/login') {
      return '/login';
    }
    return null;
  }
}