Flutter：可以检测抽屉何时打开？

Question

是否可以检测抽屉何时打开，以便我们可以运行一些例程来更新其内容？

我的一个典型用例是显示关注者、喜欢者的数量……为此，我需要轮询服务器以获取此信息，然后显示它。

我试图实现一个 NavigatorObserver 来捕捉抽屉可见/隐藏的时刻，但 NavigatorObserver 没有检测到有关抽屉的任何信息。

这是链接到 NavigatorObserver 的代码：

import 'package:flutter/material.dart';

typedef void OnObservation(Route<dynamic> route, Route<dynamic> previousRoute);
typedef void OnStartGesture();

class NavigationObserver extends NavigatorObserver {
  OnObservation onPushed;
  OnObservation onPopped;
  OnObservation onRemoved;
  OnObservation onReplaced;
  OnStartGesture onStartGesture;

  @override
  void didPush(Route<dynamic> route, Route<dynamic> previousRoute) {
    if (onPushed != null) {
      onPushed(route, previousRoute);
    }
  }

  @override
  void didPop(Route<dynamic> route, Route<dynamic> previousRoute) {
    if (onPopped != null) {
      onPopped(route, previousRoute);
    }
  }

  @override
  void didRemove(Route<dynamic> route, Route<dynamic> previousRoute) {
    if (onRemoved != null)
      onRemoved(route, previousRoute);
  }

  @override
  void didReplace({ Route<dynamic> oldRoute, Route<dynamic> newRoute }) {
    if (onReplaced != null)
      onReplaced(newRoute, oldRoute);
  }

  @override
  void didStartUserGesture() { 
    if (onStartGesture != null){
      onStartGesture();
    }
  }
}

以及这个观察者的初始化

void main(){
  runApp(new MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final NavigationObserver _observer = new NavigationObserver()
                                              ..onPushed = (Route<dynamic> route, Route<dynamic> previousRoute) {
                                                print('** pushed route: $route');
                                              }
                                              ..onPopped = (Route<dynamic> route, Route<dynamic> previousRoute) {
                                                print('** poped route: $route');
                                              }
                                              ..onReplaced = (Route<dynamic> route, Route<dynamic> previousRoute) {
                                                print('** replaced route: $route');
                                              }
                                              ..onStartGesture = () {
                                                print('** on start gesture');
                                              };

  @override
  void initState(){
    super.initState();
  }

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      title: 'Title',
      theme: new ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: new SplashScreen(),
        routes: <String, WidgetBuilder> {
          '/splashscreen': (BuildContext context) => new SplashScreen(),
        },
        navigatorObservers: <NavigationObserver>[_observer],
    );
  }
}

感谢您的帮助。

Answer 1

抽屉打开/关闭检测和运行功能

• 通过任何操作打开抽屉时运行initState() 。
• 通过任何操作关闭抽屉时运行dispose() 。

class MyDrawer extends StatefulWidget {
    @override
    _MyDrawerState createState() => _MyDrawerState();
}

class _MyDrawerState extends State<MyDrawer> {

    @override
    void initState() {
        super.initState();
        print("open");
    }

    @override
    void dispose() {
        print("close");
        super.dispose();
    }

    @override
    Widget build(BuildContext context) {
        return Drawer(
            child: Column(
                children: <Widget>[
                    Text("test1"),
                    Text("test2"),
                    Text("test3"),
                ],
            ),
        );
    }
}

状态管理注意事项

如果您正在使用这些函数更改状态以重建抽屉项目，您可能会遇到错误： Unhandled Exception: setState() or markNeedsBuild() called during build 。

这可以通过使用initState()源代码中的以下两个函数来处理

选项 1

WidgetsBinding.instance.addPostFrameCallback((_){
  // Add Your Code here.
});

选项 2

SchedulerBinding.instance.addPostFrameCallback((_) {
  // add your code here.
});

选项 1 的完整示例

@override
void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((_) {
        // Your Code Here
    });
}

Answer 2

最佳解决方案

ScaffoldState有一个有用的方法isDrawerOpen ，它提供打开/关闭的状态。

示例：在背面按下时，它首先检查抽屉是否打开，如果是，则首先将在退出之前关闭。

/// create a key for the scaffold in order to access it later.
GlobalKey<ScaffoldState> _scaffoldKey = GlobalKey<ScaffoldState>();

