【Flutter组件】路由与导航

Flutter路由和导航

Navigator

Navigator通过push来跳转某个页面，通过pop来退出某个页面。

push

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

push方式添加路由入栈，一般有两个方法：push和pushNamed

● push
下边是 Navigator.push 的源码，入参的 Route 对象中有一个 RouteSettings 成员变量，我们可以在构造 Route 对象的时候将需要传递的参数放在 RouteSettings 中。

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

如果涉及到传递参数，那么我们可以将参数放在 SecondScreen 的构造函数中，也可以放在构造的 MaterialPageRoute 的 RouteSettings 中。

Navigator.push(
  context,
  new MaterialPageRoute(builder: (context) => new SecondScreen()),
).then((data){
    
    
  //接受上个页面返回的参数返回的参数
  print(data.toString());
};

● pushNamed
pushNamed方式的实现最终调用的也是 push 方法，这中方法直接暴露了参数 Object arguments ，源码如下

@optionalTypeArgs
static Future<T> pushNamed<T extends Object>(
  BuildContext context,
  String routeName, {
    
    
  Object arguments,
  }) {
    
    
  return Navigator.of(context).pushNamed<T>(routeName, arguments: arguments);
}
@optionalTypeArgs
Future<T> pushNamed<T extends Object>(
  String routeName, {
    
    
  Object arguments,
}) {
    
    
  return push<T>(_routeNamed<T>(routeName, arguments: arguments));
}

使用pushNamed方式时，需要将路由注册到路由表中，例如：

Navigator.of(context)
  .pushNamed(
    '/route1',
    arguments: {
    
    
      "name": 'hello'
    }
    ).then((data){
    
    
    //接受返回的参数
    print(data.toString());
    };

使用pushNamed

新建一个路由

import 'package:flutter/cupertino.dart';
import 'package:flutter_module/MainPage.dart';
import 'package:flutter_module/NavigatorDemo.dart';

final Map<String, WidgetBuilder>routeTable = {
    
    
  '/main_page':(context) =>MainPage(),
  '/first_screen':(context) =>FirstScreen(),
  '/second_screen':(context) =>SecondScreen()
};

在首页的MaterialApp中注册路由

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


class MyApp extends StatelessWidget {
    
    

  @override
  Widget build(BuildContext context) {
    
    
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'default',
      theme: defaultTheme,
      home: HomePage(title: "主页",),//默认首页
      routes: routeTable,//注册路由
    );
  }
}

在上述中，如果有默认首页，那么在routeTable中不能注册仅以“/”命名的路由，因为会与默认路由冲突，要么在上述去除home:HomePage，要么不在routeTable中注册仅以“/”命名的路由。否则会报错：

使用pushNamed跳转

import 'package:flutter/material.dart';

class HomePage extends StatefulWidget {
    
    
  HomePage({
    
    Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  State<StatefulWidget> createState() => _MyHomePage();
}

class _MyHomePage extends State<HomePage> {
    
    
  @override
  Widget build(BuildContext context) {
    
    
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Column(
        children: [
          ElevatedButton(
            child: const Text("Android原生与Flutter之间交互"),
            onPressed: () {
    
    
              Navigator.of(context)
                  .pushNamed("/main_page", arguments: "打开MainPage页面");
            },
          ),
          ElevatedButton(
            child: const Text("页面间跳转和传惨测试"),
            onPressed: () {
    
    
              Navigator.of(context)
                  .pushNamed("/first_screen", arguments: "打开FirstScreen页面");
            },
          )
        ],
      ),
    );
  }
}

pop

pop操作将栈顶路由出栈，入参为一个 object 类型的对象，出参为当前页面关闭时返回给上一个页面的数据。

pop源码如下：

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

pop的使用非常简单，例如：

Navigator.of(context).pop("");  //可以传递参数
或
Navigator.pop(context,"返回上一页");

两个页面之间跳转，如果涉及到参数的传递，可以使用下面的方式：

Navigator.of(context).pushNamed('/route1', arguments: {
    
    "name": 'hello'});

获取参数时，可以使用下面的方式：

class Page extends StatelessWidget{
    
    
  String name;
  @override
  Widget build(BuildContext context) {
    
    
    dynamic obj = ModalRoute.of(context).settings.arguments;
    if (obj != null && isNotEmpty(obj["name"])) {
    
    
      name = obj["name"];
    }
    return Material(
      child: Center(
        child: Text("this page name is ${name}"),
      ),
    );
  }
}

使用示例

● 新建第一个页面

class FirstScreen extends StatelessWidget {
    
    
  @override
  Widget build(BuildContext context) {
    
    
    dynamic obj = ModalRoute.of(context)?.settings.arguments;
    if (obj != null) {
    
    
      debugPrint("跳转时路由传递过来的参数：$obj");
    }

    return Scaffold(
      appBar: AppBar(
        title: const Text('First Screen'),
      ),
      body: Center(
        child: ElevatedButton(
          child: const Text('Launch second screen'),
          onPressed: () {
    
    
            Navigator.push(
                    context,
                    MaterialPageRoute(
                        builder: (context) => SecondScreen(),
                        maintainState: false))
                .then((value) => {
    
    debugPrint("上个页面返回参数为：${value.toString()}")});
          },
        ),
      ),
    );
  }
}

在上面的页面中，只有一个按钮，点击按钮后跳转到SecondScreen页面，它是通过Navigator.push将路由添加到路由栈中。

● 新建SecondScreen页面

class SecondScreen extends StatelessWidget {
    
    
  @override
  Widget build(BuildContext context) {
    
    
    return Scaffold(
      appBar: AppBar(
        title: const Text('Second Screen'),
      ),
      body: Center(
        child: ElevatedButton(
          child: const Text("Go back!"),
          onPressed: () {
    
    
            Navigator.pop(context, "返回上一页");
          },
        ),
      ),
    );
  }
}

该页面也只有一个按钮，点击按钮，会退出当前页面。

Route

路由命名与路由表

● 路由命名
所谓命名路由，就是给路由起一个名字，然后可以通过路由名字直接打开新的路由。这为路由管理带来了一种直观、简单的方式，这和 Android 中的 ARrouter 页面跳转框架所定义的 path 非常的类似。

路由名称按惯例使用类似路径的结构，应用程序的主页路由默认为“/”，例如，'/ home' 表示 HomeScreen，'/ login'表示 LoginScreen。

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

Map<String, WidgetBuilder> routes;

它是一个Map， key 为路由的名称，是个字符串；value是个builder回调函数，用于生成相应的路由Widget。我们在通过路由名称入栈新路由时，应用会根据路由名称在路由表中找到对应的WidgetBuilder回调函数，然后调用该回调函数生成路由widget并返回。
例如，我们在创建 MaterialApp 的时候就有一个 routes 构造参数：

class MyApp extends StatelessWidget {
    
    
  @override
  Widget build(BuildContext context) {
    
    
    return new MaterialApp(
      title: 'Flutter Demo',
      home: new MyHomePage(title: '应用程序首页'),
      routes: <String, WidgetBuilder> {
    
    
        '/a': (BuildContext context) => new MyPage(title: 'A 页面'),
        '/b': (BuildContext context) => new MyPage(title: 'B 页面'),
        '/c': (BuildContext context) => new MyPage(title: 'C 页面')
      },
    );
  }
}

3.2.2 命名路由传参
路由跳转时携带参数

onPressed: () {
    
    
	Navigator.of(context)
		.pushNamed("/first_screen", arguments: "打开FirstScreen页面");
},

跳转之后的页面解析参数

  @override
  Widget build(BuildContext context) {
    
    
    //路由传参
    dynamic args = ModalRoute.of(context)?.settings.arguments;
    if (args != null) {
    
    
      debugPrint("路由传递来的参数为：$args");
    }
    ......
  }

或者

onPressed: () {
    
    
	Navigator.of(context)
		.pushNamed("/first_screen", arguments: {
    
    "name": "打开MainPage页面"});
},

跳转之后的页面解析参数

  @override
  Widget build(BuildContext context) {
    
    
    //路由传参
    dynamic args = ModalRoute.of(context)?.settings.arguments;
    if (args != null) {
    
    
      debugPrint("从路由传递过来的参数为：${args['name']}");
    }
    ......
  }

MaterialPageRoute

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

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

我们使用MaterialPageRoute来完成路由跳转时，MaterialPageRoute构造函数提供了几个的，参数，格式如下：

MaterialPageRoute({
    
    
    WidgetBuilder builder,
    RouteSettings settings,
    bool maintainState = true,
    bool fullscreenDialog = false,
  })

这些参数的具体含义如下：

builder 是一个WidgetBuilder类型的回调函数，它的作用是构建路由页面的具体内容，返回值是一个widget。我们通常要实现此回调，返回新路由的实例。
settings 包含路由的配置信息，如路由名称、是否初始路由（首页）。
maintainState：默认情况下，当入栈一个新路由时，原来的路由仍然会被保存在内存中，如果想在路由没用的时候释放其所占用的所有资源，可以设置maintainState为false。

MaterialPageRoute(builder: (context) => SecondScreen(),maintainState: false));

fullscreenDialog表示新的路由页面是否是一个全屏的模态对话框，在iOS中，如果fullscreenDialog为true，新页面将会从屏幕底部滑入（而不是水平方向）。