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

一、一个简单示例

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

  1. 创建一个新路由，命名NewRoute

    1. class NewRoute extends StatelessWidget {
    2. @override
    3. Widget build(BuildContext context) {
    4.  return Scaffold(
    5.    appBar: AppBar(
    6.      title: Text("New route"),
    7.    ),
    8.    body: Center(
    9.      child: Text("This is new route"),
    10.    ),
    11.  );
    12. }
    13. }

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

  2. 在_MyHomePageState.build方法中的Column的子widget中添加一个按钮（FlatButton） :

    1. Column(
    2.    mainAxisAlignment: MainAxisAlignment.center,
    3.    children: <Widget>[
    4.     //...省略无关代码
    5.    FlatButton(
    6.       child: Text("open new route"),
    7.       textColor: Colors.blue,
    8.       onPressed: () {
    9.        //导航到新路由   
    10.        Navigator.push( context,
    11.         MaterialPageRoute(builder: (context) {
    12.            return NewRoute();
    13.         }));
    14.        },
    15.       ),
    16.     ],
    17. )

完整代码main.dart
  1. import 'package:flutter/material.dart';
  3. void main() => runApp(new MyApp());
  5. class MyApp extends StatelessWidget {
  6.   @override
  7.   Widget build(BuildContext context) {
  8.     return new MaterialApp(
  9.       title: 'Flutter Demo',
  10.       theme: new ThemeData(
  11.         primarySwatch: Colors.blue,
  12.       ),
  13.       home: new MyHomePage(title: 'Flutter Demo Home Page'),
  14.     );
  15.   }
  16. }
  18. class MyHomePage extends StatefulWidget {
  19.   MyHomePage({Key key, this.title}) : super(key: key);
  20.   final String title;
  21.   @override
  22.   _MyHomePageState createState() => new _MyHomePageState();
  23. }
  25. class _MyHomePageState extends State<MyHomePage> {
  26.   int _counter = 0;
  27.   void _incrementCounter() {
  28.     setState(() {
  29.       _counter++;
  30.     });
  31.   }
  33.   @override
  34.   Widget build(BuildContext context) {
  35.     return new Scaffold(
  36.       appBar: new AppBar(
  37.         title: new Text(widget.title),
  38.       ),
  39.       body: new Center(
  40.         child: new Column(
  41.           mainAxisAlignment: MainAxisAlignment.center,
  42.           children: <Widget>[
  43.             new Text(
  44.               'You have pushed the button this many times:',
  45.             ),
  46.             new Text(
  47.               '$_counter',
  48.               style: Theme.of(context).textTheme.display1,
  49.             ),
  50.             FlatButton(
  51.               child: Text("open new route"),
  52.               textColor: Colors.blue,
  53.               onPressed: () {
  54.                 //导航到新路由
  55.                 Navigator.push(context, MaterialPageRoute(builder: (context) {
  56.                   return NewRoute();
  57.                 }));
  58.               },
  59.             ),
  60.           ],
  61.         ),
  62.       ),
  63.       floatingActionButton: new FloatingActionButton(
  64.         onPressed: _incrementCounter,
  65.         tooltip: 'Increment',
  66.         child: new Icon(Icons.add),
  67.       ), // This trailing comma makes auto-formatting nicer for build methods.
  68.     );
  69.   }
  70. }
  72. class NewRoute extends StatelessWidget {
  73.   @override
  74.   Widget build(BuildContext context) {
  75.     return Scaffold(
  76.       appBar: AppBar(
  77.         title: Text("New route"),
  78.       ),
  79.       body: Center(
  80.         child: Text("This is new route"),
  81.       ),
  82.     );
  83.   }
  84. }

我们添加了一个打开新路由的按钮，并将按钮文字颜色设置为蓝色，点击该按钮后就会打开新的路由页面，效果如图2-2和2-3所示。
路由管理 - 图1 路由管理 - 图2

