WebSocket 辅助函数

WebSocket 辅助函数是用于 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 { upgradeWebSocket, websocket } from 'hono/bun'

// ...

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'
import { html } from 'hono/html'

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>
        {html`
          <script>
            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 辅助函数 ​

导入 ​

upgradeWebSocket() ​

RPC 模式 ​

示例 ​

服务器和客户端 ​

Bun 与 JSX ​

WebSocket 辅助函数

导入

`upgradeWebSocket()`

RPC 模式

示例

服务器和客户端

Bun 与 JSX