初略讲解Flutter的路由管理

知识星海
1,594 阅读7分钟

什么是路由管理？

路由（Route）在移动开发中通常指页面（Page），这跟Web开发中单页面应用的Route概念意义是相同的，Route在Android中通常指一个Activity，在iOS中指一个ViewController。所谓路由管理，就是管理页面之间如何跳转，通常也可被称为导航管理。这和原生开发类似，无论是Android还是iOS，导航管理都会维护一个路由栈，路由入栈（push）操作，对应打开一个新页面，路由出栈（pop）操作，关闭对应页面，而路由管理主要是指如何来管理路由栈。

示例代码

在上一节“计数器”示例的基础上，做如下修改：

1、创建一个新路由，命名“NewRoute”

class NewRoute extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return new Scaffold(
      appBar: AppBar(
        title: Text("New route"),
      ),
      body: new Center(
        child: Text("This is new route"),
      ),
    );
  }
}

新路由继承自StatelessWidget，页面很简单，只在页面中间显示了一句“This is new route”。

2、在_MyHomePageState.build方法中的Column的子Widget中添加一个按钮FlatButton：

child: Column(
    mainAxisAlignment: MainAxisAlignment.center,
    children: <Widget>[
        //...省略无关代码
        FlatButton(
            child: Text("open new route"),
            textColor: Colors.blue,
            onPressed: (){
                //导航到新路由
                Navigator.push(context, new MaterialPageRoute(builder: (context){
                  return new NewRoute();
                }));
            },
        ),
    ],
)

添加了一个打开新路由的按钮，并将按钮文字颜色设置为蓝色，点击该按钮后就会打开新的路由页面。

示例分析

一、Navigator

Navigator是一个路由管理的Widget，它提供了打开和退出路由页方法。Navigator通过一个栈来管理活动路由集合，通常当前屏幕显示的页面就是栈顶的路由。Navigator提供了一系列方法来管理路由栈，在此只介绍其最常用的两个方法：

1、push方法

static Future<T> push<T extends Object>(BuildContext context, Route<T> route) {
    return Navigator.of(context).push(route);
}

将给定的路由入栈（即打开新的页面），返回值是一个Future对象，用于接收路由出栈（即关闭页面）时的返回数据。

2、pop方法

static bool pop<T extends Object>(BuildContext context, [ T result ]) {
    return Navigator.of(context).pop<T>(result);
}

将栈顶路由出栈，result为当前栈顶页面关闭时返回给下一个即将成为栈顶页面的数据。

细心的读者也许会发现以上两个静态方法的方法体中都是return Navigator.of(context)，这说明在Navigator类中所有的第一个参数为context的静态方法，它都会对应一个Navigator.of(context)的类方法。因此，Navigator.push(BuildContext context, Route route)等价于Navigator.of(BuildContext context).push(Route route)。

Navigator还有很多其他方法，如Navigator.replace、Navigator.popUntil等，详情请参考API文档或SDK源码注释，在此不再一一列举。

二、MaterialPageRoute

MaterialPageRoute继承自PageRoute类，PageRoute类是一个抽象类，表示占有整个屏幕空间的一个模态路由页面，它还定义了路由构建及切换时过渡动画的相关接口及属性。MaterialPageRoute是Material组件库的一个Widget，它可以针对不同平台，实现与平台页面切换动画风格一致的路由切换动画：

  • Android平台：当打开新页面时，新的页面会从屏幕底部滑动到屏幕顶部；当关闭页面时，当前页面会从屏幕顶部滑动到屏幕底部后消失，同时上一个页面会显示在屏幕上。（竖直方向）
  • iOS平台：当打开新页面时，新的页面会从屏幕右侧边缘滑动到屏幕左侧，直到新页面全部显示在屏幕上，而上一个页面则会从当前屏幕滑动到屏幕左侧后消失；当关闭页面时，正好相反，当前页面会从屏幕右侧滑出，同时上一个页面会从屏幕左侧滑入。（水平方向）

