本指南将指导你创建并部署 Pages Function。
你必须在本地计算机上设置 Pages 项目,或在 Cloudflare 仪表板上部署。要创建 Pages 项目,请参阅快速入门。
要开始使用 Pages Function,请创建 /functions 目录。确保 /functions 目录位于 Pages 项目根目录(而非静态根目录,如 /dist)。
在 /functions 目录中编写 Functions 文件将自动在指定路由上生成具有自定义功能的 Worker。
将以下代码复制并粘贴到 /functions 文件夹中创建的 helloworld.js 文件:
export function onRequest(context) {
return new Response("Hello, world!");
}在上面的示例代码中,onRequest 处理器接收 request context 对象。处理器必须返回 Response 或 Promise<Response>。
此 Function 将在 /helloworld 路由上运行并返回 "Hello, world!"。此 Function 在此路由上可用是因为文件名为 helloworld.js。同样,如果文件名为 howdyworld.js,此 function 将在 /howdyworld 上运行。
有关路由自定义的更多信息,请参阅路由。
Workers 运行时功能可在 Pages Functions 上配置,包括对部分 Node.js API 的兼容性以及设置兼容性日期或兼容性标志的能力。
通过向 Wrangler 命令传递参数或在仪表板中设置来配置这些选项。要在 Cloudflare 仪表板中设置 Pages 兼容性标志:
- 登录 Cloudflare 仪表板 ↗ 并选择你的账户。
- 选择 Workers & Pages 并选择你的 Pages 项目。
- 选择 Settings(设置) > Functions(函数) > Compatibility Flags(兼容性标志)。
- 根据需要配置 Production 和 Preview 兼容性标志。
此外,通过配置绑定(binding),可以在 Pages 项目中使用 D1(无服务器 DB)和 R2 等其他 Cloudflare 产品。
设置 Function 后,部署 Pages 项目。通过以下方式部署项目:
- 自定义 Function 路由
- 查看 API 参考
- 了解如何调试 Function