代码视界

Hanpeng Chen的个人博客

Flutter | 6-路由管理

本文于 810 天之前发表,文中内容可能已经过时。

路由(Route):在移动开发中通常指页面(page),这跟web开发中单页面应用的Route概念意义是相同的,Route在Android中通常指一个Activity,在iOS中指一个ViewController。

路由管理:就是管理页面之间如何跳转,通常也可被称为导航管理。Flutter中的路由管理和原生开发类似,无论是Android还是iOS,导航管理都会维护一个路由栈,路由入栈(push)操作对应打开一个新页面,路由出栈(pop)操作对应页面关闭操作,而路由管理主要是指如何来管理路由栈。

1、简单示例

我们在计数器的基础上,创建一个新的路由,命名为“NewRoute”,并在_MyHomePageState.build方法中添加一个跳转到该路由的按钮,具体代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import 'package:flutter/material.dart';

class NewRoute extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('new route'),
),
body: Center(
child: Text('这是一个新的route'),
),
);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class _MyHomePageState extends State<MyHomePage> {
...

@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
),
body: Center(

child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
...
FlatButton(
child: Text('open new route'),
textColor: Colors.red,
color: Colors.blue,
onPressed: () {
Navigator.push(context,
MaterialPageRoute(builder: (context) {
return NewRoute();
})
);
},
)
],
),
),
);
}
}

运行应用结果,点击跳转按钮,如下图所示:

2、MaterialPageRoute

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

  • 对于Android,当打开新页面时,新的页面会从屏幕底部滑动到屏幕顶部;当关闭页面时,当前页面会从屏幕顶部滑动到屏幕底部后消失,同时上一个页面会显示到屏幕上。

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

接下来我们来了解一下MaterialPageRoute 构造函数的各个参数的意义:

1
2
3
4
5
6
MaterialPageRoute({
WidgetBuilder builder,
RouteSettings settings,
bool maintainState = true,
bool fullscreenDialog = false,
})

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

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

3、Navigator

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

Future push(BuildContext context, Route route)

将给定的路由入栈,返回值是一个Future对象,用以接收新路由出栈时的返回数据。

bool pop(BuildContext context, [result])

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

Navigator 还有很多其他方法,比如: Navigator.replace 、 Navigator.popUntil等等。

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

4、路由传值

很多时候,在路由跳转时我们需要传递一些参数,比如要打开一个物品详情页,我们需要带一个物品id过去,这样详情页才知道要显示那个物品信息。下面我们通过简单的例子来演示新旧路由如何传参。

创建一个 Detail 路由,它接受一个id参数,并将这个id显示到页面上,另外在 Detail中我们添加一个返回按钮,在返回上一个路由的同时会带上一个返回参数,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';

class Detail extends StatelessWidget {
Detail({
Key key,
@required this.id
}) : super(key: key);
final id;

@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('详情页'),
),
body: Center(
child: Column(
children: <Widget>[
Text('参数id: $id'),
FlatButton(
child: Text('返回'),
onPressed: () {
Navigator.pop(context, 'ID: $id');
},
)
],
),
),
);
}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
FlatButton(
child: Text('跳转到详情页'),
textColor: Colors.red[300],
color: Colors.blue[100],
onPressed: () async {
var result = await Navigator.push(context,
MaterialPageRoute(builder: (context) {
return Detail(id: 123);
})
);
print('路由返回值:$result');
},
)

需要说明:

1、提示文案“参数id: $id”中的id是通过Detail的id参数传递给新路由页的。我们可以通过等待Navigator.push(…)返回的Future来获取新路由的返回数据。

2、在Detail中有两种方式可以返回到上一页;第一种方式时直接点击导航栏返回箭头,第二种方式是点击页面中的“返回”按钮。这两种返回方式的区别是前者不会返回数据给上一个路由,而后者会。下面是分别点击页面中的返回按钮和导航栏返回箭头后,RouterTestRoute页中print方法在控制台输出的内容:

1
2
I/flutter (22361): 路由返回值:ID: 123
I/flutter (22361): 路由返回值:null

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

5、命名路由

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

路由表

要使用命名路由,必须先提供并注册一个路由表(routing table),这样应用程序才知道哪个名字对应哪个路由组件。其实注册路由表就是给路由起名字,路由表的定义如下:

1
Map<String, WidgetBuilder> routes;

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

注册路由表

路由表的注册方式很简单,回到前面用到的例子,找到MaterialApp,添加routes属性,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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'),

initialRoute:"/", //名为"/"的路由作为应用的home(首页)
//注册路由表
routes:{
"new_route":(context) => NewRoute(),
"detail":(context) => Detail(id: 1111,),
"/":(context) => MyHomePage(title: 'Flutter Demo Home Page'), //注册首页路由
}
);
}
}

通过路由名打开新路由页

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

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

Navigator 除了pushNamed 方法,还有 pushReplacementNamed等其他管理命名路由的方法。

下面我们修改前面两个按钮的onPressed回调函数,通过路由名打开页面:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
FlatButton(
child: Text('open new route'),
textColor: Colors.red,
color: Colors.blue,
onPressed: () {
Navigator.pushReplacementNamed(context, "new_route");
},
),
FlatButton(
child: Text('跳转到详情页'),
textColor: Colors.red[300],
color: Colors.blue[100],
onPressed: () async {
var result = await Navigator.pushNamed(context, "detail");
print('路由返回值:$result');
},
)

命名路由参数传递

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

我们先注册一个路由:

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

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

1
2
3
4
5
6
7
8
9
class NewPage extends StatelessWidget {

@override
Widget build(BuildContext context) {
//获取路由参数
var args=ModalRoute.of(context).settings.arguments;
//...省略无关代码
}
}

在打开路由时传递参数

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

6、路由生成钩子

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

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

1
Route<dynamic> Function(RouteSettings settings)

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

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

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

总结

命名路由只是一种可选的路由管理方式,在实际开发中,还有其他方式供开发者自行选择。

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

欢迎关注微信公众号: 『前端极客技术』『代码视界』
支付宝打赏 微信打赏

赞赏是不耍流氓的鼓励