Providers

Cloudflare

将 Nitro 应用部署到 Cloudflare Workers 和 Pages。

Cloudflare Worker

预设: cloudflare_module

Read more in Cloudflare Workers.
此预设使用 模块工作器语法 进行部署。
此预设默认享受 静态资源 的好处。

Cloudflare Pages

预设: cloudflare_pages

Read more in Cloudflare Pages.
可以通过 零配置 集成此提供方。

Nitro 自动生成一个 _routes.json 文件,该文件控制从文件提供的路由和从 Worker 脚本提供的路由。自动生成的路由文件可以通过配置选项 cloudflare.pages.routes 被覆盖 (了解更多)。

使用预设构建您的应用程序

预设仅适用于应用程序构建过程。

如果您使用 Cloudflare Pages GitHub/GitLab 集成,且不需要在本地预览您的应用程序,则 Nitro 不需要任何类型的配置。当您推送到您的代码库时,Cloudflare Pages CI/CD 过程将自动构建您的项目,Nitro 将检测正确的环境并相应地构建您的应用程序。

如果您希望在本地预览您的应用程序和/或手动部署它,在构建应用程序时需要让 Nitro 知道目标环境是 Cloudflare Pages,您可以通过两种方式实现:

  • 在运行构建过程时,将 NITRO_PRESETSERVER_PRESET 环境变量设置为 cloudflare_pages,如下所示:
    NITRO_PRESET=cloudflare_pages npm run build
    
  • 或者通过更新您的 Nitro 预设配置:
    "preset": "cloudflare_pages",
    

    然后运行标准的构建命令:
    npm run build

Wrangler

要在本地预览您的应用程序或手动部署它,您需要使用 wrangler 命令行工具,只需将其安装为 node 依赖项:

npm i wrangler

本地预览您的应用

构建应用程序后,您可以通过运行以下命令使用 wrangler 在本地预览它:

npx wrangler pages dev dist

使用 wrangler 从本地机器部署

构建应用程序后,您可以使用 wrangler 手动部署它,首先确保您已登录 Cloudflare 账户:

npx wrangler login

然后您可以部署该应用程序:

npx wrangler pages deploy dist

运行时钩子

您可以使用 运行时钩子 来扩展 工作器处理程序

Read more in Guide > Plugins#nitro Runtime Hooks.

本地预览您的应用

您可以使用 wrangler 来本地预览您的应用:

NITRO_PRESET=cloudflare npm run build

# 如果您在项目根目录添加了 'wrangler.toml' 文件,如上所示:
npx wrangler dev

# 如果您没有 'wrangler.toml',则直接使用:
npx wrangler dev .output/server/index.mjs --site .output/public

使用 wrangler 从本地机器部署

安装 wrangler 并登录到您的 Cloudflare 账户:

npm i wrangler
wrangler login

使用 cloudflare_module 预设生成您的应用:

NITRO_PRESET=cloudflare_module npm run build

然后您可以在本地预览它:

# 如果您有一个 'wrangler.toml' 文件,如上所示:
npx wrangler dev

# 如果您没有 'wrangler.toml':
npx wrangler dev .output/server/index.mjs --site .output/public

并发布:

npx wrangler deploy

使用 GitHub Actions 在 CI/CD 中部署

无论您使用 Cloudflare Pages 还是 Cloudflare Workers,您都可以使用 Wrangler GitHub actions 来部署您的应用程序。

注意: 请记得 指示 Nitro 使用正确的预设(请注意,这在所有预设中都是必要的,包括 cloudflare_pages)。

环境变量

Nitro 允许您通过 process.envimport.meta.env 或运行时配置通用访问环境变量。

确保仅在 事件生命周期内 访问环境变量,而不是在全局上下文中,因为 Cloudflare 仅在请求生命周期期间提供它们,而不是在此之前。

示例: 如果您设置了 SECRETNITRO_HELLO_THERE 环境变量,您可以通过以下方式访问它们:

console.log(process.env.SECRET) // 请注意,这是在全局范围内!因此实际上它不起作用,变量是未定义的!

export default defineEventHandler((event) => {
  // 请注意,所有以下方式都是访问上述变量的有效方法
  useRuntimeConfig(event).helloThere
  useRuntimeConfig(event).secret
  process.env.NITRO_HELLO_THERE
  import.meta.env.SECRET
});

在开发模式中指定变量

在开发时,您可以使用 .env 文件指定环境变量:

NITRO_HELLO_THERE="captain"
SECRET="top-secret"
注意: 请确保将 .env 添加到 .gitignore 文件中,以免您提交它,因为它可能包含敏感信息。

为本地预览指定变量

构建后,当您尝试在本地使用 wrangler devwrangler pages dev 测试项目时,为了访问环境变量,您需要在项目根目录中指定在 .dev.vars 文件中(如 PagesWorkers 文档中所示)。

如果您在开发时使用了 .env 文件,则您的 .dev.vars 应与之相同。

注意: 请确保将 .dev.vars 添加到 .gitignore 文件中,以免您提交它,因为它可能包含敏感信息。

为生产环境指定变量

对于生产环境,使用 Cloudflare 控制面板或 wrangler secret 命令设置环境变量和秘密。

使用 wrangler.toml 指定变量

您可以指定一个自定义的 wrangler.toml 文件并在其中定义变量。

请注意,这不推荐用于敏感数据。

示例:

wrangler.toml
# 共享
[vars]
NITRO_HELLO_THERE="general"
SECRET="secret"

# 为 `--env production` 用法覆盖值
[env.production.vars]
NITRO_HELLO_THERE="captain"
SECRET="top-secret"

直接访问 Cloudflare 绑定

绑定允许您与 Cloudflare 平台上的资源交互,这些资源的示例包括键值数据存储 (KVs) 和无服务器 SQL 数据库 (D1s)。

有关绑定的更多详细信息及其用法,请参阅 Cloudflare 的 PagesWorkers 文档。
Nitro 提供了高级 API,以便与 KV 存储数据库 交互,强烈建议您优先使用它们,而不是直接依赖低级 API 以确保使用稳定性。
Read more in 数据库层.
Read more in KV 存储.

在运行时,您可以通过访问请求事件的 context.cloudflare.env 字段来访问绑定,例如,您可以这样访问 D1 绑定:

defineEventHandler(async (event) => {
  const { cloudflare } = event.context
  const stmt = await cloudflare.env.MY_D1.prepare('SELECT id FROM table')
  const { results } = await stmt.all()
})

在本地环境中访问绑定

为了在本地开发模式中访问绑定,无论选择的预设是什么,建议使用一个 wrangler.toml 文件(以及一个 .dev.vars 的文件)结合 nitro-cloudflare-dev 模块,如下所示。

nitro-cloudflare-dev 模块是实验性的。Nitro 团队正在寻找更本地化的集成,这可能在不久的将来使该模块不再需要。

为了在开发模式中访问绑定,我们首先在 wrangler.toml 文件中定义绑定,例如,您将如何定义一个变量和一个 KV 命名空间:

wrangler.toml
[vars]
MY_VARIABLE="my-value"

[[kv_namespaces]]
binding = "MY_KV"
id = "xxx"
仅默认环境中的绑定被识别。

接下来,我们安装 nitro-cloudflare-dev 模块以及所需的 wrangler 包(如果尚未安装):

npm i -D nitro-cloudflare-dev wrangler

然后定义模块:

import nitroCloudflareBindings from "nitro-cloudflare-dev";

export default defineNitroConfig({
  modules: [nitroCloudflareBindings],
});

从此时起,当运行

npm run dev

您将能够从请求事件访问 MY_VARIABLEMY_KV,就像上面所示。