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>你好，Cloudflare Pages！</h1>)
})

export default app

3. 运行

在本地运行开发服务器。然后，在您的 Web 浏览器中访问 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”>“创建应用程序”>“Pages”>“连接到 Git”。
授权您的 GitHub 帐户，然后选择存储库。在“设置构建和部署”中，提供以下信息：

配置选项	值
生产分支	`main`
构建命令	`npm run build`
构建目录	`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>你好！{name}</h1>)
})

在生产环境中

对于 Cloudflare Pages，您将使用 wrangler.toml 进行本地开发，但对于生产环境，您将在仪表板中设置绑定。

客户端

您可以使用 Vite 的功能编写客户端脚本并将其导入到您的应用程序中。如果 /src/client.ts 是客户端的入口点，只需将其写入脚本标签即可。此外，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>你好</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