滚动监听及控制

在前几节中，我们介绍了Flutter中常用的可滚动Widget，也说过可以ScrollController来控制可滚动widget的滚动位置，本节先介绍一下ScrollController，然后以ListView为例，展示一下ScrollController的具体用法。最后，再介绍一下路由切换时如何来保存滚动位置。

ScrollController

构造函数：

  1. ScrollController({
  2.   double initialScrollOffset = 0.0, //初始滚动位置
  3.   this.keepScrollOffset = true,//是否保存滚动位置
  4.   ...
  5. })

我们介绍一下ScrollController常用的属性和方法：

  • offset：可滚动Widget当前滚动的位置。
  • jumpTo(double offset)、animateTo(double offset,...)：这两个方法用于跳转到指定的位置，它们不同之处在于，前者在跳转时会执行一个动画，而前者不会。

ScrollController还有一些属性和方法，我们将在后面原理部分接收。

滚动监听

ScrollController间接继承自Listenable，我们可以根据ScrollController来监听滚动事件。如：

  1. controller.addListener(()=>print(controller.offset))

示例

我们创建一个ListView，当滚动位置位置发生变化时，我们先打印出当前滚动位置，然后判断当前位置是否超过1000像素，如果超过则再屏幕右下角显示一个“返回顶部”的按钮，该按钮点击后可以使ListView恢复到初始位置；如果没有超过1000像素，则隐藏“返回顶部”按钮。代码如下：

  2. class ScrollControllerTestRoute extends StatefulWidget {
  3.   @override
  4.   ScrollControllerTestRouteState createState() {
  5.     return new ScrollControllerTestRouteState();
  6.   }
  7. }
  9. class ScrollControllerTestRouteState extends State<ScrollControllerTestRoute> {
  10.   ScrollController _controller = new ScrollController();
  11.   bool showToTopBtn = false; //是否显示“返回到顶部”按钮
  13.   @override
  14.   void initState() {
  15.     //监听滚动事件，打印滚动位置
  16.     _controller.addListener(() {
  17.       print(_controller.offset); //打印滚动位置
  18.       if (_controller.offset < 1000 && showToTopBtn) {
  19.         setState(() {
  20.           showToTopBtn = false;
  21.         });
  22.       } else if (_controller.offset >= 1000 && showToTopBtn == false) {
  23.         setState(() {
  24.           showToTopBtn = true;
  25.         });
  26.       }
  27.     });
  28.   }
  30.   @override
  31.   void dispose() {
  32.     //为了避免内存泄露，需要调用_controller.dispose
  33.     _controller.dispose();
  34.     super.dispose();
  35.   }
  37.   @override
  38.   Widget build(BuildContext context) {
  39.     return Scaffold(
  40.       appBar: AppBar(title: Text("滚动控制")),
  41.       body: Scrollbar(
  42.         child: ListView.builder(
  43.             itemCount: 100,
  44.             itemExtent: 50.0, //列表项高度固定时，显式指定高度是一个好习惯(性能消耗小)
  45.             controller: _controller,
  46.             itemBuilder: (context, index) {
  47.               return ListTile(title: Text("$index"),);
  48.             }
  49.         ),
  50.       ),
  51.       floatingActionButton: !showToTopBtn ? null : FloatingActionButton(
  52.           child: Icon(Icons.arrow_upward),
  53.           onPressed: () {
  54.             //返回到顶部时执行动画
  55.             _controller.animateTo(.0,
  56.                 duration: Duration(milliseconds: 200),
  57.                 curve: Curves.ease
  58.             );
  59.           }
  60.       ),
  61.     );
  62.   }
  63. }

代码说明已经包含在注释里，下面我们看看运行效果：

Screenshot_1536817558Screenshot_1536817570

由于列表项高度为50像素，当滑动到第20个列表项后，右下角“返回顶部”按钮会显示，点击该按钮，ListView会在返回顶部的过程中执行一个滚动动画，动画时间是200毫秒，动画曲线是Curves.ease，关于动画的详细内容我们将在后面“动画”一章中详细介绍。

滚动位置恢复

