Workflow Id 和 Run Id
每个 Temporal 工作流都有两个唯一标识符:Workflow Id 和 Run Id。
核心概念
Workflow Id 是工作流的业务标识符,而 Run Id 是系统生成的执行标识符。 理解这两个标识符的区别和用途对于 Temporal 应用开发至关重要。
Workflow Id
Workflow Id 是工作流的业务标识符,由开发者指定,用于唯一标识一个工作流实例。
Workflow Id 的特点
- • 由开发者指定
- • 通常使用业务相关的 ID
- • 在工作流启动时指定
- • 必须在命名空间内唯一
- • 用于业务逻辑和查询
Workflow Id 的用途
- • 避免重复执行
- • 幂等性保障
- • 业务追踪
- • 工作流查询
- • 历史记录查询
指定 Workflow IdJava
import io.temporal.client.WorkflowOptions;
// 使用业务 ID 作为 Workflow Id
String orderId = "order-12345";
WorkflowOptions options = WorkflowOptions.newBuilder()
.setTaskQueue("order-processing")
.setWorkflowId("order-workflow-" + orderId)
.build();
// 启动工作流
OrderWorkflow workflow = client.newWorkflowStub(
OrderWorkflow.class,
options
);
// 如果使用相同的 Workflow Id 再次启动,会返回已存在的工作流
Workflow Id 重用策略
Workflow Id 重用策略决定了是否允许使用与已关闭的工作流相同的 Workflow Id 启动新的工作流执行。
重用策略类型
- Allow Duplicate:允许使用与已关闭工作流相同的 Workflow Id,这是默认策略。当允许使用相同 Workflow Id 启动新工作流时使用。
- Allow Duplicate Failed Only:仅当先前具有相同 Workflow Id 的工作流未完成时才允许启动新工作流。当需要重新执行失败、超时、终止或取消的工作流时使用。
- Reject Duplicate:如果先前的工作流具有相同的 Workflow Id,则不允许启动新工作流,无论其关闭状态如何。当在给定保留期内每个 Workflow Id 只能有一个工作流执行时使用。
设置 Workflow Id 重用策略Java
import io.temporal.client.WorkflowOptions;
import io.temporal.client.WorkflowIdReusePolicy;
// 设置 Workflow Id 重用策略
WorkflowOptions options = WorkflowOptions.newBuilder()
.setTaskQueue("order-processing")
.setWorkflowId("order-workflow-12345")
.setWorkflowIdReusePolicy(WorkflowIdReusePolicy.RejectDuplicate)
.build();
// 启动工作流
OrderWorkflow workflow = client.newWorkflowStub(
OrderWorkflow.class,
options
);
Workflow Id 冲突策略
Workflow Id 冲突策略用于决定如何解决与正在运行的工作流的 Workflow Id 冲突。
冲突策略说明
当尝试使用与正在运行的工作流相同的 Workflow Id 启动新工作流时,Temporal 会根据冲突策略决定如何处理这种情况。
无论 Workflow Id 重用策略如何设置,都不可能使用与正在运行的工作流相同的 Workflow Id 启动新工作流。
冲突策略类型
- Fail:阻止工作流执行启动,并返回Workflow execution already started错误。如果未指定策略,这是默认策略。
- Use Existing:阻止工作流执行生成,并返回运行中的工作流执行的Run Id。
- Terminate Existing:终止运行中的工作流执行,然后使用相同的工作流ID生成新的工作流执行。
Run Id
Run Id 是系统生成的唯一标识符,用于标识工作流的单次执行。
Run Id 的特点
- • 系统自动生成
- • 全局唯一
- • 每次执行都不同
- • 用于系统内部追踪
- • 格式为 UUID
Run Id 的用途
- • 标识工作流的单次执行
- • 用于系统日志和追踪
- • 处理工作流重试
- • 历史记录查询
- • 系统内部引用
获取 Run IdJava
import io.temporal.client.WorkflowClient;
import io.temporal.client.WorkflowOptions;
import io.temporal.workflow.WorkflowExecution;
// 启动工作流并获取执行信息
WorkflowExecution execution = WorkflowClient.start(
workflow::processOrder,
orderRequest
);
// 获取 Workflow Id
String workflowId = execution.getWorkflowId();
// 获取 Run Id
String runId = execution.getRunId();
System.out.println("Workflow Id: " + workflowId);
System.out.println("Run Id: " + runId);
// 输出示例:
// Workflow Id: order-workflow-order-12345
// Run Id: 550e8400-e29b-41d4-a716-446655440000
两者的区别
| 特性 | Workflow Id | Run Id |
|---|---|---|
| 指定方式 | 开发者指定 | 系统自动生成 |
| 唯一性 | 命名空间内唯一 | 全局唯一 |
| 稳定性 | 持久不变 | 每次执行不同 |
| 用途 | 业务标识和查询 | 系统内部追踪 |
| 格式 | 任意字符串 | UUID |
最佳实践
使用业务相关的 Workflow Id
使用与业务相关的 ID(如订单号、用户 ID 等)作为 Workflow Id,便于追踪和管理
确保 Workflow Id 的唯一性
在命名空间内确保 Workflow Id 的唯一性,避免冲突和重复执行
保存 Run Id 用于调试
在日志中记录 Run Id,便于后续的调试和问题排查
使用 Workflow Id 进行查询
在业务逻辑中,使用 Workflow Id 而不是 Run Id 进行工作流查询和管理
使用场景
使用 Workflow Id
- • 订单处理工作流
- • 支付处理工作流
- • 用户注册流程
- • 任何需要幂等性的业务流程
使用 Run Id
- • 系统日志和监控
- • 工作流历史查询
- • 调试和问题排查
- • 系统内部操作
示例:处理重复执行
处理重复执行Java
import io.temporal.client.WorkflowClient;
import io.temporal.client.WorkflowOptions;
import io.temporal.client.WorkflowAlreadyStartedException;
public void processOrder(String orderId, OrderDetails details) {
String workflowId = "order-" + orderId;
WorkflowOptions options = WorkflowOptions.newBuilder()
.setTaskQueue("order-processing")
.setWorkflowId(workflowId)
.build();
OrderWorkflow workflow = client.newWorkflowStub(
OrderWorkflow.class,
options
);
try {
// 尝试启动工作流
WorkflowClient.start(workflow::processOrder, details);
System.out.println("Order processing started");
} catch (WorkflowAlreadyStartedException e) {
// 工作流已经存在,返回已存在的工作流
System.out.println("Order processing already in progress");
// 可以查询现有工作流的状态
OrderStatus status = workflow.getStatus();
System.out.println("Current status: " + status);
}
}
下一步
[工作流执行
学习工作流执行的更多内容](../execution.md)
[工作流选项
配置工作流执行选项](../../workflow-options.md)
来源:Temporal 中文文档:Workflow Id 和 Run Id。
版权与许可:Temporal 官方文档及其中文译文项目采用 MIT License;保留原作者声明,详见许可证。