@WebSocket

代码示例

在这里使用 @WebSocket 注解，并设置 WebSocketSessionHandler 类型，他是 suspend DefaultClientWebSocketSession.() -> Unit 类型的别名

@BearerAuth
@WebSocket(url = "friendMessageSocket")
suspend fun friendMessageSocket(handler: WebSocketSessionHandler)

您也可以使用 ws:// 或者 wss:// 前缀的完整 url，当然您也可以直接使用 suspend DefaultClientWebSocketSession.() -> Unit 类型

@WebSocket("ws://ktorfitx.cn:8080/api/keepAlive")
suspend fun keepAlive(handler: suspend DefaultClientWebSocketSession.() -> Unit)

生成实现

可以看到生成的实现中调用了 HttpClient 的 webSocket() 函数，并正确设置了对应的参数

override suspend fun friendMessageSocket(handler: WebSocketSessionHandler) {
	val token = this.config.token?.invoke()
	this.config.httpClient.webSocket(
		urlString = "friendMessageSocket",
		request = {
			if (token != null) {
				this.bearerAuth(token)
			}
		},
		block = handler
	)
}

这里能看到使用了完整 url

override suspend fun keepAlive(handler: suspend DefaultClientWebSocketSession.() -> Unit) {
	this.config.httpClient.webSocket(
		urlString = "ws://ktorfitx.cn:8080/api/keepAlive",
		block = handler
	)
}

Last modified: 30 July 2025