PageStorage是一个用于保存页面(路由)相关数据的Widget，它并不会影响子树的UI外观，其实，PageStorage是一个功能型Widget，它拥有一个存储桶（bucket），子树中的Widget可以通过指定不同的PageStorageKey来存储各自的数据或状态。

每次滚动结束，Scrollable Widget都会将滚动位置offset存储到PageStorage中，当Scrollable Widget 重新创建时再恢复。如果ScrollController.keepScrollOffset为false时，则滚动位置将不会被存储，Scrollable Widget重新创建时会使用ScrollController.initialScrollOffset；ScrollController.keepScrollOffset为true时，Scrollable Widget会在第一次创建时，会滚动到initialScrollOffset处，因为这时还没有存储过滚动位置。在接下来的滚动中就会存储、恢复滚动位置，而initialScrollOffset会被忽略。

当一个路由中包含多个Scrollable Widget时，如果你发现在进行一些跳转或切换操作后，滚动位置不能正确恢复，这时你可以通过显式指定PageStorageKey来分别跟踪不同Scrollable Widget的位置，如：

  1. ListView(key: PageStorageKey(1), ... );
  2. ...
  3. ListView(key: PageStorageKey(2), ... );

不同的PageStorageKey，需要不同的值，这样才可以区分为不同Scrollable Widget保存的滚动位置。

注意：一个路由中包含多个Scrollable Widget时，如果要分别跟踪它们的滚动位置，并非一定就得给他们分别提供PageStorageKey。这是因为Scrollable本身是一个StatefulWidget，它的状态中也会保存当前滚动位置，所以，只要Scrollable Widget本身没有被从树上detach掉，那么其State就不会销毁(dispose)，滚动位置就不会丢失。只有当Widget发生结构变化，导致Scrollable Widget的State销毁或重新构建时才会丢失状态，这种情况就需要显式指定PageStorageKey，通过PageStorage来存储滚动位置，一个典型的场景是在使用TabBarView时，在Tab发生切换时，Tab页中的Scrollable Widget的State就会销毁，这时如果想恢复滚动位置就需要指定PageStorageKey。

ScrollPosition

一个ScrollController可以同时被多个Scrollable Widget使用，ScrollController会为每一个Scrollable Widget创建一个ScrollPosition对象，这些ScrollPosition保存在ScrollController的positions属性中（List）。ScrollPosition是真正保存滑动位置信息的对象，offset只是一个便捷属性：

  1. double get offset => position.pixels;

一个ScrollController虽然可以对应多个Scrollable Widge，但是有一些操作，如读取滚动位置offset，则需要一对一，但是我们仍然可以在一对多的情况下，通过其它方法读取滚动位置，举个例子，假设一个ScrollController同时被两个Scrollable Widget使用，那么我们可以通过如下方式分别读取他们的滚动位置：

  1. ...
  2. controller.positions.elementAt(0).pixels
  3. controller.positions.elementAt(1).pixels
  4. ...

我们可以通过controller.positions.length来确定controller被几个Scrollable Widget使用。

方法

ScrollPosition有两个常用方法：animateTo() 和 jumpTo()，它们是真正来控制跳转滚动位置的方法，ScrollController的这两个同名方法，内部最终都会调用ScrollPosition的。

ScrollController控制原理

我们来介绍一下ScrollController的另外三个方法：

  1. ScrollPosition createScrollPosition(
  2.     ScrollPhysics physics,
  3.     ScrollContext context,
  4.     ScrollPosition oldPosition);
  5. void attach(ScrollPosition position) ;
  6. void detach(ScrollPosition position) ;

当ScrollController和Scrollable Widget关联时，Scrollable Widget首先会调用ScrollController的createScrollPosition()方法来创建一个ScrollPosition来存储滚动位置信息，接着，Scrollable Widget会调用attach()方法，将创建的ScrollPosition添加到ScrollController的positions属性中，这一步称为“注册位置”，只有注册后animateTo() 和 jumpTo()才可以被调用。当Scrollable Widget销毁时，会调用ScrollController的detach()方法，将其ScrollPosition对象从ScrollController的positions属性中移除，这一步称为“注销位置”，注销后animateTo() 和 jumpTo() 将不能再被调用。

