Workflows 支持使用 Wrangler(Workers 的命令行工具)进行本地开发。Wrangler 运行的是 Workflows 模拟版本,与 Cloudflare 在全球运行的版本有所不同。
要在本地开发 Workflows,你需要:
-
Wrangler v3.89.0 ↗ 或更高版本。
-
使用 Vite+ (
vp env) ↗ 安装和管理 Node.js 版本。 -
如果你是 Workflows 和/或 Cloudflare Workers 的新用户,请参阅 Workflows 指南 安装
wrangler并部署你的第一个 Workflow。
打开终端并运行以下命令以启动本地开发会话:
# Confirm we are using wrangler v3.89.0+
npx wrangler --version⛅️ wrangler 3.89.0启动本地开发会话
# 启动本地开发会话:
npx wrangler dev------------------
Your worker has access to the following bindings:
- Workflows:
- MY_WORKFLOW: MyWorkflow
⎔ Starting local server...
[wrangler:inf] Ready on http://127.0.0.1:8787/本地开发会话会创建一个仅在本地运行的独立环境,模拟 Workflows 的生产运行环境,让你在部署到生产环境 之前 测试 Workflows。
请参阅 wrangler dev 文档 了解如何配置本地开发会话。
在 wrangler dev 会话运行期间,你可以使用所有 wrangler workflows 命令 并加上 --local 标志与本地 Workflow 实例交互。
--local 标志也适用于只在 Wrangler 配置的 exports 字段中声明、而没有 workflows 绑定的 Workflows。这需要 Wrangler 4.142.0 或更高版本。
例如,列出本地 Workflows:
npx wrangler workflows list --local在本地触发 Workflow:
npx wrangler workflows trigger my-workflow --local检查特定实例:
npx wrangler workflows instances describe my-workflow <INSTANCE_ID> --local所有命令都接受 --port 以指定特定的 wrangler dev 会话(默认为 8787)。
Local Explorer 是一个基于浏览器的界面,用于在开发期间查看和管理本地 Workflow 实例。无需运行 CLI 命令,你可以在浏览器中打开 Local Explorer 并直接与 Workflows 交互。
运行 wrangler dev 会话期间,在终端中按 e 打开 Local Explorer,或在浏览器中访问 http://localhost:8787/cdn-cgi/local/explorer。
使用 Local Explorer 你可以:
- 查看项目中定义的所有 Workflows 及其实例。
- 检查每个实例的步骤历史和当前状态。
- 触发新的 Workflow 运行并向运行中的实例发送事件。
- 暂停、恢复、终止和重启实例。
- 删除特定实例或一次性清除所有实例。
Local Explorer 需要 Wrangler 版本 4.82.1 或更高,或 Cloudflare Vite 插件 版本 1.32.0 或更高。
Local Explorer 也会列出仅在 exports 中声明的 Workflows,前提是使用 Wrangler 4.142.0 或更高版本,或 Cloudflare Vite 插件 1.61.0 或更高版本。
Workflows 不支持作为远程绑定(binding) 使用,也不支持在使用 npx wrangler dev --remote 时使用。
本地开发会忽略 Workflow 的 jurisdiction 设置。