路由(Route)在移动开发中通常指页面(Page),Route在Android中通常指一个Activity,在iOS中指一个ViewController。路由管理,就是管理页面之间如何跳转。Flutter中的路由管理和原生开发类似,无论是Android还是iOS,导航管理都会维护一个路由栈,路由入栈(push)操作对应打开一个新页面,路由出栈(pop)操作对应页面关闭操作,而路由管理主要是指如何来管理路由栈。
MaterialPageRoute
MaterialPageRoute
继承自PageRoute
,PageRoute
是一个抽象类,表示占有整个屏幕空间的一个模态路由页面,它还定义了路由构建及切换时过渡动画的相关接口及属性。MaterialPageRoute
是Material
组件库提供的组件,它可以针对不同平台,实现与平台页面切换动画风格一致的路由切换动画。对于Android,当打开新页面时,新的页面会从屏幕底部滑动到屏幕顶部;当关闭页面时,当前页面会从屏幕顶部滑动到屏幕底部后消失,同时上一个页面会显示到屏幕上。
对于iOS,当打开页面时,新的页面会从屏幕右侧边缘一致滑动到屏幕左边,直到新页面全部显示到屏幕上,而上一个页面则会从当前屏幕滑动到屏幕左侧而消失;当关闭页面时,正好相反,当前页面会从屏幕右侧滑出,同时上一个页面会从屏幕左侧滑入。
MaterialPageRoute
构造函数:
MaterialPageRoute({
WidgetBuilder builder,
RouteSettings settings,
bool maintainState = true,
bool fullscreenDialog = false,
})
- builder
一个WidgetBuilder类型的回调函数,它的作用是构建路由页面的具体内容,返回值是一个widget。通常要实现此回调,返回新路由的实例。 - settings
包含路由的配置信息,如路由名称、是否初始路由(首页)。 - maintainState
默认情况下,当入栈一个新路由时,原来的路由仍然会被保存在内存中,如果想在路由没用的时候释放其所占用的所有资源,可以设置maintainState为false。 - fullscreenDialog
表示新的路由页面是否是一个全屏的模态对话框,在iOS中,如果fullscreenDialog为true,新页面将会从屏幕底部滑入(而不是水平方向)。
Navigator
Navigator
是一个路由管理的组件,它提供了打开和退出路由页方法。Navigator
通过一个栈来管理活动路由集合。通常当前屏幕显示的页面就是栈顶的路由。Navigator
提供了一系列方法来管理路由栈,最常用的两个方法:
- Future push(BuildContext context, Route route)
将给定的路由入栈(即打开新的页面),返回值是一个Future对象,用以接收新路由出栈(即关闭)时的返回数据。 - bool pop(BuildContext context, [ result ])
将栈顶路由出栈,result为页面关闭时返回给上一个页面的数据。
Navigator
还有很多其它方法,详情请参考文档。
路由传值
很多时候,在路由跳转或者返回上一级时需要带一些参数。代码示例:
class FirstPage extends StatefulWidget {
@override
_FirstPageState createState() => _FirstPageState();
}
class _FirstPageState extends State<FirstPage> {
String _text = '';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('第一页'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text('返回传参:$_text'),
RaisedButton(
onPressed: () => _goToSecondPage(context),
child: Text('下一页'),
),
],
),
),
);
}
void _goToSecondPage(BuildContext context) {
Navigator.push(context, MaterialPageRoute(builder: (context) {
return SecondPage(text: '第二页');
})).then((value) {
setState(() {
_text = value;
});
});
}
}
class SecondPage extends StatelessWidget {
SecondPage({
Key key,
this.text,
}) : super(key: key);
final String text;
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('第二页'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text(text),
RaisedButton(
onPressed: () => Navigator.pop(context, '返回值'),
child: Text('返回'),
),
],
),
),
);
}
}
在SecondPage中有两种方式可以返回到上一页;第一种方式时直接点击导航栏返回箭头,第二种方式是点击页面中的“返回”按钮。这两种返回方式的区别是前者不会返回数据给上一个路由,而后者会。如果点击页面中的返回按钮也想返回数据,有两种方法:
- 自定义返回的按钮
appBar: AppBar(
title: Text("第二页"),
leading: IconButton(
icon: Icon(Icons.arrow_back_ios),
onPressed: () {
Navigator.of(context).pop("返回值");
},
),
),
- 监听返回按钮点击(给Scaffold包裹一个WillPopScope)
WillPopScope
有一个onWillPop
的回调函数,当点击返回按钮时会执行,这个函数要求有一个Future的返回值:
true:系统会自动执行pop操作
false:系统不再执行pop操作,需要自己来执行
return WillPopScope(
onWillPop: () {
Navigator.pop(context, '返回值');
return Future.value(false);
},
child: Scaffold(
appBar: AppBar(
title: Text('第二页'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text(text),
RaisedButton(
onPressed: () => Navigator.pop(context, '返回值'),
child: Text('返回'),
),
],
),
),
),
);
命名路由
命名路由(Named Route)即有名字的路由,可以先给路由起一个名字,然后就可以通过路由名字直接打开新的路由了。
路由表
要想使用命名路由,必须先提供并注册一个路由表(routing table),这样应用程序才知道哪个名字与哪个路由组件相对应。路由表的定义如下:
Map<String, WidgetBuilder> routes;
它是一个Map
,key
为路由的名字,是个字符串;value
是个builder
回调函数,用于生成相应的路由widget
。在通过路由名字打开新路由时,应用会根据路由名字在路由表中查找到对应的 WidgetBuilder
回调函数,然后调用该回调函数生成路由widget
并返回。
注册路由表
路由表的注册方式很简单,在build方法中找到MaterialApp,添加routes属性。代码示例:
MaterialApp(
title: 'Route Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
// 注册路由表
routes:{
'secondPage': (context) => SecondPage(),
// 省略其它路由注册信息
} ,
home: FirstPage(),
);
如果也想将home注册为命名路由,只需在路由表中注册一下FirstPage
路由,然后将其名字作为MaterialApp
的initialRoute
属性值即可。代码示例:
MaterialApp(
title: 'Route Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
// 名为"/"的路由作为应用的home(首页)
initialRoute: '/',
// 注册路由表
routes:{
'/': (context) => FirstPage(),
'secondPage': (context) => SecondPage(),
// 省略其它路由注册信息
} ,
);
通过路由名打开新路由页
要通过路由名称来打开新路由,可以使用Navigator 的pushNamed方法:
Future pushNamed(BuildContext context, String routeName,{Object arguments})
代码示例:
void _goToSecondPage(BuildContext context) {
Navigator.pushNamed(context, 'secondPage').then((value) {
setState(() {
_text = value;
});
});
}
依然可以打开新的路由页,同样可以接收返回参数。
命名路由参数传递
在路由页通过RouteSetting对象获取路由参数:
class SecondPage extends StatelessWidget {
@override
Widget build(BuildContext context) {
// 获取路由参数
var args = ModalRoute.of(context).settings.arguments;
// 省略无关代码
}
}
在打开路由时传递参数:
Navigator.of(context).pushNamed("secondPage", arguments: "第二页");
如果想将上面路由传参示例中的SecondPage路由页注册到路由表中,以便也可以通过路由名来打开它。但是,由于SecondPage接受一个text参数,可以不改变SecondPage源码的前提下适配这种情况:
MaterialApp(
// 省略无关代码
routes: {
'secondPage': (context) => SecondPage(text: ModalRoute.of(context).settings.arguments),
},
);