MaterialPageRoute

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

  • 对于Android，当打开新页面时，新的页面会从屏幕底部滑动到屏幕顶部；当关闭页面时，当前页面会从屏幕顶部滑动到屏幕底部后消失，同时上一个页面会显示到屏幕上。
  • 对于iOS，当打开页面时，新的页面会从屏幕右侧边缘一致滑动到屏幕左边，直到新页面全部显示到屏幕上，而上一个页面则会从当前屏幕滑动到屏幕左侧而消失；当关闭页面时，正好相反，当前页面会从屏幕右侧滑出，同时上一个页面会从屏幕左侧滑入。

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

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

    如果想自定义路由切换动画，可以自己继承PageRoute来实现，我们将在后面介绍动画时，实现一个自定义的路由组件。

Navigator

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

Future push(BuildContext context, Route route)

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

bool pop(BuildContext context, [ result ])

将栈顶路由出栈，result为页面关闭时返回给上一个页面的数据。

Navigator 还有很多其它方法，如Navigator.replace、Navigator.popUntil等，详情请参考API文档或SDK源码注释，在此不再赘述。下面我们还需要介绍一下路由相关的另一个概念“命名路由”。

实例方法

Navigator类中第一个参数为context的静态方法都对应一个Navigator的实例方法， 比如Navigator.push(BuildContext context, Route route)等价于Navigator.of(context).push(Route route) ，下面命名路由相关的方法也是一样的

路由传值

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

示例

我们创建一个TipRoute路由，它接受一个提示文本参数，负责将传入它的文本显示在页面上，另外TipRoute中我们添加一个“返回”按钮，点击后在返回上一个路由的同时会带上一个返回参数，下面我们看一下实现代码。
TipRoute实现代码：

  1. class TipRoute extends StatelessWidget {
  2.   TipRoute({
  3.     Key key,
  4.     @required this.text,  // 接收一个text参数
  5.   }) : super(key: key);
  6.   final String text;
  7.   @override
  8.   Widget build(BuildContext context) {
  9.     return Scaffold(
  10.       appBar: AppBar(
  11.         title: Text("提示"),
  12.       ),
  13.       body: Padding(
  14.         padding: EdgeInsets.all(18),
  15.         child: Center(
  16.           child: Column(
  17.             children: <Widget>[
  18.               Text(text),
  19.               RaisedButton(
  20.                 onPressed: () => Navigator.pop(context, "我是返回值"),
  21.                 child: Text("返回"),
  22.               )
  23.             ],
  24.           ),
  25.         ),
  26.       ),
  27.     );
  28.   }
  29. }

下面是打开新路由TipRoute的RouterTestRoute类代码：

  1. class RouterTestRoute extends StatelessWidget {
  2.   @override
  3.   Widget build(BuildContext context) {
  4.     return Center(
  5.       child: RaisedButton(
  6.          child: Text("打开提示页"),
  7.         onPressed: () async {
  8.           // 打开`TipRoute`，并等待返回结果
  9.           var result = await Navigator.push(
  10.             context,
  11.             MaterialPageRoute(
  12.               builder: (context) {
  13.                 return TipRoute(
  14.                   // 路由参数
  15.                   text: "我是提示xxxx",
  16.                 );
  17.               },
  18.             ),
  19.           );
  20.           //输出`TipRoute`路由返回结果
  21.           print("路由返回值: $result");
  22.         },
  23.       ),
  24.     );
  25.   }
  26. }

运行上面代码，点击RouterTestRoute页的“打开提示页”按钮，会打开TipRoute页，运行效果如图2-4所示下：
路由管理 - 图3
需要说明：

  1. 提示文案“我是提示xxxx”是通过TipRoute的text参数传递给新路由页的。我们可以通过async/await等待Navigator.push(…)返回的Future来获取新路由的返回数据。
  2. 在TipRoute页中有两种方式可以返回到上一页
    • 第一种方式时直接点击导航栏返回箭头，不会带上数据返回给上一个路由
    • 第二种方式是点击页面中的“返回”按钮。可以带上数据返回给上一个路由