如果想自定义路由切换动画，可以继承PageRoute来实现，当然笔者也会在后面介绍动画时，来实现一个自定义的路由Widget。

下面介绍一下MaterialPageRoute构造函数的各个参数的意义：

MaterialPageRoute({
    WidgetBuilder builder,
    RouteSettings settings,
    this.maintainState = true,
    bool fullscreenDialog = false,
})
  • builder：是一个WidgetBuilder类型的回调函数，它的作用是构建路由页面的具体内容,返回值是一个Widget，实现此回调函数时，需要返回给它一个新路由的实例。
  • settings：包含路由的配置信息，如路由名称、是否初始路由（首页）。
  • maintainState：默认情况下，当入栈一个新路由时，原来的路由仍然会被保存在内存中，如果想在路由没用的时候释放其所占用的所有资源，可以设置maintainState为false。
  • fullscreenDialog：表示新的路由页面是否是一个全屏的模态对话框，在iOS中，如果fullscreenDialog为true，新页面将会从屏幕底部滑入（而不是水平方向）。

路由传值

很多时候，在路由跳转时我们需要带一些参数，比如打开商品详情页时，需要带一个商品id，这样商品详情页才知道展示哪个商品信息；又比如我们在填写订单时需要选择收货地址，打开地址选择页后，可以将用户选择的地址返回到订单页等等，下面我们通过一个简单的示例来演示两个路由之间如何传参。

示例

我们创建一个SelectAddressRoute路由，它接受一个用户信息参数，负责将传给它的参数显示在其页面上，另外SelectAddressRoute中我们添加一个“返回”按钮，点击后在返回上一个路由的同时会带上一个返回参数，下面我们看一下实现代码。

SelectAddressRoute实现代码：

class SelectAddressRoute extends StatelessWidget {
  const SelectAddressRoute({
    Key key,
    @required this.text, //接收一个text参数
  }):super(key:key);

  final String text;

  @override
  Widget build(BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("选择收货地址"),
      ),
      body: Padding(
        padding: EdgeInsets.all(18.0),
        child: Center(
          child: Column(
            children: <Widget>[
              Text(text),
              RaisedButton(
                onPressed: () => Navigator.pop(context, "湖南长沙"),
                child: Text("返回"),
              )
            ],
          ),
        ),
      ),
    );
  }
}

FillInOrderRoute实现代码：

class FillInOrderRoute extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("填写订单"),
      ),
      body: Padding(
        padding: EdgeInsets.all(18.0),
        child: Center(
          child: Column(
            children: <Widget>[
              RaisedButton(
                child: Text("选择收货地址"),
                onPressed: () async{
                  //打开SelectAddressRoute路由，并等待返回结果
                  var result = await Navigator.push(
                    context, 
                    MaterialPageRoute(
                      builder: (context) {
                        return SelectAddressRoute(
                          //路由参数
                          text: "用户名：Zane",
                        );
                      }
                    )
                  );
                  //输出SelectAddressRoute路由返回结果
                  print("路由返回值：$result");
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}

运行代码，点击FillInOrderRoute页的“选择收货地址”按钮，会打开SelectAddressRoute页，运行效果如下：

说明：

  1. 用户信息“用户名：Zane”是通过SelectAddressRoute的text参数传递给新路由页的。通过等待Navigator.push(...)返回的Future来获取新路由的返回数据。
  2. 在SelectAddressRoute页中有两种方式可以返回到上一页，第一种方式是直接点击导航栏返回箭头，第二种方式是点击页面中的“返回”按钮。这两种返回方式的区别是前者不会返回数据给上一个路由，而后者会。下面是分别点击页面中的“返回”按钮和导航栏返回箭头后，FillInOrderRoute页中print方法在控制台输出的内容：
    I/flutter (12310): 路由返回值：湖南长沙
I/flutter (12310): 路由返回值：null

以上介绍的是非命名路由的传值方式，命令路由的传值方式会有所不同，我们会在下面介绍命名路由时介绍命名路由如何传值。

命名路由

所谓命名路由（Named Route）即给路由起一个名字，然后可以通过路由名字直接打开新的路由，这为路由管理带来了一种直观、简便的方式。

路由表

要想使用命名路由，必须先提供并注册一个路由表（routing table），这样应用程序才知道哪个名称与哪个路由Widget对应，路由表的定义如下：

Map<String, WidgetBuilder> routes;

它是一个Map，key为路由的名称，字符串类型；value是一个builder回调函数，用于生成相应的路由Widget。在通过路由名称入栈新路由时，应用会根据路由名称在路由表中找到对应的WidgetBuilder回调函数，然后调用该回调函数生成路由Widget并返回。

注册路由表

需要先注册路由表，Flutter应用才能正确处理命名路由的跳转。注册方式很简单，在MyApp类的build方法中找到MaterialApp，添加routes属性，代码如下：

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
      //注册路由表
      routes: {
        "new_page":(context)=>NewRoute(),
      },
    );
  }
}

在上面的代码中home路由并没有使用命名路由，如果我们也想将home注册为命名路由应该怎么做呢？直接看代码：

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      initialRoute: "/", //名为"/"的路由作为应用的home(首页)
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      //注册路由表
      routes: {
        "new_page":(context)=>NewRoute(),
        "/":(context)=>MyHomePage(title: 'Flutter Demo Home Page'), //注册首页路由
      },
    );
  }
}

