Die Verwendung einer Wakelock kann die Geräteleistung beeinträchtigen. Wenn Sie einen Wake Lock verwenden müssen, ist es wichtig, dies richtig zu tun. In diesem Dokument werden einige Best Practices beschrieben, mit denen Sie häufige Probleme mit Wakelocks vermeiden können.
Wake-Lock richtig benennen
Wir empfehlen, den Namen des Pakets, der Klasse oder der Methode in das Wakelock-Tag aufzunehmen. So lässt sich bei einem Fehler leichter die Stelle im Quellcode finden, an der die Wakelock erstellt wurde. Hier sind einige zusätzliche Tipps:
- Geben Sie im Namen keine personenidentifizierbaren Informationen wie eine E-Mail-Adresse an. Wenn das Gerät personenidentifizierbare Informationen im Wake-Lock-Tag erkennt, wird
_UNKNOWNanstelle des von Ihnen angegebenen Tags protokolliert. - Rufen Sie den Klassen- oder Methodennamen nicht programmatisch ab, z. B. durch Aufrufen von
getName(). Wenn Sie versuchen, den Namen programmatisch abzurufen, wird er möglicherweise durch Tools wie Proguard verschleiert. Verwenden Sie stattdessen einen hartcodierten String. - Fügen Sie Wakelock-Tags keine Zähler oder eindeutigen Kennungen hinzu. Der Code, der einen Wake-Lock erstellt, sollte bei jeder Ausführung dasselbe Tag verwenden. So kann das System die Wakelock-Nutzung der einzelnen Methoden zusammenfassen.
Die App muss im Vordergrund sichtbar sein.
Solange ein Wakelock aktiv ist, verbraucht das Gerät Strom. Der Nutzer des Geräts sollte sich dessen bewusst sein. Wenn du eine Wakelock verwendest, solltest du dem Nutzer daher eine Benachrichtigung anzeigen. In der Praxis bedeutet das, dass ihr die Wakelock in einem Dienst im Vordergrund abrufen und halten solltet. Dienste im Vordergrund müssen eine Benachrichtigung anzeigen.
Wenn ein Dienst im Vordergrund nicht die richtige Wahl für Ihre App ist, sollten Sie wahrscheinlich auch keinen Wakelock verwenden. Weitere Möglichkeiten, Aufgaben auszuführen, während Ihre App nicht im Vordergrund ist, finden Sie in der Dokumentation Die richtige API auswählen, um das Gerät aktiv zu halten.
Logik einfach halten
Achte darauf, dass die Logik zum Erwerben und Freigeben von Wakelocks so einfach wie möglich ist. Wenn die Wake-Lock-Logik an komplexe Zustandsautomaten, Zeitlimits, Executor-Pools oder Callback-Ereignisse gebunden ist, kann ein kleiner Fehler in dieser Logik dazu führen, dass der Wake-Lock länger als erwartet gehalten wird. Diese Fehler sind schwer zu diagnostizieren und zu beheben.
Prüfen, ob die Wakelock immer freigegeben wird
Wenn du einen Wake-Lock verwendest, musst du dafür sorgen, dass jeder Wake-Lock, den du erwirbst, ordnungsgemäß freigegeben wird. Das ist nicht immer so einfach, wie es klingt. Der folgende Code weist beispielsweise ein Problem auf:
@Throws(MyException::class) fun doSomethingAndRelease() { wakeLock.apply { acquire() doTheWork() // can potentially throw MyException. release() // does not run if an exception is thrown. } }
Das Problem hierbei ist, dass die Methode doTheWork() die Ausnahme MyException auslösen kann. Wenn dies der Fall ist, wird die Ausnahme von der Methode doSomethingAndRelease() nach außen weitergegeben und der Aufruf release() wird nie erreicht. Das Ergebnis ist, dass die Wakelock-Sperre zwar aktiviert, aber nicht wieder aufgehoben wird, was sehr schlecht ist.
Im korrigierten Code sorgt doSomethingAndRelease() dafür, dass die Wakelock-Sperre auch dann aufgehoben wird, wenn eine Ausnahme ausgelöst wird:
@Throws(MyException::class) fun doSomethingAndRelease() { wakeLock.apply { try { acquire() doTheWork() } finally { release() } } }