Flutter WillPopScope攔截返回事件原理示例詳解

Posted on by

一、 WillPopScope用法

WillPopScope本質是一個widget用於攔截物理按鍵返回事件(Android的物理返回鍵和iOS的側滑返回），我們先瞭解一下這個類, 很簡單，共有兩個參數，子widget child和用於監聽攔截返回事件的onWillPop方法

 const WillPopScope({
    super.key,
    required this.child,
    required this.onWillPop,
  }) : assert(child != null);

下面我們以Android為例看一下用法,用法很簡單

body: WillPopScope(
        child: Center(
          // Center is a layout widget. It takes a single child and positions it
          // in the middle of the parent.
          child: Text("back")
        ),
        onWillPop: () async {
          log("onWillPop");
          /**返回 true 和不實現onWillPop一樣，自動返回,
           *返回 false route不再響應物理返回事件，攔截返回事件自行處理
           */
          return false;
        },
      ),

在需要攔截返回事件的頁面添加WillPopScope後，返回值為false時，點擊物理返回鍵頁面沒有任何反應，需要自己實現返回邏輯。

二、使用WillPopScope遇到的問題

當flutter項目中隻有一個Navigator時，使用上面的方式是沒有問題的，但是一個項目中往往有多個Navigator,我們就會遇到WillPopScope失效的情況（具體原理後面會解釋）,先來看一個嵌套示例

主頁面main page, 由於MaterialApp就是一個Navigator, 所以我們在裡面嵌套一個Navigator,示例隻寫關鍵代碼

main page

body: WillPopScope(
        child: Center(
          // Center is a layout widget. It takes a single child and positions it
          // in the middle of the parent.
          child: Navigator(
            onGenerateRoute: (RouteSettings settings) => MaterialPageRoute(builder: (context) {
              return FirstPage();
            }),
          )
        ),
        onWillPop: () async {
          print("onWillPop");
          /**返回 true 和不實現onWillPop一樣，自動返回,
           *返回 false route不再響應物理返回事件，攔截返回事件自行處理
           */
          return true;
        },

first page, 嵌入到主頁，創建路由可以跳轉第二頁

class FirstPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return WillPopScope(
        child: Center(
            child: InkWell(
          child: const Text("第一頁"),
          onTap: () {
          //跳轉到第二頁
            Navigator.push(context, MaterialPageRoute(builder: (context) {
              return SecondPage();
            }));
          },
        )),
        onWillPop: () async {
          //監聽物理返回事件並打印
          print("first page onWillScope");
          return false;
        });
  }
}

第二頁

class SecondPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return WillPopScope(
      onWillPop: () async{
        //監聽物理返回事件並打印
        print("second page onWillPop");
        return false;
      },
      child: const Center(
        child: Text("第二頁"),
      ),
    );
  }
}

運行後會發現，點擊返回鍵隻有主頁的onWillPop 監聽到瞭物理返回事件，第一頁和第二頁的onWillPop沒有任何反應

I/flutter: onWillPop

看上去隻響應瞭最初的Navigator,嵌套後的Navigator的監聽沒有任何效果，為什麼會出現這樣的問題呢？下面是對WillPopScope原理的講解，如果隻想看解決辦法請直接跳到文章最後。

三、 WillPopScope原理

我們先看WillPopScope的源碼,WillPopScope的主要源碼就是下面兩段，很容易理解，就是在UI或者數據更新後，對比onWillPop有沒有變化並更新。

@override
  void didChangeDependencies() {
    super.didChangeDependencies();
    if (widget.onWillPop != null) {
      _route?.removeScopedWillPopCallback(widget.onWillPop!);
    }
    //獲取ModalRoute
    _route = ModalRoute.of(context);
    if (widget.onWillPop != null) {
      _route?.addScopedWillPopCallback(widget.onWillPop!);
    }
  }
  @override
  void didUpdateWidget(WillPopScope oldWidget) {
    super.didUpdateWidget(oldWidget);
    if (widget.onWillPop != oldWidget.onWillPop && _route != null) {
      if (oldWidget.onWillPop != null) {
        _route!.removeScopedWillPopCallback(oldWidget.onWillPop!);
      }
      if (widget.onWillPop != null) {
        _route!.addScopedWillPopCallback(widget.onWillPop!);
      }
    }
  }

重點看這一段,獲取ModalRoute並將onWillPop註冊到ModalRoute中

_route = ModalRoute.of(context);
   if (widget.onWillPop != null) {
      //該方法就是將onWillScope放到route持有的_willPopCallbacks數組中
     _route?.addScopedWillPopCallback(widget.onWillPop!);
   }

進入到ModalRoute中，看到註冊到_willPopCallbacks中的onWillPop在WillPop中被調用，註意看當 onWillPop返回值為false時，WillPop的返回值為RoutePopDisposition.doNotPop。

這裡解決瞭一個小疑點，onWillPop返回值的作用，返回false就不pop。但是還沒有解決我們的主要疑問，隻能接著往下看。

@override
  Future<RoutePopDisposition> willPop() async {
    final _ModalScopeState<T>? scope = _scopeKey.currentState;
    assert(scope != null);
    for (final WillPopCallback callback in List<WillPopCallback>.of(_willPopCallbacks)) {
      if (await callback() != true) {
        //當返回值為false時，doNotPop
        return RoutePopDisposition.doNotPop;
      }
    }
    return super.willPop();
  }

