私のアプリでは、一日に一回だけ、ユーザーが指定した時間に表示される通知を実装しようとしていた。一応時刻は1分単位で指定できるが、機能の目的と照らし合わせて「分単位の精度は必要ないが、20分も30分も遅れるのは困る」くらいの精度を欲していた。
Table of Contents
- まずは実装してみる
- "不正確な通知"とは何か
- ウィンドウを指定する方法はある
- Androidのバージョンによって挙動が異なる
- 先程のライブラリには、ウィンドウを指定するAPIがない
- まとめ
まずは実装してみる
今回のアプリはFlutterなので、flutter_local_notificationsパッケージを使わせていただくことにした。
過去にもAndroid(ネイティブ)で通知機能を実装したことがあったので、Androidにおけるローカル通知の面倒くささは身にしみて知っている。そのため、まずはよく知らないiOS側から通知機能を実装しようとしたが、これが意外にもめちゃくちゃ簡単だった。通知内容と時間を登録するだけで、かなり正確な時間に通知されるようになっている。どうやら、iOSでは通知スケジュールをOSが握っていて、アプリのプロセスを立ち上げる必要がないため、正確性とバッテリー持ちを両立できるようだ。
次にAndroidに手を付けてみる。しかし早速問題が発生。Androidでは、通知権限に加え、正確な時間に通知するために 「アラームとリマインダー」権限をユーザーに求める必要があるらしい。
権限を求めるためのユーザー導線を新たに作る必要があるし、そもそも極力ユーザーに権限は求めたくない・・・ということで、権限を求めずにある程度正確な通知を実現するため、我々はアマゾンの奥地へと向かったのだった―。
"不正確な通知"とは何か
Androidにおいて「通知の発行」と「処理のスケジュール」は別レイヤーのAPIが担っているため、分けて考えることとする。今回の主題は「処理のスケジュール」であるため、スケジュールされた処理が実行されることを「発火」と表現する。
flutter_local_notificationsには、Android向けのスケジュールモードがいくつか用意されている。これらは、内部的にAlarmManagerを使用しており、表のようなメソッドと対応する。
| モード | 正確性 | Dozeモード時 | SCHEDULE_EXACT_ALARMS権限 |
対応するネイティブ側のメソッド |
|---|---|---|---|---|
.inexact |
最大でスケジュール期間の75%遅延* | 発火しない | 不要 | AlarmManager.set |
.inexactAllowWhileIdle |
最大でスケジュール期間の75%遅延* | 発火する可能性がある | 不要 | AlarmManagerCompat.setAndAllowWhileIdle |
.exact |
基本的にほぼ正確な時間に発火 | 発火しない | 要 | AlarmManager.setExact |
.exactAllowWhileIdle |
基本的にほぼ正確な時間に発火 | 発火する可能性がある | 要 | AlarmManager.setExactAllowWhileIdle |
* Android 12以降は最大1時間
Dozeモードとは、バッテリー消費を抑えるためのハイパースリープ状態みたいなもの。
注目してほしいのは、「スケジュール期間の75%遅延」の部分。これは、「スケジュール登録を呼んだ日時」と「発火予定日時」の差の0.75倍という意味。例えば、1日後にスケジュールすると、(Android 12未満では)最大で18時間遅延する可能性がある。
なぜ「可能性がある」のかというと、他のアプリが登録した「不正確なスケジュール」と、この遅延期間が重なったときにまとめて発火されるからだ。この遅延期間を「ウィンドウ」という。ちなみに、スケジュールより前には発火することはない。
ウィンドウを指定する方法はある
先程の表は、ウィンドウが未指定の場合の挙動。ウィンドウの大きさを指定する方法はあるにはある。setWindowというメソッドを利用することで、「発火時刻がスケジュール時刻から最大でどれほど遅れることが許容できるか」を指定できる。
※ allowWhileIdleかつウィンドウ指定に対応したAPIは現在存在しない。
Androidのバージョンによって挙動が異なる
しかし、setおよびsetWindowの挙動はAndroidのバージョンによって異なる。
| Android | set |
setWindow |
|---|---|---|
| 12未満 | 最大でスケジュール期間の75%遅延 | 最大で指定した時間まで遅延 |
| 12以降 | 1時間を上限として、最大でスケジュール期間の75%遅延 | 10分〜1時間の範囲で、最大で指定した時間まで遅延 |
Android 12では、ウィンドウ自体に下限と上限が設けられた。Android 12がリリースされたのはそれなりに前とはいえ、Googleの統計によると利用者は未だ30%ほど存在する。安易に考慮から外すのは望ましくない*。
* 日本における利用者の統計は未調査。
先程のライブラリには、ウィンドウを指定するAPIがない
flutter_local_notifications の話に戻ると、このライブラリにはウィンドウの大きさを指定するAPIがなく、権限がない場合はAlarmManagerでいうところのsetしか呼び出せない。そのため、権限を求めないと、場合によっては通知が大きく遅延する可能性がある。そこで、本家をフォークしてsetWindowを呼び出せるように実装してみた。
https://github.com/chika3742/flutter_local_notifications/tree/inexact-window-specify
使い方は単純で、zonedScheduleのandroidInexactWindow引数にDurationを渡すだけ。
await flutterLocalNotificationsPlugin.zonedSchedule(
id: Random().nextInt(1000),
title: 'scheduled inexact title',
body: 'scheduled inexact body',
scheduledDate: tz.TZDateTime.now(
tz.local,
).add(const Duration(seconds: 5)),
notificationDetails: const NotificationDetails(
android: AndroidNotificationDetails(
'inexact_channel',
'Inexact Channel',
channelDescription: 'Inexact Notification',
),
),
androidScheduleMode: AndroidScheduleMode.inexact,
androidInexactWindow: const Duration(seconds: 5),
);
まとめ
結局、私のアプリではこのフォークを使い、権限なしでも通知をスケジュールできるようにしつつ、権限も求められるように実装した。二度手間
まぁフォールバックのようなもの。AndroidはiOSとはまた違った部分がめんどくさいね