flutter でバックグラウンド時に定期処理を実行したくて、色々と調査した結果を記載します。
※ iOS がバックグラウンドタスクについて制約が多かったので、この記事では iOS メインで記載します。android については言及しません。
ライブラリ選定
Flutter GemsのTop Flutter Android/iOS Device Software and Hardware packagesを見てみると、以下のようなライブラリが出てきます。
上位 3 つがどれもバックグラウンド処理に関連するライブラリです。
今回はこの 3 つから選定してみます。
| ライブラリ | pub.dev Star |
pub.dev 最終更新 |
Github Star |
Github 最終 Commit |
Github Issue |
感想 |
|---|---|---|---|---|---|---|
| workmanager | 2.0K | 11 months ago | 836 | 4 months ago | 94 | Star 数は一番多いので実績はありそう。 ただ Issue を見る限り BugTag がやや多い印象。 更新頻度も高くはない。 |
| flutter_background_service | 1.2K | 3 days ago | 261 | 5 days ago | 188 | 直近は更新が復活しているので、今後改善が進むかも？ Issue が多いのが気になる。 |
| background_fetch | 1.1K | 3 months ago | 566 | 2 months ago | 1 | 更新頻度もそこそこで、Issue がほぼ無いのがすごい。 |
実装中に動かないとかで調査する時間をできるだけ無くしたく、安心感のありそうな background_fetchを今回は利用してみます。
background_fetch
以下、README より引用。
Background Fetch は非常にシンプルなプラグインで、約 15 分ごとにバックグラウンドでアプリを起動し、バックグラウンドでの短い実行時間を提供します。 このプラグインは、バックグラウンドフェッチイベントが発生するたびに、提供された callbackFn を実行します。
Background Fetch は、任意の「ワンショット」または定期的なタスクをスケジューリングするための scheduleTask メソッドを提供するようになりました
ライブラリの名前の通り、定期的にバックグラウンドでタスクを実行するためのライブラリとの記載があり。
簡単に意図通りに実装できるだろうと簡単に考えていましたが、README の iOS 項目に以下の記載がありました。
- フェッチイベントの発生速度を上げる方法はなく、このプラグインは可能な限り頻繁に発生するように設定します。15 分以上早くイベントを受信することはありません。
オペレーティングシステムは、使用パターンに基づいてバックグラウンドフェッチイベントの発生速度を自動的に調整します。
例: ユーザーが長時間電源を入れていない場合、フェッチイベントの発生頻度は低くなります。- scheduleTask は、デバイスが電源に接続されている時のみ実行されるようです。
scheduleTaskは優先度の低いタスクのために設計されており、あなたが望むほど頻繁に実行されることはありません。- デフォルトの
fetchタスクの方がはるかに頻繁に実行されます。- ⚠️ アプリが終了すると、iOS はイベントを発火しなくなります。 - iOS には
stopOnTerminate: falseというものはありません。- iOS は、アップルの機械学習アルゴリズムが落ち着き、定期的にイベントを開始するまでに数日かかることがある。イベントが発火するのをじっとログを見つめて待っていてはいけない。シミュレートしたイベントが動作すれば、それだけですべてが正しく設定されていることがわかります。
- もしユーザーが長時間 iOS アプリを開かなければ、iOS はイベントの発火を停止します。
ライブラリの目的というか主機能としては、約 15 分ごとにバックグラウンドでアプリを起動なのに、これは iOS だとほぼ満たせないのでは、、、
なお、workmanager でも似たような内容の記載あり。
特に、バックグラウンドタスクがいつ実行されるかは保証されていません。 ドキュメントからの抜粋。
処理タスクリクエストをスケジュールして、同期、データベースのメンテナンス、または同様のタスクなど、延期可能で長時間実行する処理を処理するために、バッテリーの寿命に有利な条件が整ったときに、システムにアプリの起動を依頼します。 システムは、ユーザーが過去 1 週間以内にあなたのアプリを使用している限り、今後 2 日以内に可能な限りこの要求を満たそうとします。
flutter_background_service の README には、このような記載はないが、Issue のやり取りを見ると iOS のバックグラウンド処理が機能しないとう記載がありました。
理由としては同様の制約っぽいです。
こういった iOS の制約について全く把握できていなかったので、iOS の Document を読んでこの辺の制約を見てみます。
※ 以下、swift で実際に実装したわけではないのでざっくり理解の記載であることをご了承ください。
BackgroundTask
iOS でバックグラウンドでのタスク実行には、BackgroundTask という Framework を利用します。
Overview
BackgroundTasks フレームワークを使用して、アプリのコンテンツを最新の状態に保ち、アプリがバックグラウンドにある間に数分で完了するタスクを実行します。長時間の作業では、オプションで外部電源とネットワーク接続が必要になることもある。
アプリの起動時にタスクの起動ハンドラを登録し、必要に応じてスケジュールを設定します。システムはバックグラウンドでアプリを起動し、タスクを実行します。
ざっくりと関係性をまとめると以下のようになります。
BackgroundTask 以下の各クラスについてはこの後順に見ていきます。
- BackgroundTask: フレームワーク
- BGTaskScheduler: バックグラウンドで実行するタスクをスケジュール（管理）するクラス。
- BGAppRefreshTaskRequest: タスク
- BGProcessingTaskRequest: タスク
- etc.: タスク
BGTaskScheduler
「BGTaskScheduler ≒ バックグラウンドで実行するタスクをスケジュール（管理）するクラス。」
BGTaskScheduler に実施したい Task を登録していくイメージ。
以下、Apple Developer Document / Using background tasks to update your appより引用。
Overview
タスクとは、アプリが実行する独立したアクティビティのことで、多くの場合、定期的に実行される。タスクの例としては、データベースのメンテナンス、機械学習モデルの改良、表示データの更新などがあります。デバイスが使用されていないときに処理時間を活用するために、アプリをバックグラウンドで起動してタスクを実行するように設定できます。
バックグラウンドで実行するタスクをスケジュールするには、Xcode でバックグラウンドモードを有効にし、必要な特定のタスクを特定し、BGTaskScheduler オブジェクトにタスクを登録します。
Enable and schedule background tasks
バックグラウンド・タスクを許可するようにアプリを設定するには、必要なバックグラウンド機能を有効にし、各タスクの一意の識別子のリストを作成します。 バックグラウンド・タスクには 2 つのタイプがあります： BGAppRefreshTask と BGProcessingTask です。 BGAppRefreshTask は、株価のダウンロードなど、迅速な結果が期待できる短時間のタスク用です。 BGProcessingTask は、大きなファイルのダウンロードやデータの同期など、時間のかかるタスク用です。 アプリはこれらの 1 つまたは両方を使用できます。
BGAppRefreshTask
通常、アプリがバックグラウンドにある間に実行されるコンテンツの更新に使われる、短いタスクを表すオブジェクト。
Overview
アプリのリフレッシュ・タスクは、最新の株価など、ちょっとした情報をアプリで更新するために使用します。
BGProcessingTask
アプリがバックグラウンドで動作している間に実行される、時間のかかる処理タスク。
Overview
長時間のデータ更新、データ処理、アプリのメンテナンスには処理タスクを使用します。 処理タスクは数分間実行できますが、システムが処理を中断することもあります。
処理タスクは、デバイスがアイドル状態のときにのみ実行されます。 ユーザーがデバイスの使用を開始すると、システムは実行中のバックグラウンド処理タスクを終了します。 バックグラウンド更新タスクは影響を受けない。
Apple Developer Document / Choosing Background Strategies for Your App
Update Your App’s Content
例えば、アプリは定期的にサーバーからコンテンツを取得したり、定期的に内部状態を更新したりします。このような状況では、BGAppRefreshTaskRequest を要求して、BGAppRefreshTask を使用します。
システムは、あなたのバックグラウンドタスクを起動する最適な時間を決定し、あなたのアプリに最大 30 秒間のバックグラウンドランタイムを提供します。この時間内に作業を完了し、setTaskCompleted(success:)を呼び出すか、システムがアプリを終了します。
Defer Intensive Work
バッテリーの寿命とパフォーマンスを維持するために、デバイスが充電される夜間など、アクティビティが低い時間帯にバックグラウンドタスクをスケジュールすることができます。機械学習モデルのトレーニングやデータベースのメンテナンスなど、アプリが重いワークロードを管理する場合は、この方法を使用してください。
BGProcessingTask を使用してこれらのタイプのバックグラウンドタスクをスケジュールすると、システムがバックグラウンドタスクを起動する最適な時間を決定します。
Apple Developer Document / Refreshing and Maintaining Your App Using Background Tasks
Advances in App Background Execution
40 分もある動画ですがトランスクリプトがついてるので、ざっくりと読むことができます。
おわり
Apple Developer Document を読むと、なぜ Flutter ライブラリの仕様がこうなっているのかが概ね理解できました。
Apple の Document には説明が少なくて完全には明記されてない部分も多々ありますが、Flutter ライブラリの注意書きの内容は、iOS の仕様なのでしょうがないということもわかりました。
（この辺の仕様にはるかに詳しいライブラリの作者がそのように明記しているので尚更。）
結論として、
iOS でバックグラウンドタスクの実装はできるが、正確に意図通りに制御することは難しいということがわかりました。
iOS のバックグラウンドタスクの仕様の解説については、下記の参考記事の方がより詳細に記載されているので、そちらも併せてご参照ください。
備考：
（どうしてもバックグラウンドでの定期処理が必要で、時間や頻度を制御したい場合は、background への移行を契機にTimer などで無理くり実装できるのか、、、？）
参考記事
参考記事一覧
github:background_fetch
github:workmanager
NCDC株式会社( ncdc.co.jp/ )のエンジニアチームです。 募集中のエンジニアのポジションや、採用している技術スタックの紹介などはこちら( github.com/ncdcdev/recruitment )をご覧ください！ ※エンジニア以外も記事を投稿することがあります
Discussion