[Flutter/dart]willPopScopeのonWillPopが作動しない

概要

flutterで前のページに戻ってほしくない場合はwillPopScopeでwidgetをラップし、onWillPopに戻れないような処理を書けばいいとされています。（使い方などはこちらを参照。）

ところが、この実装をしても普通に戻れてしまいます。デバッグしてみるとonWillPopに渡したメソッドがそもそも呼ばれていないみたいです。

この場合の対処方について説明します。

原因

原因は、willPopScopeがstackのルート（つまり一番大元）になかったことのようです。僕のアプリでは、ログインページからメインページにNavigator.pushで飛んでそこにonWillPopScopeを置いていたのでonWillPopが呼ばれなかったようです（参考）

解決策

そもそもログインページのような一方通行の遷移の場合はpushReplacementやpushAndRemoveUntillを使ってそもそもstackにそのページを残さないようにします。

（参考）

Navigator.of(context).pushReplacement(
    MaterialPageRoute(builder: (BuildContext context) => MyHomePage())
)