Skip to content

应用程序监控 ​

代码示例: events

Ktor 提供了通过使用事件来监控服务器应用程序的功能。 你可以处理与应用程序生命周期相关的预定义事件(应用程序启动、停止等),也可以使用自定义事件来处理特定情况。你还可以使用 MonitoringEvent 钩子来处理自定义插件的事件。

事件定义 ​

每个事件均由 EventDefinition 类实例表示。该类包含一个 T 类型形参,用于指定传递给事件的值的类型。此值可以在事件处理程序中作为 lambda 实参进行访问。例如,大多数预定义事件都接受 Application 作为形参,允许你在事件处理程序内部访问应用程序属性。

对于自定义事件,你可以传递该事件所需的类型形参。 以下代码段展示了如何创建接受 ApplicationCall 实例的自定义 NotFoundEvent。

kotlin
val NotFoundEvent: EventDefinition<ApplicationCall> = EventDefinition()

自定义事件部分展示了当服务器针对某资源返回 404 Not Found 状态码时,如何在自定义插件中引发该事件。

预定义应用程序事件 ​

Ktor 提供了以下与应用程序生命周期相关的预定义事件:

例如,你可以订阅 ApplicationStopped 事件以释放应用程序资源。

在应用程序中处理事件 ​

要处理指定 Application 实例的事件,请使用 monitor 属性。 该属性提供了对 Events 实例的访问,该实例公开了以下允许你处理应用程序事件的函数:

subscribe / unsubscribe 函数接受带有 T 值的 EventDefinition 实例作为 lambda 实参。 以下示例展示了如何订阅 ApplicationStarted 事件并在事件处理程序中记录日志:

kotlin
fun Application.module() {
    monitor.subscribe(ApplicationStarted) { application ->
        application.environment.log.info("Server is started")
    }
}

在此示例中,你可以了解如何处理 ApplicationStopped 事件:

kotlin
fun Application.module() {
    monitor.subscribe(ApplicationStopped) { application ->
        application.environment.log.info("Server is stopped")
        // 释放资源并取消订阅事件
        monitor.unsubscribe(ApplicationStarted) {}
        monitor.unsubscribe(ApplicationStopped) {}
    }
}

有关完整示例,请参阅 events。

在自定义插件中处理事件 ​

你可以使用 MonitoringEvent 钩子在自定义插件中处理事件。 以下示例展示了如何创建 ApplicationMonitoringPlugin 插件并处理 ApplicationStarted 和 ApplicationStopped 事件:

kotlin
import io.ktor.events.EventDefinition
import io.ktor.http.*
import io.ktor.server.application.*
import io.ktor.server.application.hooks.*

val ApplicationMonitoringPlugin = createApplicationPlugin(name = "ApplicationMonitoringPlugin") {
    on(MonitoringEvent(ApplicationStarted)) { application ->
        application.log.info("Server is started")
    }
    on(MonitoringEvent(ApplicationStopped)) { application ->
        application.log.info("Server is stopped")
        // 释放资源并取消订阅事件
        application.monitor.unsubscribe(ApplicationStarted) {}
        application.monitor.unsubscribe(ApplicationStopped) {}
    }
}

你可以在此处找到完整示例:events。

自定义事件 ​

在本节中,我们将了解如何创建在服务器针对某资源返回 404 Not Found 状态码时引发的自定义事件。

  1. 首先,你需要创建事件定义。 以下代码段展示了如何创建接受 ApplicationCall 作为形参的自定义 NotFoundEvent 事件。

    kotlin
    val NotFoundEvent: EventDefinition<ApplicationCall> = EventDefinition()
  2. 要引发事件,请调用 Events.raise 函数。以下示例展示了如何处理 ResponseSent 钩子,以便在调用的状态码为 404 时引发新创建的事件。

    kotlin
    import io.ktor.events.EventDefinition
    import io.ktor.http.*
    import io.ktor.server.application.*
    import io.ktor.server.application.hooks.*
    
    val ApplicationMonitoringPlugin = createApplicationPlugin(name = "ApplicationMonitoringPlugin") {
        on(ResponseSent) { call ->
            if (call.response.status() == HttpStatusCode.NotFound) {
                this@createApplicationPlugin.application.monitor.raise(NotFoundEvent, call)
            }
        }
    }
  3. 要在 Application 中处理创建的事件,请安装该插件:

    kotlin
    fun Application.module() {
        install(ApplicationMonitoringPlugin)
    }
  4. 然后,使用 Events.subscribe 订阅该事件:

    kotlin
    fun Application.module() {
        install(ApplicationMonitoringPlugin)
        monitor.subscribe(NotFoundEvent) { call ->
            log.info("No page was found for the URI: ${call.request.uri}")
        }
    }

有关完整示例,请参阅 events。