Cloudflare Pages

Cloudflare Pages 是一个面向全栈 Web 应用的边缘平台。它用于提供静态文件服务，并通过 Cloudflare Workers 提供动态内容。

Hono 完全支持 Cloudflare Pages。它带来了愉悦的开发体验。Vite 的开发服务器运行迅速，使用 Wrangler 部署也非常快捷。

1. 设置

我们提供了一个 Cloudflare Pages 的启动模板。使用 "create-hono" 命令启动你的项目。在本例中选择 cloudflare-pages 模板。

npm create hono@latest my-app

yarn create hono my-app

pnpm create hono my-app

bun create hono@latest my-app

deno init --npm hono my-app

进入 my-app 目录并安装依赖。

npmyarnpnpmbun

cd my-app
npm i

cd my-app
yarn

cd my-app
pnpm i

cd my-app
bun i

以下是基本的目录结构。

text

./
├── package.json
├── public
│   └── static // 放置你的静态文件
│       └── style.css // 你可以通过 `/static/style.css` 引用它
├── src
│   ├── index.tsx // 服务端的入口点
│   └── renderer.tsx
├── tsconfig.json
└── vite.config.ts

2. Hello World

按如下方式编辑 src/index.tsx：

tsx

import { Hono } from 'hono'
import { renderer } from './renderer'

const app = new Hono()

app.get('*', renderer)

app.get('/', (c) => {
  return c.render(<h1>Hello, Cloudflare Pages!</h1>)
})

export default app

3. 运行

在本地运行开发服务器。然后在浏览器中访问 http://localhost:5173。

npmyarnpnpmbun

npm run dev

yarn dev

pnpm dev

bun run dev

4. 部署

如果你有 Cloudflare 账户，你可以部署到 Cloudflare。在 package.json 中，需要将 $npm_execpath 更改为你选择的包管理器。

npmyarnpnpmbun

npm run deploy

yarn deploy

pnpm run deploy

bun run deploy

通过 GitHub 在 Cloudflare 控制台部署

登录 Cloudflare 控制台并选择你的账户。
在账户主页，选择 Workers & Pages > Create application > Pages > Connect to Git。
授权你的 GitHub 账户，并选择仓库。在设置构建和部署时，提供以下信息：

配置选项	值
Production branch	`main`
Build command	`npm run build`
Build directory	`dist`

绑定

你可以使用 Cloudflare 的绑定功能，如变量、KV、D1 等。在本节中，我们将使用变量和 KV。

创建 `wrangler.toml`

首先，为本地绑定创建 wrangler.toml：

touch wrangler.toml

编辑 wrangler.toml。指定名为 MY_NAME 的变量。

toml

[vars]
MY_NAME = "Hono"

创建 KV

接下来，创建 KV。运行以下 wrangler 命令：

wrangler kv namespace create MY_KV --preview

记下输出中的 preview_id：

{ binding = "MY_KV", preview_id = "abcdef" }

使用绑定名称 MY_KV 指定 preview_id：

toml

[[kv_namespaces]]
binding = "MY_KV"
id = "abcdef"

编辑 `vite.config.ts`

编辑 vite.config.ts：

import devServer from '@hono/vite-dev-server'
import adapter from '@hono/vite-dev-server/cloudflare'
import build from '@hono/vite-cloudflare-pages'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    devServer({
      entry: 'src/index.tsx',
      adapter, // Cloudflare 适配器
    }),
    build(),
  ],
})

在应用中使用绑定

在应用中使用变量和 KV。设置类型：

type Bindings = {
  MY_NAME: string
  MY_KV: KVNamespace
}

const app = new Hono<{ Bindings: Bindings }>()

使用它们：

tsx

app.get('/', async (c) => {
  await c.env.MY_KV.put('name', c.env.MY_NAME)
  const name = await c.env.MY_KV.get('name')
  return c.render(<h1>Hello! {name}</h1>)
})

生产环境

对于 Cloudflare Pages，你将在本地开发时使用 wrangler.toml，但在生产环境中，你需要在控制台中设置绑定。

客户端

你可以编写客户端脚本并使用 Vite 的功能将其导入到应用中。如果 /src/client.ts 是客户端的入口点，只需在 script 标签中写入即可。此外，import.meta.env.PROD 可用于检测是否在开发服务器上运行或处于构建阶段。

tsx

app.get('/', (c) => {
  return c.html(
    <html>
      <head>
        {import.meta.env.PROD ? (
          <script type='module' src='/static/client.js'></script>
        ) : (
          <script type='module' src='/src/client.ts'></script>
        )}
      </head>
      <body>
        <h1>Hello</h1>
      </body>
    </html>
  )
})

为了正确构建脚本，你可以使用如下示例配置文件 vite.config.ts：

import pages from '@hono/vite-cloudflare-pages'
import devServer from '@hono/vite-dev-server'
import { defineConfig } from 'vite'

export default defineConfig(({ mode }) => {
  if (mode === 'client') {
    return {
      build: {
        rollupOptions: {
          input: './src/client.ts',
          output: {
            entryFileNames: 'static/client.js',
          },
        },
      },
    }
  } else {
    return {
      plugins: [
        pages(),
        devServer({
          entry: 'src/index.tsx',
        }),
      ],
    }
  }
})

你可以运行以下命令来构建服务端和客户端脚本：

vite build --mode client && vite build