需要注意的是，ScrollController的animateTo() 和 jumpTo()内部会调用所有ScrollPosition的animateTo() 和 jumpTo()，以实现所有和该ScrollController关联的Scrollable Widget都滚动到指定的位置。

滚动监听

Flutter Widget树中子Widget可以通过发送通知（Notification）与父(包括祖先)Widget通信。父Widget可以通过NotificationListener Widget来监听自己关注的通知，这种通信方式类似于Web开发中浏览器的事件冒泡，我们在Flutter中沿用“冒泡”这个术语。Scrollable Widget在滚动时会发送ScrollNotification类型的通知，ScrollBar正是通过监听滚动通知来实现的。通过NotificationListener监听滚动事件和通过ScrollController有两个主要的不同：

  1. 通过NotificationListener可以在从Scrollable Widget到Widget树根之间任意位置都能监听。而ScrollController只能和具体的Scrollable Widget关联后才可以。
  2. 收到滚动事件后获得的信息不同；NotificationListener在收到滚动事件时，通知中会携带当前滚动位置和ViewPort的一些信息，而ScrollController只能获取当前滚动位置。

NotificationListener

NotificationListener是一个Widget，模板参数T是想监听的通知类型，如果省略，则所有类型通知都会被监听，如果指定特定类型，则只有该类型的通知会被监听。NotificationListener需要一个onNotification回调函数，用于实现监听处理逻辑，该回调可以返回一个布尔值，代表是否阻止该事件继续向上冒泡，如果为true时，则冒泡终止，事件停止向上传播，如果不返回或者返回值为false 时，则冒泡继续。

示例

下面，我们监听ListView的滚动通知，然后显示当前滚动进度百分比：

  1. import 'package:flutter/material.dart';
  3. class ScrollNotificationTestRoute extends StatefulWidget {
  4.   @override
  5.   _ScrollNotificationTestRouteState createState() =>
  6.       new _ScrollNotificationTestRouteState();
  7. }
  9. class _ScrollNotificationTestRouteState
  10.     extends State<ScrollNotificationTestRoute> {
  11.   String _progress = "0%"; //保存进度百分比
  13.   @override
  14.   Widget build(BuildContext context) {
  15.     return Scrollbar( //进度条
  16.       // 监听滚动通知
  17.       child: NotificationListener<ScrollNotification>(
  18.         onNotification: (ScrollNotification notification) {
  19.           double progress = notification.metrics.pixels /
  20.               notification.metrics.maxScrollExtent;
  21.           //重新构建
  22.           setState(() {
  23.             _progress = "${(progress * 100).toInt()}%";
  24.           });
  25.           print("BottomEdge: ${notification.metrics.extentAfter == 0}");
  26.           //return true; //放开此行注释后，进度条将失效
  27.         },
  28.         child: Stack(
  29.           alignment: Alignment.center,
  30.           children: <Widget>[
  31.             ListView.builder(
  32.                 itemCount: 100,
  33.                 itemExtent: 50.0,
  34.                 itemBuilder: (context, index) {
  35.                   return ListTile(title: Text("$index"));
  36.                 }
  37.             ),
  38.             CircleAvatar(  //显示进度百分比
  39.               radius: 30.0,
  40.               child: Text(_progress),
  41.               backgroundColor: Colors.black54,
  42.             )
  43.           ],
  44.         ),
  45.       ),
  46.     );
  47.   }
  48. }

我们看一看运行结果：

image-20180913165011407

在接收到滚动事件时，参数类型为ScrollNotification，它包括一个metrics属性，它的类型是ScrollMetrics，该属性包含当前ViewPort及滚动位置等信息：

  • pixels：当前滚动位置。
  • maxScrollExtent：最大可滚动长度。
  • extentBefore：滑出ViewPort顶部的长度；此示例中相当于顶部滑出屏幕上方的列表长度。
  • extentInside：ViewPort内部长度；此示例中屏幕显示的列表部分的长度。
  • extentAfter：列表中未滑入ViewPort部分的长度；此示例中列表底部未显示到屏幕范围部分的长度。
  • atEdge：是否滑到了Scrollable Widget的边界（此示例中相当于列表顶或底部）。

ScrollMetrics还有一些其它属性，读者可以自行查阅API文档。