下面是分别点击页面中的返回按钮和导航栏返回箭头后，RouterTestRoute页中print方法在控制台输出的内容：

  1. I/flutter (27896): 路由返回值: 我是返回值
  2. I/flutter (27896): 路由返回值: null

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

命名路由

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

路由表

要想使用命名路由，我们必须先提供并注册一个路由表（routing table），这样应用程序才知道哪个名字与哪个路由组件相对应。其实注册路由表就是给路由起名字，路由表的定义如下：

  1. Map<String, WidgetBuilder> routes;

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

注册路由表

路由表的注册方式很简单，我们回到之前“计数器”的示例，然后在MyApp类的build方法中找到MaterialApp，添加routes属性，代码如下：

  1. MaterialApp(
  2.   title: 'Flutter Demo',
  3.   theme: ThemeData(
  4.     primarySwatch: Colors.blue,
  5.   ),
  6.   //注册路由表
  7.   routes:{
  8.    "new_page":(context) => NewRoute(),
  9.     // ... 省略其它路由注册信息
  10.   } ,
  11.   home: MyHomePage(title: 'Flutter Demo Home Page'),
  12. );

现在我们就完成了路由表的注册。上面的代码中home路由并没有使用命名路由，如果我们也想将home注册为命名路由应该怎么做呢？其实很简单，直接看代码：

  1. MaterialApp(
  2.   title: 'Flutter Demo',
  3.   initialRoute:"//", //名为"//"的路由作为应用的home(首页)
  4.   theme: ThemeData(
  5.     primarySwatch: Colors.blue,
  6.   ),
  7.   //注册路由表
  8.   routes:{
  9.    "new_page":(context) => NewRoute(),
  10.    "//":(context) => MyHomePage(title: 'Flutter Demo Home Page'), //注册首页路由
  11.   } 
  12. );

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

通过路由名打开新路由页

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

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

Navigator 除了pushNamed方法，还有pushReplacementNamed等其他管理命名路由的方法，读者可以自行查看API文档。接下来我们通过路由名来打开新的路由页，修改FlatButton的onPressed回调代码，改为：

  1. onPressed: () {
  2.   Navigator.pushNamed(context, "new_page");
  3.   //Navigator.push(context,
  4.   //  MaterialPageRoute(builder: (context) {
  5.   //  return NewRoute();
  6.   //}));  
  7. },

