WebSocket Helper

WebSocket Helper 是一个用于 Hono 应用程序中服务端 WebSocket 的工具。目前支持 Cloudflare Workers / Pages、Deno 和 Bun 适配器。

导入

Cloudflare WorkersDenoBun

import { Hono } from 'hono'
import { upgradeWebSocket } from 'hono/cloudflare-workers'

import { Hono } from 'hono'
import { upgradeWebSocket } from 'hono/deno'

import { Hono } from 'hono'
import { createBunWebSocket } from 'hono/bun'
import type { ServerWebSocket } from 'bun'

const { upgradeWebSocket, websocket } =
  createBunWebSocket<ServerWebSocket>()

// ...

export default {
  fetch: app.fetch,
  websocket,
}

如果你使用 Node.js，可以使用 @hono/node-ws。

`upgradeWebSocket()`

upgradeWebSocket() 返回一个用于处理 WebSocket 的处理器。

const app = new Hono()

app.get(
  '/ws',
  upgradeWebSocket((c) => {
    return {
      onMessage(event, ws) {
        console.log(`来自客户端的消息：${event.data}`)
        ws.send('服务器回应：你好！')
      },
      onClose: () => {
        console.log('连接已关闭')
      },
    }
  })
)

可用的事件：

onOpen - 目前 Cloudflare Workers 不支持此事件
onMessage
onClose
onError

WARNING

如果你在使用 WebSocket 助手的路由上同时使用修改头部的中间件（例如应用 CORS），可能会遇到无法修改不可变头部的错误。这是因为 upgradeWebSocket() 在内部也会修改头部。

因此，在同时使用 WebSocket 助手和中间件时请务必小心。

RPC 模式

使用 WebSocket 助手定义的处理器支持 RPC 模式。

// server.ts
const wsApp = app.get(
  '/ws',
  upgradeWebSocket((c) => {
    //...
  })
)

export type WebSocketApp = typeof wsApp

// client.ts
const client = hc<WebSocketApp>('http://localhost:8787')
const socket = client.ws.$ws() // 用于客户端的 WebSocket 对象

示例

以下是使用 WebSocket 助手的示例。

服务端和客户端

// server.ts
import { Hono } from 'hono'
import { upgradeWebSocket } from 'hono/cloudflare-workers'

const app = new Hono().get(
  '/ws',
  upgradeWebSocket(() => {
    return {
      onMessage: (event) => {
        console.log(event.data)
      },
    }
  })
)

export default app

// client.ts
import { hc } from 'hono/client'
import type app from './server'

const client = hc<typeof app>('http://localhost:8787')
const ws = client.ws.$ws(0)

ws.addEventListener('open', () => {
  setInterval(() => {
    ws.send(new Date().toString())
  }, 1000)
})

在 Bun 中使用 JSX

tsx

import { Hono } from 'hono'
import { createBunWebSocket } from 'hono/bun'

const { upgradeWebSocket, websocket } = createBunWebSocket()

const app = new Hono()

app.get('/', (c) => {
  return c.html(
    <html>
      <head>
        <meta charset='UTF-8' />
      </head>
      <body>
        <div id='now-time'></div>
        <script
          dangerouslySetInnerHTML={{
            __html: `
        const ws = new WebSocket('ws://localhost:3000/ws')
        const $nowTime = document.getElementById('now-time')
        ws.onmessage = (event) => {
          $nowTime.textContent = event.data
        }
        `,
          }}
        ></script>
      </body>
    </html>
  )
})

const ws = app.get(
  '/ws',
  upgradeWebSocket((c) => {
    let intervalId
    return {
      onOpen(_event, ws) {
        intervalId = setInterval(() => {
          ws.send(new Date().toString())
        }, 200)
      },
      onClose() {
        clearInterval(intervalId)
      },
    }
  })
)

export default {
  fetch: app.fetch,
  websocket,
}

WebSocket Helper ​

导入 ​

upgradeWebSocket() ​

RPC 模式 ​

示例 ​

服务端和客户端 ​

在 Bun 中使用 JSX ​

WebSocket Helper

导入

`upgradeWebSocket()`

RPC 模式

示例

服务端和客户端

在 Bun 中使用 JSX