@override
Widget build(context) {
   return WillPopScope(
  child: Scaffold(
    // assign key (important)
    key: _scaffoldKey,
    drawer: SideNavigation(),
  onWillPop: () async {
    // drawer is open then first close it
    if (_scaffoldKey.currentState.isDrawerOpen) {
      Navigator.of(context).pop();
      return false;
    }
    // we can now close the app.
    return true;
  });}

Answer 3

由于https://github.com/flutter/flutter/pull/67249已经与 Flutter 2.0 合并并发布，这里是检测抽屉打开/关闭的正确方法：

Scaffold(
      onDrawerChanged: (isOpened) {
        //todo what you need for left drawer
      },
      onEndDrawerChanged: (isOpened) {
        //todo what you need for right drawer
      },
)

Answer 4

我认为一个简单的解决方案是覆盖您的AppBar的leading属性，以便您可以在按下菜单图标时访问并基于此运行您的 API 调用。

但是我可能误解了您的问题，因为根据您提供的用例，您通常需要以一种可以听取任何更改的方式来管理它，这些更改将自动更新值，因此我不确定您在尝试触发什么时抽屉打开。

无论如何，这是示例。

class DrawerExample extends StatefulWidget {
  @override
  _DrawerExampleState createState() => new _DrawerExampleState();
}

class _DrawerExampleState extends State<DrawerExample> {
  GlobalKey<ScaffoldState> _key = new GlobalKey<ScaffoldState>();
  int _counter =0;
  _handleDrawer(){
      _key.currentState.openDrawer();

           setState(() {
          ///DO MY API CALLS
          _counter++;
        });

  }
  @override
  Widget build(BuildContext context) {
    return new Scaffold(
      key: _key,
      appBar: new AppBar(
        title: new Text("Drawer Example"),
        centerTitle: true,
        leading: new IconButton(icon: new Icon(
          Icons.menu
        ),onPressed:_handleDrawer,),
      ),
      drawer: new Drawer(
        child: new Center(
          child: new Text(_counter.toString(),style: Theme.of(context).textTheme.display1,),
        ),
      ),
    );
  }
}

Answer 5

不幸的是，目前还没有现成的解决方案。

您可以为此使用脏黑客：观察抽屉的可见位置。

比如我用这种方式来同步按钮上图标的动画和Drawer box的位置。

您可以在下面看到解决此问题的代码：

    import 'package:flutter/material.dart';
    import 'package:flutter/scheduler.dart';

    class DrawerListener extends StatefulWidget {
      final Widget child;
      final ValueChanged<FractionalOffset> onPositionChange;

      DrawerListener({
        @required this.child,
        this.onPositionChange,
      });

      @override
      _DrawerListenerState createState() => _DrawerListenerState();
    }

    class _DrawerListenerState extends State<DrawerListener> {
      GlobalKey _drawerKey = GlobalKey();
      int taskID;
      Offset currentOffset;

      @override
      void initState() {
        super.initState();
        _postTask();
      }

      _postTask() {
        taskID = SchedulerBinding.instance.scheduleFrameCallback((_) {
          if (widget.onPositionChange != null) {
            final RenderBox box = _drawerKey.currentContext?.findRenderObject();
            if (box != null) {
              Offset newOffset = box.globalToLocal(Offset.zero);
              if (newOffset != currentOffset) {
                currentOffset = newOffset;
                widget.onPositionChange(
                  FractionalOffset.fromOffsetAndRect(
                    currentOffset,
                    Rect.fromLTRB(0, 0, box.size.width, box.size.height),
                  ),
                );
              }
            }
          }

          _postTask();
        });
      }

      @override
      void dispose() {
        SchedulerBinding.instance.cancelFrameCallbackWithId(taskID);
        if (widget.onPositionChange != null) {
          widget.onPositionChange(FractionalOffset(1.0, 0));
        }
        super.dispose();
      }

      @override
      Widget build(BuildContext context) {
        return Container(
          key: _drawerKey,
          child: widget.child,
        );
      }
    }

如果您只对打开或关闭框的最终事件感兴趣，则调用initState和dispose函数中的回调就足够了。

Answer 6

ScaffoldState 中有 isDrawerOpen 属性，因此您可以随时检查。

创建全局密钥；

GlobalKey<ScaffoldState> scaffoldKey = GlobalKey<ScaffoldState>();

将其分配给脚手架

Scaffold(
      key: scaffoldKey,
      appBar: ..)

检查应用程序中的任何位置

bool opened =scaffoldKey.currentState.isDrawerOpen;

Answer 7

当这个问题被发布时，完成这个有点技巧。 但是从 Flutter 2.0 开始，这很容易。 在您的 Scaffold 内，您可以按如下方式检测右侧抽屉和左侧抽屉。

@override
  Widget build(BuildContext context) {
    return Scaffold(
      onDrawerChanged: (isOpened) {
        *//Left drawer, Your code here,*
      },
      onEndDrawerChanged: (isOpened) {
        *//Right drawer, Your code here,*
      },
    );
  }

Answer 8

您可以简单地使用onDrawerChanged来检测抽屉是在 Scaffold 小部件中打开还是关闭。

属性 :

{void 函数（布尔）？ onDrawerChanged}
类型：void 函数（布尔）？
打开或关闭 Scaffold.drawer 时调用的可选回调。

示例：

@override 小部件构建（BuildContext 上下文）{

return Scaffold(
  onDrawerChanged:(val){
    if(val){
      setState(() {
        //foo bar;
      });
    }else{
      setState(() {
        //foo bar;
      });
    }
},     
  drawer: Drawer(        
      child: Container(
      )
  ));

}