可以看到，我们只需要在路由表中注册一下MyHomePage路由，然后将其名字作为MaterialApp的initialRoute属性值即可，该属性决定应用的初始路由页是哪一个命名路由。

通过路由名称打开新路由页面

要通过路由名称来打开新路由，可以使用Navigator的pushNamed方法：

Future pushNamed(BuildContext context, String routeName,{Object arguments})

Navigator除了pushNamed方法，还有pushReplacementNamed等其他管理命名路由的方法，读者可以自行查看API文档。

接下来我们通过路由名称来打开新的路由页面，修改FlatButton的onPressed回调代码，改为：

onPressed: (){
    //导航到新路由
    Navigator.pushNamed(context, "new_page");
}

保存代码并热重载应用，再次点击“open new route”按钮，依然可以打开新的路由页面。

命名路由参数传递

在Flutter最初的版本中，命名路由是不能传递参数的，后来才支持可传递参数，下面展示命名路由如何传递并获取路由参数：

1、注册路由表：

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      //...省略无关代码
      //注册路由表
      routes: {
        "echo_page":(context)=>EchoRoute(),
      },
    );
  }
}

2、在路由页面通过RouteSetting对象获取路由参数：

class EchoRoute extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    //获取路由参数
    var args = ModalRoute.of(context).settings.arguments;
    return new Scaffold(
      appBar: AppBar(
        title: Text(args),
      ),
    );
  }
}

3、在打开路由时传递参数：

Navigator.pushNamed(context, "echo_page", arguments:"Hi");

适配

如果我们也想将上面路由传参示例中的SelectAddressRoute路由页注册到路由表中，以便通过路由名来打开它，但是SelectAddressRoute接收一个text参数，那么我们如何在不改变SelectAddressRoute代码的前提下适配这种情况呢？直接看代码：

MaterialApp(
    ... //省略无关代码
    routes: {
        "select_address_page": (context){
            return SelectAddressRoute(text: ModalRoute.of(context).settings.arguments);
        },
    }, 
);

然后在打开SelectAddressRoute路由时传递参数：

Navigator.pushNamed(context, "select_address_page", arguments: "zane");

路由生成钩子

假设我们要开发一个电商APP，当用户没有登录时可以看店铺、商品等信息，但交易记录、购物车和用户个人信息等页面需要登录后才能查看。为了实现上述功能，我们需要在打开每一个路由页前判断用户登录状态！如果每次打开路由前我们都需要去判断一下将会非常麻烦，那有什么更好的办法吗？答案是有！

