flutter 一个简单的Route Helper/Navigator Helper

在flutter中 route是一个绕不开,必须面对,且很常用东西

Route就是路由,顾名思义,负责你页面间的跳转

不想看代码和思路分析的直接copy了拿去用就行没有啥外部依赖,只需要注意_rootRoute 后面的字符串需要和initialRoute 对应即可

路由又分静态和动态路由

静态就是不需要传参数的,这样的路由可以直接定义在MaterialApp/WidgetsApp 里这样可以通过Navigator.pushNamed调用

动态的就是传入一个PageRoute, 通常是一个MaterialPageRoute 或者CupertinoPageRoute,或者你如果有自定义的有可以使用

这里我使用一个我的工具类来实现跳转,因为大部分情况下,工程中的路由都是动态的,也就是需要传参数的,所以工具类中只包含了使用Widget相关的方案


import 'dart:async';
 
import 'package:flutter/material.dart';
 
class RouteHelper {
  static Future<T> pushWidget<T>(
    BuildContext context,
    Widget widget, {
    bool replaceRoot = false,
    bool replaceCurrent = false,
  }) {
    return pushRoute(
      context,
      MaterialPageRoute(builder: (ctx) => widget),
      replaceRoot: replaceRoot,
      replaceCurrent: replaceCurrent,
    );
  }
 
  static Future<T> pushRoute<T>(
    BuildContext context,
    PageRoute<T> route, {
    bool replaceRoot = false,
    bool replaceCurrent = false,
  }) {
    assert(!(replaceRoot == true && replaceCurrent == true));
    if (replaceRoot == true) {
      return Navigator.pushAndRemoveUntil(
        context,
        route,
        _rootRoute,
      );
    }
    if (replaceCurrent == true) {
      return Navigator.pushReplacement(context, route);
    }
    return Navigator.push(context, route);
  }
}
 
var _rootRoute = ModalRoute.withName("home");
复制代码

解析一下这个类,有两个方法,一个是接受PageRoute,一个是接收Widget

接收Widget的是讲Widget包装为MaterialPageRoute,然后传给另一个方法

另一个方法中包含3种情况,一种是替换根节点,一种是替换当前页面(关闭当前,且开启新页面),还有一种就是平常的push(即不关闭当前,直接开启新的)

根据传参不同而有所不同

有一个_rootRoute变量,这个变量的目的是用于替换根节点,'home'是我定义在MaterialApp里的initialRoute,这样一一对应才能确保替换根节点

当然这个类也可以继续扩展,比如将routes定义在内,然后传route name 参数,接着通过routes来提取出named对应的Widget/Route 接着传入pushRoute方法进行跳转即可

这个简便的Helper还有另一个好处,就是可以方便后续批量替换Route实现,比如有一天你想自定义一个PageRoute,不使用MaterialRoute ,那么你只需要替换如下如所示的部分即可

当然还可以有别的扩展方法来支持named 比如查看Navigator的源码发现pushNamed,就是通过widget.onGenerateRoute方法获取到route的,我这里直接在helper中写就好了

Helper 写完了,我们看看使用的方法使用起来也很简单

比如强登陆应用


  void  _login() {
    RouteHelper.pushWidget(context, HomeRootPage(), replaceRoot: true);
  }
复制代码

这里登录成功后,我直接替换了root节点,然后根路由就变成了主页面


  void _forgetPwd() {
    RouteHelper.pushWidget(context, ForgetPwdPage());
  }
 
  void _register() {
    RouteHelper.pushWidget(context, RegiseterPage());
  }
复制代码

忘记密码和注册都基于登录在做,最终要返回登录,所以这里用普通的调用方法


  _register() {
    RouteHelper.pushWidget(
      context,
      RegisterSuccessPage(),
      replaceCurrent: true,
    );
  }
复制代码

注册成功后我这里有一个单独的注册成功页,写了一些注册后的注意事项,而返回又应该直接返回到登录页面,所以这里我需要替换掉当前的页面,只用replaceCurrent 即可

当然方法接受返回值也是允许的


 
  _orderDetail(String item) async {
    //todo 查看订单详情
    var result = await RouteHelper.pushWidget<bool>(context, OrderDetailPage(id: item));
    if (result == true) {
      _refresh();
    }
  }
复制代码

这里如果在详情页买了东西/加到购物车,回到主页面,是要刷新页面的,所以我们接收返回值,然后判断

小tips:这里之所以用result == true 而不是 if(result) 是因为dart中 bool是有3个值的 true false null if(result==true) 可以将result 为 null的情况规避掉,提升代码健壮性,这个不得不说是dart 完全面向对象造成的副作用