完整代码
  1. import 'package:flutter/material.dart';
  3. Map<String, WidgetBuilder> routes;
  4. void main() => runApp(new MyApp());
  6. class MyApp extends StatelessWidget {
  7.   @override
  8.   Widget build(BuildContext context) {
  9.     return new MaterialApp(
  10.       title: 'Flutter Demo',
  11.       theme: new ThemeData(
  12.         primarySwatch: Colors.blue,
  13.       ),
  14.       home: new MyHomePage(title: 'Flutter Demo Home Page'),
  15.       initialRoute: "//", //名为"//"的路由作为应用的home(首页)
  16.       //注册路由表
  17.       routes: {
  18.         "//":(context) => MyHomePage(title: 'Flutter Demo Home Page'), //注册首页路由
  19.         "new_route": (context) => NewRoute(),
  20.       },
  21.     );
  22.   }
  23. }
  25. class MyHomePage extends StatefulWidget {
  26.   MyHomePage({Key key, this.title}) : super(key: key);
  27.   final String title;
  28.   @override
  29.   _MyHomePageState createState() => new _MyHomePageState();
  30. }
  32. class _MyHomePageState extends State<MyHomePage> {
  33.   int _counter = 0;
  34.   void _incrementCounter() {
  35.     setState(() {
  36.       _counter++;
  37.     });
  38.   }
  40.   @override
  41.   Widget build(BuildContext context) {
  42.     return new Scaffold(
  43.       appBar: new AppBar(
  44.         title: new Text(widget.title),
  45.       ),
  46.       body: new Center(
  47.         child: new Column(
  48.           mainAxisAlignment: MainAxisAlignment.center,
  49.           children: <Widget>[
  50.             new Text(
  51.               'You have pushed the button this many times:',
  52.             ),
  53.             new Text(
  54.               '$_counter',
  55.               style: Theme.of(context).textTheme.display1,
  56.             ),
  57.             FlatButton(
  58.               child: Text("open new route"),
  59.               textColor: Colors.blue,
  60.               onPressed: () {
  61.                 //导航到新路由
  62.                 Navigator.pushNamed(context, "new_route");
  63.                 // Navigator.push(context, MaterialPageRoute(builder: (context) {
  64.                 //   return NewRoute();
  65.                 // }));
  66.               },
  67.             ),
  68.           ],
  69.         ),
  70.       ),
  71.       floatingActionButton: new FloatingActionButton(
  72.         onPressed: _incrementCounter,
  73.         tooltip: 'Increment',
  74.         child: new Icon(Icons.add),
  75.       ), // This trailing comma makes auto-formatting nicer for build methods.
  76.     );
  77.   }
  78. }
  80. class NewRoute extends StatelessWidget {
  81.   @override
  82.   Widget build(BuildContext context) {
  83.     return Scaffold(
  84.       appBar: AppBar(
  85.         title: Text("New route"),
  86.       ),
  87.       body: Center(
  88.         child: Text("This is new route"),
  89.       ),
  90.     );
  91.   }
  92. }

热重载应用，再次点击页面上的open new route按钮，依然可以打开新的路由页

命名路由参数传递

在Flutter最初的版本中，命名路由是不能传递参数的，后来才支持了参数；
下面展示命名路由如何传递并获取路由参数，我们先注册一个路由：

  1. routes:{
  2.    "new_page":(context) => EchoRoute(),
  3.   } ,

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

  1. class EchoRoute extends StatelessWidget {
  2.   @override
  3.   Widget build(BuildContext context) {
  4.     //获取路由参数  
  5.     var args=ModalRoute.of(context).settings.arguments;
  6.     //...省略无关代码
  7.   }
  8. }

在打开路由时传递参数

  1. Navigator.of(context).pushNamed("new_page", arguments: "hi");

