Lebenszyklus-Listener 25.02

In ChatGPT öffnen

Das AppLifecycleListener-Interface ermöglicht externem Code, App-Lebenszyklusereignisse zu beobachten und darauf zu reagieren. Durch die Implementierung dieses Interfaces können Sie Code zu bestimmten Zeitpunkten während des Starts und der Beendigung der App ausführen, ohne die App-Klasse selbst zu verändern.

Lebenszyklus-Listener werden zur Laufzeit automatisch über Dienstanbieter-Konfigurationsdateien entdeckt und geladen. Jede App-Instanz erhält ihre eigenen Listener-Instanzen, was die Isolation zwischen verschiedenen Apps gewährleistet, die in derselben Umgebung ausgeführt werden.

Wann Lebenszyklus-Listener verwendet werden sollten

Verwenden Sie Lebenszyklus-Listener, wenn Sie:

• Ressourcen oder Dienste initialisieren möchten, bevor eine App ausgeführt wird
• Ressourcen bereinigen möchten, wenn eine App beendet wird
• Querschnittsbelange hinzufügen möchten, ohne die App-Klasse zu verändern
• Plugin-Architekturen erstellen möchten

Das AppLifecycleListener-Interface

AppLifecycleListener.java

public interface AppLifecycleListener {
  default void onWillCreate(Environment env) {}     // Seit 25.03
  default void onDidCreate(App app) {}              // Seit 25.03
  default void onWillRun(App app) {}
  default void onDidRun(App app) {}
  default void onWillTerminate(App app) {}
  default void onDidTerminate(App app) {}
}

App-Isolation

Jede App-Instanz erhält ihre eigenen Listener-Instanzen:

• Listener sind zwischen verschiedenen Apps isoliert
• Statische Felder in Listenern werden nicht zwischen Apps geteilt
• Listener-Instanzen werden erstellt, wenn die App gestartet wird, und werden zerstört, wenn sie beendet wird

Wenn Sie Daten zwischen Apps teilen müssen, verwenden Sie externe Speichermechanismen wie Datenbanken oder gemeinsame Dienste.

Lebenszyklusereignisse

Ereignis	Wann aufgerufen	Häufige Verwendungen
onWillCreate 25.03	Nach der Initialisierung der Umgebung, vor der App-Erstellung	Konfiguration ändern, externe Konfigurationsquellen zusammenführen
onDidCreate 25.03	Nach der Instanziierung der App, vor der Initialisierung	Frühe App-Einrichtung, Dienste registrieren
onWillRun	Vor der Ausführung von app.run()	Ressourcen initialisieren, Dienste konfigurieren
onDidRun	Nachdem app.run() erfolgreich abgeschlossen wurde	Hintergrundaufgaben starten, erfolgreichen Start protokollieren
onWillTerminate	Vor der Beendigung der App	Zustand speichern, auf den Shutdown vorbereiten
onDidTerminate	Nach der Beendigung der App	Ressourcen bereinigen, abschließendes Logging

Einen Lebenszyklus-Listener erstellen

Grundlegende Implementierung

StartupListener.java

import com.webforj.App;
import com.webforj.AppLifecycleListener;
import com.webforj.Environment;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;

public class StartupListener implements AppLifecycleListener {

  @Override
  public void onWillCreate(Environment env) {
    // Konfiguration vor der App-Erstellung ändern
    Config additionalConfig = ConfigFactory.parseString(
      "myapp.feature.enabled = true"
    );
    env.setConfig(additionalConfig);
  }

  @Override
  public void onDidCreate(App app) {
    System.out.println("App erstellt: " + app.getId());
  }

  @Override
  public void onWillRun(App app) {
    System.out.println("App startet: " + app.getId());
  }

  @Override
  public void onDidRun(App app) {
    System.out.println("App gestartet: " + app.getId());
  }
}

Den Listener registrieren

Erstellen Sie eine Dienstanbieter-Konfigurationsdatei:

Datei: src/main/resources/META-INF/services/com.webforj.AppLifecycleListener

com.example.listeners.StartupListener

Verwendung von AutoService

Es ist leicht zu vergessen, Dienstbeschreibungen zu aktualisieren. Verwenden Sie Googles AutoService, um die Dienstdatei automatisch zu generieren:

StartupListener.java

import com.google.auto.service.AutoService;

@AutoService(AppLifecycleListener.class)
public class StartupListener implements AppLifecycleListener {
  // Implementierung
}

Ausführungsreihenfolge steuern

Wenn mehrere Listener registriert sind, können Sie deren Ausführungsreihenfolge mit der Annotation @AppListenerPriority steuern. Dies ist besonders wichtig, wenn Listener Abhängigkeiten voneinander haben oder wenn bestimmte Initialisierungen vor anderen geschehen müssen.

Prioritätswerte funktionieren aufsteigend - niedrigere Zahlen werden zuerst ausgeführt. Die Standardpriorität ist 10, sodass Listener ohne explizite Prioritätsannotationen nach denen mit niedrigeren Prioritätswerten ausgeführt werden.

SecurityListener.java

@AutoService(AppLifecycleListener.class)
@AppListenerPriority(1)  // Wird zuerst ausgeführt - kritische Sicherheitskonfiguration
public class SecurityListener implements AppLifecycleListener {
  @Override
  public void onWillRun(App app) {
    initializeSecurity();
  }
}

@AutoService(AppLifecycleListener.class)
@AppListenerPriority(10) // Standardpriorität - allgemeines Logging
public class LoggingListener implements AppLifecycleListener {
  @Override
  public void onWillRun(App app) {
    initializeLogging();
  }
}

Ausführungsfluss mit App-Hooks

Neben der Kontrolle der Reihenfolge zwischen mehreren Listenern ist es wichtig zu verstehen, wie Listener mit den eigenen Lebenszyklus-Hooks der App-Klasse interagieren. Für jedes Lebenszyklusereignis folgt das Framework einer bestimmten Ausführungsreihenfolge, die bestimmt, wann Ihre Listener im Verhältnis zu den eingebauten Hooks der App ausgeführt werden.

Das Diagramm unten veranschaulicht diesen Ausführungsfluss und zeigt den genauen Zeitpunkt, wann die Methoden des AppLifecycleListener im Verhältnis zu den entsprechenden App-Hooks aufgerufen werden:

Fehlerbehandlung

Ausnahmen, die von Listenern ausgelöst werden, werden protokolliert, verhindern jedoch nicht, dass andere Listener ausgeführt werden oder die App läuft. Behandeln Sie immer Ausnahmen innerhalb Ihrer Listener:

Beispiel zur Fehlerbehandlung

@Override
public void onWillRun(App app) {
  try {
    riskyInitialization();
  } catch (Exception e) {
    logger.error("Initialisierung fehlgeschlagen", e);
  }
}