MaterialApp有一个onGenerateRoute属性，它在打开命名路由时可能会被调用，之所以说可能，是因为当调用Navigator.pushNamed(...)打开命名路由时，如果指定的路由名在路由表中已注册，则会调用路由表中的builder函数来生成路由组件；如果路由表中没有注册，才会调用onGenerateRoute来生成路由。onGenerateRoute回调签名如下：

Route<dynamic> Function(RouteSettings settings)

有了onGenerateRoute回调，要实现上面控制页面权限的功能就非常容易：我们放弃使用路由表，取而代之的是提供一个onGenerateRoute回调，然后在该回调中进行统一的权限控制，下面我们继续以上面的路由传参示例为例：

  1. MyApp实现代码：
    import 'package:flutter/material.dart';

void main() => runApp(MyApp());

bool isLogin = false;

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: FillInOrderRoute(),
      //注册路由表
      routes: {},
      onGenerateRoute: (RouteSettings setting) {
        return MaterialPageRoute(builder: (context){
          String routeName = setting.name;
           // 如果访问的路由页需要登录，但当前未登录，则直接返回登录页路由，引导用户登录；其它情况则正常打开路由。
          if(routeName == "select_address_page" && !isLogin){
            return LoginTextFieldApp();
          }else {
            return SelectAddressRoute(text: setting.arguments);
          }
        });
      },
    );
  }
}
  2. FillInOrderRoute实现代码：
    class FillInOrderRoute extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("填写订单"),
      ),
      body: Padding(
        padding: EdgeInsets.all(18.0),
        child: Center(
          child: Column(
            children: <Widget>[
              RaisedButton(
                child: Text("选择收货地址"),
                onPressed: () async{
                  var result = await Navigator.pushNamed(context, "select_address_page", arguments: "zane");
                  //输出SelectAddressRoute路由返回结果
                  print("路由返回值：$result");
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}
  3. SelectAddressRoute实现代码：
    class SelectAddressRoute extends StatelessWidget {
  const SelectAddressRoute({
    Key key,
    @required this.text, //接收一个text参数
  }):super(key:key);

  final String text;

  @override
  Widget build(BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("选择收货地址"),
      ),
      body: Padding(
        padding: EdgeInsets.all(18.0),
        child: Center(
          child: Column(
            children: <Widget>[
              Text(text),
              RaisedButton(
                onPressed: () => Navigator.pop(context, "湖南长沙"),
                child: Text("返回"),
              )
            ],
          ),
        ),
      ),
    );
  }
}

登录路由代码就不在此粘贴了，我相信读者可以自行解决！如果不能的话，请看《初略讲解Flutter的TextField及Form》一文。

总结

本章先介绍了Flutter中路由管理、传参的方式，然后又着重介绍了命名路由相关内容。在此需要说明一点，由于命名路由只是一种可选的路由管理方式，在实际开发中，读者可能心中会犹豫到底使用哪种路由管理方式。在此，根据笔者经验，建议读者最好统一使用命名路由的管理方式，这将会带来如下好处：

  • 语义化更明确。
  • 代码更好维护；如果使用匿名路由，则必须在调用Navigator.push的地方创建新路由页，这样不仅需要import新路由页的dart文件，而且这样的代码将会非常分散。
  • 可以通过onGenerateRoute在全局的路由跳转前做一些逻辑处理。

综上所述，笔者比较建议使用命名路由，但读者可以根据自己偏好或实际情况来决定。

另外，还有一些关于路由管理的内容我们没有介绍，比如路由MaterialApp中还有navigatorObservers和onUnknownRoute两个回调属性，前者可以监听所有路由跳转动作，后者在打开一个不存在的命名路由时会被调用，由于这些功能并不常用，而且也比较简单，我们便不再花费篇幅来介绍了，读者可以自行查看API文档。

avatar
文章
阅读
粉丝