アプリのライフサイクル
Flutter の AppLifecycleState の各変化は AppLifecycleStateEvent として発行されるため、どの Bean もウィジェットを介さずに反応できます。アプリがバックグラウンドに移ると、アプリケーションコンテキストは一時停止します。@Scheduled のタスク、WebSocket の接続、その他の一時停止可能なライフサイクルの Bean が止まります。アプリが戻ると、それらは再び始まります。
使う理由
バックグラウンドにあるスマートフォンのアプリは、サーバーをポーリングしたり、ソケットを開いたままにしたり、タイマーを動かしたりすべきではありません。バッテリーとデータを消費し、そのためにシステムに終了させられることもあります。コンテキストに Spring のライフサイクルがあるため、バックグラウンドで処理を行う Bean (スケジューラー、ソケットのクライアント) は自動的に止まり、また始まり、独自の Bean も同じイベントに反応します。
例
// ユーザーがアプリを離れると、未送信の下書きが保存される。
@Component()
class DraftKeeper {
DraftKeeper(this.drafts);
final DraftStore drafts;
@EventListener()
void onLifecycle(AppLifecycleStateEvent event) {
if (event.state == AppLifecycleState.paused) drafts.save();
}
}
イベント
| イベント | 発生する時 |
|---|---|
AppLifecycleStateEvent |
状態の変化のたびに: resumed、inactive、hidden、paused、detached (event.state) |
ContextPausedEvent |
アプリがバックグラウンド (hidden または paused) に移り、コンテキストが一時停止した後 |
ContextRestartedEvent |
アプリが resumed になり、コンテキストが再び始まった後 |
ContextClosedEvent |
SpringApplicationWidget が取り除かれたとき、またはホットリロードがコンテキストを再起動したとき |
バックグラウンドでの一時停止
アプリがバックグラウンド (hidden または paused) に移ると、コンテキストは一時停止します。@Scheduled のタスク、WebSocket の接続、その他の一時停止可能な SmartLifecycle の Bean が止まり、その後 ContextPausedEvent が発行されます。フォアグラウンド (resumed) に戻ると、それらは再び始まり、ContextRestartedEvent が続きます。これは Spring Framework 7 のコンテキストの pause() と restart() です。
バックグラウンドでも動かし続けるには:
spring:
flutter:
lifecycle:
pause-in-background: false
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.flutter.lifecycle.pause-in-background |
bool | true |
アプリがバックグラウンドにある間コンテキストを一時停止し、フォアグラウンドで再び始める |
スケジュールされた処理とバックグラウンド
@Scheduledのタスクはアプリが戻ると新たにスケジュールされるため、バックグラウンドで逃した実行は埋め合わされません。- Bean が
TaskSchedulerで自分で始めたタスク (scheduleAtFixedRate、scheduleWithFixedDelayなど) は一時停止されません。システムがアプリの実行を許す間は動き続け、システムがアプリを中断した場合は、Spring のスケジューラーと同じく、戻ったときに遅れを取り戻します。固定レートのタスクは、その間に逃したすべての実行を即座に始めます (1 秒のレートで 1 分離れていた場合: 約 60 回が連続して実行されます)。固定遅延のものは一回実行してから続きます。 - そのため、ポーリングや UI のティックには固定遅延を使うか、その画面がなくなったとき、または
ContextPausedEventでキャンセルしてください。pause-in-background=falseでの@Scheduled(fixedRate: ...)や、非表示の間タイマーが抑制されるブラウザーのタブにも同じことが当てはまります。
独自のライフサイクルの Bean
接続を保持する Bean は SmartLifecycle を mixin します。デフォルトで一時停止可能です (isPauseable は true)。バックグラウンドで動き続けなければならない Bean では、false でオーバーライドしてください。
// バックグラウンドでは止まる価格のライブフィード。
@Component()
class PriceFeed with SmartLifecycle {
PriceFeed(this.socket);
final PriceSocket socket;
var _running = false;
@override
void start() {
socket.connect();
_running = true;
}
@override
void stop() {
socket.close();
_running = false;
}
@override
bool get isRunning => _running; // pause() で止まり、restart() で始まる
}
コンテキストの終了
コンテキストは、SpringApplicationWidget がツリーから取り除かれると閉じられます。@PreDestroy メソッドが実行され、ライフサイクルの Bean が止まります。Bean を変更したホットリロードもコンテキストを閉じ、その後新しいものを始めます (ホットリロード を参照)。
Spring (Java) との対応
サーバーにはフォアグラウンドとバックグラウンドがないため、Spring に AppLifecycleStateEvent はありません。pause() と restart() とそのイベントは Spring Framework 7 のものです。