CORS 中间件

Cloudflare Workers 作为 Web API 有很多用例，可以从外部前端应用程序调用它们。 为此，我们必须实现 CORS，让我们也使用中间件来完成此操作。

导入

import { Hono } from 'hono'
import { cors } from 'hono/cors'

用法

const app = new Hono()

// CORS 应在路由之前调用
app.use('/api/*', cors())
app.use(
  '/api2/*',
  cors({
    origin: 'http://example.com',
    allowHeaders: ['X-Custom-Header', 'Upgrade-Insecure-Requests'],
    allowMethods: ['POST', 'GET', 'OPTIONS'],
    exposeHeaders: ['Content-Length', 'X-Kuma-Revision'],
    maxAge: 600,
    credentials: true,
  })
)

app.all('/api/abc', (c) => {
  return c.json({ success: true })
})
app.all('/api2/abc', (c) => {
  return c.json({ success: true })
})

多个来源：

app.use(
  '/api3/*',
  cors({
    origin: ['https://example.com', 'https://example.org'],
  })
)

// 或者您可以使用“函数”
app.use(
  '/api4/*',
  cors({
    // `c` 是 `Context` 对象
    origin: (origin, c) => {
      return origin.endsWith('.example.com')
        ? origin
        : 'http://example.com'
    },
  })
)

基于来源的动态允许方法：

app.use(
  '/api5/*',
  cors({
    origin: (origin) =>
      origin === 'https://example.com' ? origin : '*',
    // `c` 是 `Context` 对象
    allowMethods: (origin, c) =>
      origin === 'https://example.com'
        ? ['GET', 'HEAD', 'POST', 'PATCH', 'DELETE']
        : ['GET', 'HEAD'],
  })
)

选项

可选 origin: string | string[] | (origin:string, c:Context) => string

“Access-Control-Allow-Origin” CORS 标头的值。您还可以传递回调函数，例如 origin: (origin) => (origin.endsWith('.example.com') ? origin : 'http://example.com')。默认值为 *。

可选 allowMethods: string[] | (origin:string, c:Context) => string[]

“Access-Control-Allow-Methods” CORS 标头的值。您还可以传递回调函数以根据来源动态确定允许的方法。默认值为 ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH']。

可选 allowHeaders: string[]

“Access-Control-Allow-Headers” CORS 标头的值。默认值为 []。

可选 maxAge: number

“Access-Control-Max-Age” CORS 标头的值。

可选 credentials: boolean

“Access-Control-Allow-Credentials” CORS 标头的值。

可选 exposeHeaders: string[]

“Access-Control-Expose-Headers” CORS 标头的值。默认值为 []。

依赖于环境的 CORS 配置

如果要根据执行环境（例如开发或生产）调整 CORS 配置，从环境变量注入值很方便，因为它消除了应用程序了解其自身执行环境的需要。有关说明，请参见下面的示例。

app.use('*', async (c, next) => {
  const corsMiddlewareHandler = cors({
    origin: c.env.CORS_ORIGIN,
  })
  return corsMiddlewareHandler(c, next)
})

与 Vite 一起使用

将 Hono 与 Vite 一起使用时，应通过在 vite.config.ts 中将 server.cors 设置为 false 来禁用 Vite 的内置 CORS 功能。这可以防止与 Hono 的 CORS 中间件发生冲突。

// vite.config.ts
import { cloudflare } from '@cloudflare/vite-plugin'
import { defineConfig } from 'vite'

export default defineConfig({
  server: {
    cors: false, // 禁用 Vite 的内置 CORS 设置
  },
  plugins: [cloudflare()],
})