接著找到調用WillPop的方法，是一個MaybePop的方法，這個方法裡包含瞭同一個 Navigator裡面頁面的彈出邏輯，這裡我們不做分析，感興趣的可以自己研究。但是如果涉及到不同的Navigator呢？我們先看這個方法裡面的返回值，這個很重要。但我們的問題同樣不是在這裡能解答的，隻能繼續向上追溯。

 @optionalTypeArgs
  Future<bool> maybePop<T extends Object?>([ T? result ]) async {
    final _RouteEntry? lastEntry = _history.cast<_RouteEntry?>().lastWhere(
      (_RouteEntry? e) => e != null && _RouteEntry.isPresentPredicate(e),
      orElse: () => null,
    );
    if (lastEntry == null) {
      return false;
    }
    assert(lastEntry.route._navigator == this);
    final RoutePopDisposition disposition = await lastEntry.route.willPop(); // this is asynchronous
    assert(disposition != null);
    if (!mounted) {
      // Forget about this pop, we were disposed in the meantime.
      return true;
    }
    final _RouteEntry? newLastEntry = _history.cast<_RouteEntry?>().lastWhere(
      (_RouteEntry? e) => e != null && _RouteEntry.isPresentPredicate(e),
      orElse: () => null,
    );
    if (lastEntry != newLastEntry) {
      // Forget about this pop, something happened to our history in the meantime.
      return true;
    }
    switch (disposition) {
      case RoutePopDisposition.bubble:
        return false;
      case RoutePopDisposition.pop:
        pop(result);
        return true;
      case RoutePopDisposition.doNotPop:
        return true;
    }
  }

那又是誰調用瞭maybePop方法呢, 那就是didPopRoute, didPopRoute方法位於_WidgetsAppState 中

@override
  Future<bool> didPopRoute() async {
    assert(mounted);
    // The back button dispatcher should handle the pop route if we use a
    // router.
    if (_usesRouterWithDelegates) {
      return false;
    }
    final NavigatorState? navigator = _navigator?.currentState;
    if (navigator == null) {
      return false;
    }
    return navigator.maybePop();
  }

根據層層的追溯，我們現在來到下面的方法,這個方法很好理解，也是讓我很疑惑的地方。for循環遍歷_observes數組中的所有WidgetsBindingObserver。但是——註意這個轉折 如果數組中的第一個元素的didPopRoute方法返回true,那麼遍歷結束，如果返回false那麼最終會調用SystemNavigator.pop(),這個方法的意思是直接退出應用。也就是說handlePopRoute這個方法要麼執行數組裡的第一個WidgetBindingObserver的didPopRoute要麼退出應用。感覺這個for循環然並卵。

那為什麼要講這個方法呢，因為應用監聽到物理返回按鍵事件後會調用這個方法。

@protected
  Future<void> handlePopRoute() async {
    for (final WidgetsBindingObserver observer in List<WidgetsBindingObserver>.of(_observers)) {
      if (await observer.didPopRoute()) {
        return;
      }
    }
    SystemNavigator.pop();
  }

現在我們知道瞭，應用監聽到物理返回按鍵事件後會調用handlePopRoute方法。但是handlePopRoute中要麼調用_observers數組的第一個item的didPopRoute方法，要麼就退出應用。也就是說想要監聽系統的返回事件要有一個註冊到_observers的WidgetBindingObserver並且還要是_observers數組裡的第一個元素。通過搜索_observers的相關操作方法可以知道_observers添加元素隻用到瞭add方法，所以第一個元素永遠不會變。那誰是第一個WidgetBindingObserver呢？那就是上文提到的_WidgetsAppState， 而_WidgetsAppState會持有一個NavigatorKey，這個NavigatorKey 就是應用最初Navigator的持有者。

綜上，我們瞭解瞭應用的物理返回鍵監聽邏輯，永遠隻會調用到應用的第一個Navigator，所以我們所有的監聽返回邏輯隻能用系統的第一個Navigator裡面實現。那對於嵌套的Navigator我們該怎麼辦呢？

四、嵌套Navigator無法監聽物理返回按鍵的解決辦法

既然不能直接處理嵌套Navigator的物理返回事件，那就隻能曲線救國瞭。 首先去掉無效的WillPopScope。

first page

class FirstPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Center(
        child: InkWell(
      child: const Text("第一頁"),
      onTap: () {
        Navigator.push(context, MaterialPageRoute(builder: (context) {
          return SecondPage();
        }));
      },
    ));
  }
}

second page

class SecondPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return const Center(
      child: Text("Second page"),
    );
  }
}

重頭戲來到瞭main page裡面, 還是將onWillPop設置為false。攔截所有的物理返回事件。隻需要給Navigator設置一個GlobalKey,然後在onWillPop中實現對應navigator的返回邏輯。

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;
  @override
  State<MyHomePage> createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    GlobalKey<NavigatorState> _key = GlobalKey();
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: WillPopScope(
        child: Center(
          child: Navigator(
            key: _key,
            onGenerateRoute: (RouteSettings settings) => MaterialPageRoute(builder: (context) {
              return FirstPage();
            }),
          )
        ),
        onWillPop: () async {
          print("onWillPop");
          if(_key.currentState != null && _key.currentState!.canPop()) {
            _key.currentState?.pop();
          }
          /**返回 true 和不實現onWillPop一樣，自動返回,
           *返回 false route不再響應物理返回事件，攔截返回事件自行處理
           */
          return false;
        },
      ),
    );
  }
}

以上就是Flutter WillPopScope攔截返回事件原理示例詳解的詳細內容，更多關於Flutter WillPopScope攔截返回的資料請關註WalkonNet其它相關文章！

推薦閱讀：