完整代码
  1. import 'package:flutter/material.dart';
  3. Map<String, WidgetBuilder> routes;
  4. void main() => runApp(new MyApp());
  6. class MyApp extends StatelessWidget {
  7.   @override
  8.   Widget build(BuildContext context) {
  9.     return new MaterialApp(
  10.       title: 'Flutter Demo',
  11.       theme: new ThemeData(
  12.         primarySwatch: Colors.blue,
  13.       ),
  14.       home: new MyHomePage(title: 'Flutter Demo Home Page'),
  15.       initialRoute: "//", //名为"//"的路由作为应用的home(首页)
  16.       //注册路由表
  17.       routes: {
  18.         "//": (context) => MyHomePage(title: 'Flutter Demo Home Page'), //注册首页路由
  19.         "new_route": (context) => NewRoute(),
  20.         "echo_route": (context) => EchoRoute(),
  21.       },
  22.     );
  23.   }
  24. }
  26. class MyHomePage extends StatefulWidget {
  27.   MyHomePage({Key key, this.title}) : super(key: key);
  28.   final String title;
  29.   @override
  30.   _MyHomePageState createState() => new _MyHomePageState();
  31. }
  33. class _MyHomePageState extends State<MyHomePage> {
  34.   int _counter = 0;
  35.   var gifts = {
  36.     // Key:    Value
  37.     'first': 'partridge',
  38.     'second': 'turtledoves',
  39.     'fifth': 'golden rings'
  40.   };
  41.   void _incrementCounter() {
  42.     setState(() {
  43.       _counter++;
  44.     });
  45.   }
  47.   @override
  48.   Widget build(BuildContext context) {
  49.     return new Scaffold(
  50.       appBar: new AppBar(
  51.         title: new Text(widget.title),
  52.       ),
  53.       body: new Center(
  54.         child: new Column(
  55.           mainAxisAlignment: MainAxisAlignment.center,
  56.           children: <Widget>[
  57.             new Text(
  58.               'You have pushed the button this many times:',
  59.             ),
  60.             new Text(
  61.               '$_counter',
  62.               style: Theme.of(context).textTheme.display1,
  63.             ),
  64.             FlatButton(
  65.               child: Text("open new route"),
  66.               textColor: Colors.blue,
  67.               onPressed: () {
  68.                 //导航到新路由
  69.                 Navigator.of(context).pushNamed("echo_route", arguments: this.gifts);
  70.                 // Navigator.push(context, MaterialPageRoute(builder: (context) {
  71.                 //   return NewRoute();
  72.                 // }));
  73.               },
  74.             ),
  75.           ],
  76.         ),
  77.       ),
  78.       floatingActionButton: new FloatingActionButton(
  79.         onPressed: _incrementCounter,
  80.         tooltip: 'Increment',
  81.         child: new Icon(Icons.add),
  82.       ), // This trailing comma makes auto-formatting nicer for build methods.
  83.     );
  84.   }
  85. }
  87. class NewRoute extends StatelessWidget {
  88.   @override
  89.   Widget build(BuildContext context) {
  90.     return Scaffold(
  91.       appBar: AppBar(
  92.         title: Text("New route"),
  93.       ),
  94.       body: Center(
  95.         child: Text("This is new route"),
  96.       ),
  97.     );
  98.   }
  99. }
  101. class EchoRoute extends StatelessWidget {
  102.   @override
  103.   Widget build(BuildContext context) {
  104.     //获取路由参数
  105.     Map args = ModalRoute.of(context).settings.arguments;
  106.     return Scaffold(
  107.       appBar: AppBar(
  108.         title: Text("New route"),
  109.       ),
  110.       body: Center(
  111.         child: Text(args['first']),
  112.       ),
  113.     );
  114.   }
  115. }

适配

假设我们也想将上面路由传参示例中的TipRoute路由页注册到路由表中，以便也可以通过路由名来打开它。但是，由于TipRoute接受一个text 参数，我们如何在不改变TipRoute源码的前提下适配这种情况？其实很简单：

  1. MaterialApp(
  2.   ... //省略无关代码
  3.   routes: {
  4.    "tip2": (context){
  5.      return TipRoute(text: ModalRoute.of(context).settings.arguments);
  6.    },
  7.  }, 
  8. );

路由生成钩子

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

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

  1. Route<dynamic> Function(RouteSettings settings)

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

  1. MaterialApp(
  2.   ... //省略无关代码
  3.   onGenerateRoute:(RouteSettings settings){
  4.       return MaterialPageRoute(builder: (context){
  5.            String routeName = settings.name;
  6.        // 如果访问的路由页需要登录，但当前未登录，则直接返回登录页路由，
  7.        // 引导用户登录；其它情况则正常打开路由。
  8.      }
  9.    );
  10.   }
  11. );

注意，onGenerateRoute只会对命名路由生效。

总结

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

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

综上所述，笔者比较建议使用命名路由，当然这并不是什么金科玉律，读者可以根据自己偏好或实际情况来决定。
另外，还有一些关于路由管理的内容我们没有介绍，比如路由MaterialApp中还有navigatorObservers和onUnknownRoute两个回调属性，前者可以监听所有路由跳转动作，后者在打开一个不存在的命名路由时会被调用，由于这些功能并不常用，而且也比较简单，我们便不再花费篇幅来介绍了，读者可以自行查看API文档。