服务注册与分布式协调 / 系统课时

与外部 Workflow 交互

与外部 Workflow 交互

独立 Workflow 之间不必为了通信而改造成父子关系。Temporal 可以通过 Workflow ID 定位另一个执行并发送 Signal 或请求取消;需要等待最终结果时,则应在 Workflow 外部使用 Client 句柄。关键是分清“Workflow 内的确定性交互”和“Client 侧的控制与取结果”。

学习目标

  • 通过 Workflow ID 与独立 Workflow 建立松耦合协作
  • 在 Workflow 代码中发送 Signal 或请求取消
  • 正确区分外部 Workflow 句柄与 Client 结果句柄的能力边界

先区分两种调用上下文

在 TypeScript SDK 中,Workflow 代码可用 getExternalWorkflowHandle(workflowId) 获取外部 Workflow 句柄。这个句柄用于 Signal 和取消,这些操作会被记录进调用方的 Workflow 历史,因此可以可靠重放。

等待另一个独立 Workflow 的最终结果则是另一类需求。getExternalWorkflowHandle 不提供 result();如果调用发生在普通服务、CLI 入口或测试代码中,应通过 client.workflow.getHandle(workflowId) 获取 Client 句柄并等待 result()。如果一个 Workflow 自身必须“耐久地等待”另一个独立 Workflow 的业务结果,更常见的做法是让目标 Workflow 完成后通过 Signal 回传结果,而不是在 Workflow 内创建普通 Client。

Workflow 内部与 Client 侧对外部 Workflow 的交互边界

这个边界很重要:父子关系适合“由父流程创建并拥有”的任务;外部 Workflow 交互适合“双方已经独立存在,只需要协作”的场景,例如订单 Workflow 通知库存 Workflow、风控 Workflow 请求取消支付 Workflow。

在 Workflow 内发送 Signal 或取消

下面的片段示例定义一个等待审批 Signal 的目标 Workflow,以及一个通过 Workflow ID 找到它的协调 Workflow。Worker 需要注册两个 Workflow。

typescript
import {
  condition,
  defineSignal,
  getExternalWorkflowHandle,
  setHandler,
} from '@temporalio/workflow';

export const approveSignal = defineSignal<[string]>('approve');

export async function approvalWorkflow(): Promise<string> {
  let approvedBy: string | undefined;

  setHandler(approveSignal, (operator) => {
    approvedBy = operator;
  });

  await condition(() => approvedBy !== undefined);
  return `approved:${approvedBy}`;
}

export async function coordinatorWorkflow(
  targetWorkflowId: string,
  action: 'approve' | 'cancel',
): Promise<void> {
  const target = getExternalWorkflowHandle(targetWorkflowId);

  if (action === 'cancel') {
    await target.cancel();
    return;
  }

  // Signal 只表达业务事件,不要求双方形成父子生命周期。
  await target.signal(approveSignal, 'coordinator');
}

target.signal(...) 成功表示 Signal 已被 Temporal 接受并记录到目标 Workflow 的事件历史,不代表目标 Workflow 已经完成业务处理。target.cancel() 也是请求取消,不等价于 Terminate;目标 Workflow 仍按自己的取消语义处理。

在 Client 侧等待结果

如果调用方不是 Workflow,而是 API 服务、命令行程序或测试代码,可以用 Client 句柄等待目标结果。下面示例假设 approval-<ID> 已经由前面的协调 Workflow 发送过 approve Signal。

typescript
import { Client, Connection } from '@temporalio/client';

async function main(): Promise<void> {
  const connection = await Connection.connect();

  try {
    const client = new Client({ connection });
    const handle = client.workflow.getHandle('approval-<ID>');

    const result = await handle.result();
    console.log(result);
  } finally {
    await connection.close();
  }
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

运行命令

bash
npx tsx src/wait-result.ts

预期输出

text
approved:coordinator

如果目标不存在,等待结果或发送操作会返回 Not Found 类错误;如果目标最终失败、取消或终止,result() 也会以相应失败结束,而不是返回一个“失败状态字符串”。

设计跨流程协作协议

跨 Workflow 交互真正需要稳定的是 协议,而不是代码引用关系。Workflow ID 要能从业务键稳定推导,Signal 名称和参数要保持兼容,发送方还要决定“Signal 被接受”是否已经足够,还是必须等待目标通过另一个 Signal 回执。

当两个流程必须共享生命周期、父流程需要直接等待子结果时,Child Workflow 更自然;当双方由不同服务拥有、可以独立启动和结束,只需要通过 ID、Signal、取消或结果句柄协作时,外部 Workflow 交互能避免把独立业务错误地绑成父子关系。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

与外部 Workflow 交互

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通