生命周期侦听器 25.02

AppLifecycleListener 接口使外部代码能够观察和响应应用程序生命周期事件。通过实现此接口，您可以在应用程序启动和关闭的特定时刻执行代码，而无需修改 App 类本身。

生命周期侦听器通过服务提供者配置文件在运行时自动发现和加载。每个应用程序实例接收自己的侦听器实例集，保持在同一环境中运行的不同应用程序之间的隔离。

何时使用生命周期侦听器

当您需要时，请使用生命周期侦听器：

在应用程序运行之前初始化资源或服务
当应用程序终止时清理资源
在不修改 App 类的情况下添加跨切关注点
构建插件架构

`AppLifecycleListener` 接口

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

应用程序隔离

每个应用程序实例接收自己的侦听器实例集：

不同应用程序之间的侦听器是隔离的
侦听器中的静态字段不会在应用程序之间共享
侦听器实例在应用程序启动时创建，并在应用程序终止时销毁

如果您需要在应用程序之间共享数据，请使用外部存储机制，例如数据库或共享服务。

生命周期事件

事件	调用时机	常见用途
`onWillCreate` 25.03	在环境初始化后，应用程序创建之前	修改配置，合并外部配置源
`onDidCreate` 25.03	在应用程序实例化后，初始化之前	早期应用级设置，注册服务
`onWillRun`	在 `app.run()` 执行之前	初始化资源，配置服务
`onDidRun`	在 `app.run()` 成功完成后	启动后台任务，记录成功启动
`onWillTerminate`	在应用程序终止之前	保存状态，为关闭做准备
`onDidTerminate`	在应用程序终止后	清理资源，最终日志

创建生命周期侦听器

基本实现

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) {
    // 在应用程序创建之前修改配置
    Config additionalConfig = ConfigFactory.parseString(
      "myapp.feature.enabled = true"
    );
    env.setConfig(additionalConfig);
  }

  @Override
  public void onDidCreate(App app) {
    System.out.println("应用程序已创建: " + app.getId());
  }

  @Override
  public void onWillRun(App app) {
    System.out.println("应用程序正在启动: " + app.getId());
  }

  @Override
  public void onDidRun(App app) {
    System.out.println("应用程序已启动: " + app.getId());
  }
}

注册侦听器

创建一个服务提供者配置文件：

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

com.example.listeners.StartupListener

使用 AutoService

很容易忘记更新服务描述符。使用谷歌的 AutoService 自动生成服务文件：

StartupListener.java
import com.google.auto.service.AutoService;

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

控制执行顺序

当注册多个侦听器时，您可以使用 @AppListenerPriority 注解控制它们的执行顺序。当侦听器之间存在依赖关系或某些初始化必须在其他之前进行时，这一点尤其重要。

优先级值以递增顺序工作 - 较低的数字优先执行。默认优先级为10，因此没有显式优先级注释的侦听器将在优先级较低的侦听器之后执行。

SecurityListener.java
@AutoService(AppLifecycleListener.class)
@AppListenerPriority(1)  // 首先执行 - 关键安全设置
public class SecurityListener implements AppLifecycleListener {
  @Override
  public void onWillRun(App app) {
    initializeSecurity();
  }
}

@AutoService(AppLifecycleListener.class)
@AppListenerPriority(10) // 默认优先级 - 一般日志记录
public class LoggingListener implements AppLifecycleListener {
  @Override
  public void onWillRun(App app) {
    initializeLogging();
  }
}

具有应用程序钩子的执行流程

除了控制多个侦听器之间的顺序外，了解侦听器如何与 App 类自己的生命周期钩子交互也很重要。对于每个生命周期事件，框架遵循特定的执行顺序，以确定您的侦听器相对于应用程序内置钩子的运行时机。

下图说明了这种执行流程，显示了 AppLifecycleListener 方法相对于相应 App 钩子的调用时间：

AppLifecycleListener 侦听器与 App 钩子

错误处理

侦听器抛出的异常会被记录，但不会阻止其他侦听器执行或应用程序运行。始终在侦听器中处理异常：

错误处理示例
@Override
public void onWillRun(App app) {
  try {
    riskyInitialization();
  } catch (Exception e) {
    logger.error("初始化失败", e);
  }
}

何时使用生命周期侦听器​

AppLifecycleListener 接口​

生命周期事件​

创建生命周期侦听器​

基本实现​

注册侦听器​

控制执行顺序​

具有应用程序钩子的执行流程​

错误处理​