plaintext.at

Warum anonyme Funktionen als Flutter-Alarm-Callbacks nicht funktionieren

Wenn ein Parameter mit einer Closure in einen android_alarm_manager-Callback gereicht wird, passiert stillschweigend nichts. Lösung: eine Top-Level-Funktion, die den Wert als Argument bekommt.

Flutter-Banner: Build for any screen

Auf Stack Overflow wurde gefragt, warum ein Flutter-Alarm nicht auslöst, sobald der Callback als anonyme Funktion geschrieben ist. Die Variante, bei der die Funktion direkt übergeben wird, funktioniert. Die Variante, bei der der Parameter in einer Closure eingefangen wird, nicht. In meiner Antwort dort steht der funktionierende Code. Diese Notiz erklärt dasselbe ausführlicher.

Code und Versionen unten stammen von Januar 2020 (Flutter 1.13, android_alarm_manager 0.4.5). Plugin-APIs ändern sich, prüfe also vor einer Wiederverwendung die aktuelle Dokumentation.

Das Problem

Der funktionierende Aufruf übergibt eine benannte Funktion:

AndroidAlarmManager.oneShotAt(DateTime.now().add(Duration(seconds: 5)), int.parse(id), alarmCallback); // funktioniert

mit einer einfachen Top-Level-Funktion:

void alarmCallback(String id) {
  print("Hello, " + id);
}

Um die id durchzureichen, wurde der Aufruf in eine Closure gewickelt:

AndroidAlarmManager.oneShotAt(DateTime.now().add(Duration(seconds: 5)), int.parse(id), () => alarmCallback(id)); // funktioniert nicht

Es passiert nichts. Es gibt keine Fehlermeldung, und der Callback wird nie ausgeführt.

Warum es scheitert

Das ist mein Verständnis. Bitte prüfe es gegen die Plugin-Dokumentation.

Der Alarm-Callback läuft nicht im Hauptisolate der App, sondern in einem eigenen Hintergrund-Isolate, das auch startet, wenn die App nicht im Vordergrund ist. Damit die Funktion dort gefunden wird, speichert das Plugin ein Callback-Handle, das auf die Funktion über ihren Platz im Code verweist. Flutter kann ein solches Handle nur für Top-Level- oder statische Funktionen erzeugen. Eine Closure fängt lokale Werte ein (hier id) und hat keinen stabilen Namen, über den man sie nachschlagen könnte. Deshalb kann das Plugin sie nicht registrieren.

Die Lösung ist, nichts einzufangen. Der Callback bekommt einen Parameter, und der Wert wird als Alarm-ID übergeben. Das Plugin gibt sie an die Funktion weiter, wenn der Alarm auslöst.

Ein funktionierendes Beispiel

Dieser Code richtet einen periodischen Alarm und einen einmaligen Alarm ein. Der Callback nimmt ein int entgegen, die Alarm-ID.

import 'package:flutter/material.dart';
import 'package:android_alarm_manager/android_alarm_manager.dart';
import 'dart:isolate';

void callbackFunction(int id) async {
  final DateTime now = DateTime.now();
  final int isolateId = Isolate.current.hashCode;
  print('[$now] Param=$id isolate=$isolateId function=$callbackFunction');
}

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  AndroidAlarmManager.initialize();
  runApp(MyApp());

  final int alarmID = 42;
  await AndroidAlarmManager.periodic(const Duration(minutes: 1), alarmID,
          callbackFunction, wakeup: true, exact: true, rescheduleOnReboot: true)
      .then((val) => print('periodic alarm set up:' + val.toString()));

  final int anotherAlarmID = 666;
  AndroidAlarmManager.oneShot(
    Duration(seconds: 3),
    anotherAlarmID,
    callbackFunction,
    wakeup: true,
  ).then((val) => print('oneShot alarm set up:' + val.toString()));
}

Die Alarm-ID ist der Wert, den der Callback bekommt. Deshalb ist der Parameter hier ein int. In der Frage war die ID ein String. Wandle sie daher einmal mit int.parse(id) um, bevor du den Alarm planst, und übergib die Zahl statt einer Closure.

Das Manifest braucht die Berechtigungen für Systemstart und Wake-Lock sowie Service und Receiver des Plugins:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="at.full.flutter_app_new">
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
    <uses-permission android:name="android.permission.WAKE_LOCK"/>
    <application
        android:name="io.flutter.app.FlutterApplication"
        android:label="flutter_app_new"
        android:icon="@mipmap/ic_launcher">
        <activity
            android:name=".MainActivity"
            android:launchMode="singleTop"
            android:theme="@style/LaunchTheme"
            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
            android:hardwareAccelerated="true"
            android:windowSoftInputMode="adjustResize">
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>
                <category android:name="android.intent.category.LAUNCHER"/>
            </intent-filter>
        </activity>
        <service
            android:name="io.flutter.plugins.androidalarmmanager.AlarmService"
            android:permission="android.permission.BIND_JOB_SERVICE"
            android:exported="false"/>
        <receiver
            android:name="io.flutter.plugins.androidalarmmanager.AlarmBroadcastReceiver"
            android:exported="false"/>
        <receiver
            android:name="io.flutter.plugins.androidalarmmanager.RebootBroadcastReceiver"
            android:enabled="false">
            <intent-filter>
                <action android:name="android.intent.action.BOOT_COMPLETED"/>
            </intent-filter>
        </receiver>
        <meta-data
            android:name="flutterEmbedding"
            android:value="2" />
    </application>
</manifest>

So sieht das Log aus, wenn es funktioniert. Der Callback läuft in seinem eigenen Isolate, deshalb unterscheidet sich die Isolate-ID von der der Haupt-App:

I/FlutterBackgroundExecutor(12111): Starting AlarmService...
I/AndroidAlarmManagerPlugin(12111): onAttachedToEngine
I/flutter (12111): periodic alarm set up:true
I/flutter (12111): oneShot alarm set up:true
I/AlarmService(12111): AlarmService started!
I/flutter (12111): [2020-01-07 00:05:33.065838] Param=666! isolate=470178969 function='Closure: (int) => void from Function 'callbackFunction': static.'
I/flutter (12111): [2020-01-07 00:06:26.158709] Param=42! isolate=470178969 function='Closure: (int) => void from Function 'callbackFunction': static.'

Wichtig: Alarme sind nicht exakt

Seit Android API 19 (KitKat) darf das System Alarme verzögern, um Akku zu sparen. exact: true verlangt zwar genaues Timing, das System kann aber trotzdem abweichen. Details stehen in der Stack-Overflow-Antwort zur Alarmgenauigkeit und in der AlarmManager-Dokumentation (englisch).

Quellen

Schlagwörterflutterdartandroidandroid_alarm_managercallbacks