Streaming 辅助工具

Streaming 辅助工具提供流式响应的方法。

导入

import { Hono } from 'hono'
import { stream, streamText, streamSSE } from 'hono/streaming'

stream()

以 Response 对象形式返回简单的流式响应。

app.get('/stream', (c) => {
  return stream(c, async (stream) => {
    // Write a process to be executed when aborted.
    stream.onAbort(() => {
      console.log('Aborted!')
    })
    // Write a Uint8Array.
    await stream.write(new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]))
    // Pipe a readable stream.
    await stream.pipe(anotherReadableStream)
  })
})

streamText()

返回带有 Content-Type: text/plain、Transfer-Encoding: chunked 和 X-Content-Type-Options: nosniff 响应头的流式响应。

app.get('/streamText', (c) => {
  return streamText(c, async (stream) => {
    // Write a text with a new line ('\n').
    await stream.writeln('Hello')
    // Wait 1 second.
    await stream.sleep(1000)
    // Write a text without a new line.
    await stream.write(`Hono!`)
  })
})

注意

开发 Cloudflare Workers 应用时，流式传输在 Wrangler 中可能无法正常运行。如果遇到此问题，请为 Content-Encoding 响应头设置 Identity。

app.get('/streamText', (c) => {
  c.header('Content-Encoding', 'Identity')
  return streamText(c, async (stream) => {
    // ...
  })
})

streamSSE()

可以方便地以流式方式发送服务器发送事件（SSE）。

const app = new Hono()
let id = 0

app.get('/sse', async (c) => {
  return streamSSE(c, async (stream) => {
    while (!stream.aborted) {
      const message = `It is ${new Date().toISOString()}`
      await stream.writeSSE({
        data: message,
        event: 'time-update',
        id: String(id++),
      })
      await stream.sleep(1000)
    }
  })
})

错误处理

流式辅助工具的第三个参数是错误处理器。 此参数为可选项；如果不指定，错误会输出到控制台。

app.get('/stream', (c) => {
  return stream(
    c,
    async (stream) => {
      // Write a process to be executed when aborted.
      stream.onAbort(() => {
        console.log('Aborted!')
      })
      // Write a Uint8Array.
      await stream.write(
        new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f])
      )
      // Pipe a readable stream.
      await stream.pipe(anotherReadableStream)
    },
    (err, stream) => {
      stream.writeln('An error occurred!')
      console.error(err)
    }
  )
})

回调执行结束后，流会自动关闭。

注意

如果流式辅助工具的回调函数抛出错误，不会触发 Hono 的 onError 事件。

onError 是在发送响应前处理错误并覆盖响应的钩子。然而，执行回调函数时，流已经开始，因此无法再覆盖响应。