工作流 on Dapr 文档库

工作流概述

Mon, 01 Jan 0001 00:00:00 +0000

Dapr 工作流让开发人员能够可靠地编写业务逻辑和集成。由于 Dapr 工作流是有状态的，它们支持长时间运行和容错应用程序，非常适合编排微服务。Dapr 工作流与其他 Dapr 构建块（如服务调用、发布订阅、状态管理和绑定）无缝协作。

Dapr 工作流的耐用性和弹性功能包括：

提供内置的工作流运行时以驱动 Dapr 工作流执行。
提供用于在代码中编写工作流的 SDK，支持多种编程语言。
提供用于管理工作流（启动、查询、暂停/恢复、触发事件、终止、清除）的 HTTP 和 gRPC API。
通过工作流组件与其他工作流运行时集成。

Dapr 工作流可以应用于以下场景：

涉及库存管理、支付系统和运输服务之间编排的订单处理。
协调多个部门和参与者任务的人力资源入职工作流。
在全国餐饮连锁店中协调数字菜单更新的推出。
涉及基于 API 的分类和存储的图像处理工作流。

功能

工作流和活动

使用 Dapr 工作流，您可以编写活动，然后在工作流中编排这些活动。工作流活动是：

工作流中的基本工作单元
用于调用其他（Dapr）服务、与状态存储交互以及发布订阅代理。

了解更多关于工作流活动的信息。

子工作流

除了活动之外，您还可以编写工作流以调度其他工作流作为子工作流。子工作流具有独立于启动它的父工作流的实例 ID、历史记录和状态，除了终止父工作流会终止由其创建的所有子工作流这一事实。子工作流还支持自动重试策略。

了解更多关于子工作流的信息。

定时器和提醒

与 Dapr actor 相同，您可以为任何时间范围安排类似提醒的持久延迟。

了解更多关于工作流定时器和提醒

使用 HTTP 调用管理工作流

当您使用工作流代码创建应用程序并使用 Dapr 运行它时，您可以调用驻留在应用程序中的特定工作流。每个单独的工作流可以：

通过 POST 请求启动或终止
通过 POST 请求触发以传递命名事件
通过 POST 请求暂停然后恢复
通过 POST 请求从您的状态存储中清除
通过 GET 请求查询工作流状态

了解更多关于如何使用 HTTP 调用管理工作流的信息。

功能和概念

Mon, 01 Jan 0001 00:00:00 +0000

在您已经从高层次了解了工作流构建块之后，让我们深入探讨 Dapr 工作流引擎和 SDK 所包含的功能和概念。Dapr 工作流在所有支持的语言中都提供了几个核心功能和概念。

注意

有关工作流状态管理的更多信息，请参阅工作流架构指南。

工作流

Dapr 工作流是您编写的函数，用于定义一系列按特定顺序执行的任务。Dapr 工作流引擎负责调度和执行这些任务，包括管理故障和重试。如果托管工作流的应用程序在多台机器上扩展，工作流引擎还可以在多台机器上负载均衡工作流及其任务的执行。

工作流可以调度多种类型的任务，包括：

用于执行自定义逻辑的活动
用于将工作流休眠任意时间长度的持久计时器
用于将较大的工作流分解为较小部分的子工作流
用于阻塞工作流直到接收到外部事件信号的外部事件等待器。这些任务在其相应的部分中有更详细的描述。

工作流标识

每个您定义的工作流都有一个类型名称，工作流的每次执行都需要一个唯一的_实例 ID_。工作流实例 ID 可以由您的应用程序代码生成，这在工作流对应于业务实体（如文档或作业）时很有用，或者可以是自动生成的 UUID。工作流的实例 ID 对于调试以及使用工作流 API管理工作流非常有用。

在任何给定时间，只能存在一个具有给定 ID 的工作流实例。然而，如果一个工作流实例完成或失败，其 ID 可以被新的工作流实例重用。但请注意，新工作流实例实际上会在配置的状态存储中替换旧的实例。

工作流重放

Dapr 工作流通过使用一种称为事件溯源的技术来维护其执行状态。工作流引擎不是将工作流的当前状态存储为快照，而是管理一个仅追加的历史事件日志，描述工作流所采取的各种步骤。当使用工作流 SDK 时，这些历史事件会在工作流“等待”计划任务的结果时自动存储。

当工作流“等待”计划任务时，它会从内存中卸载自己，直到任务完成。一旦任务完成，工作流引擎会再次调度工作流函数运行。此时的工作流函数执行被称为_重放_。

当工作流函数被重放时，它会从头开始再次运行。然而，当它遇到已经完成的任务时，工作流引擎不会再次调度该任务，而是：

将已完成任务的存储结果返回给工作流。
继续执行直到下一个“等待”点。

这种“重放”行为会持续到工作流函数完成或因错误而失败。

通过这种重放技术，工作流能够从任何“等待”点恢复执行，就像它从未从内存中卸载过一样。即使是先前运行的局部变量的值也可以恢复，而无需工作流引擎了解它们存储了什么数据。这种恢复状态的能力使 Dapr 工作流具有_持久性_和_容错性_。

注意

这里描述的工作流重放行为要求工作流函数代码是_确定性的_。确定性的工作流函数在提供完全相同的输入时采取完全相同的操作。了解有关确定性工作流代码限制的更多信息。

无限循环和永恒工作流

如工作流重放部分所述，工作流维护其所有操作的仅写事件溯源历史日志。为了避免资源使用失控，工作流必须限制其调度的操作数量。例如，确保您的工作流不会：

在其实现中使用无限循环
调度数千个任务。

您可以使用以下两种技术来编写可能需要调度极大量任务的工作流：

使用 continue-as-new API：
每个工作流 SDK 都公开了一个 continue-as-new API，工作流可以调用该 API 以使用新的输入和历史记录重新启动自己。continue-as-new API 特别适合实现“永恒工作流”，如监控代理，否则将使用 while (true) 类构造实现。使用 continue-as-new 是保持工作流历史记录小的好方法。

工作流模式

Mon, 01 Jan 0001 00:00:00 +0000

Dapr 工作流简化了微服务架构中复杂且有状态的协调需求。以下部分描述了几种可以从 Dapr 工作流中受益的应用程序模式。

任务链

在任务链模式中，工作流中的多个步骤按顺序运行，一个步骤的输出可以作为下一个步骤的输入。任务链工作流通常涉及创建一系列需要对某些数据执行的操作，例如过滤、转换和归约。

在某些情况下，工作流的步骤可能需要在多个微服务之间进行协调。为了提高可靠性和可扩展性，您还可能使用队列来触发各个步骤。

虽然模式简单，但实现中隐藏了许多复杂性。例如：

如果某个微服务长时间不可用，会发生什么？
可以自动重试失败的步骤吗？
如果不能，如何促进先前完成步骤的回滚（如果适用）？
除了实现细节之外，是否有办法可视化工作流，以便其他工程师可以理解它的作用和工作原理？

Dapr 工作流通过允许您在所选编程语言中将任务链模式简洁地实现为简单函数来解决这些复杂性，如以下示例所示。

import dapr.ext.workflow as wf


def task_chain_workflow(ctx: wf.DaprWorkflowContext, wf_input: int):
 try:
 result1 = yield ctx.call_activity(step1, input=wf_input)
 result2 = yield ctx.call_activity(step2, input=result1)
 result3 = yield ctx.call_activity(step3, input=result2)
 except Exception as e:
 yield ctx.call_activity(error_handler, input=str(e))
 raise
 return [result1, result2, result3]


def step1(ctx, activity_input):
 print(f'步骤 1: 接收到输入: {activity_input}.')
 # 执行一些操作
 return activity_input + 1


def step2(ctx, activity_input):
 print(f'步骤 2: 接收到输入: {activity_input}.')
 # 执行一些操作
 return activity_input * 2


def step3(ctx, activity_input):
 print(f'步骤 3: 接收到输入: {activity_input}.')
 # 执行一些操作
 return activity_input ^ 2


def error_handler(ctx, error):
 print(f'执行错误处理程序: {error}.')
 # 执行一些补偿操作

注意工作流重试策略将在 Python SDK 的未来版本中提供。

工作流架构

Mon, 01 Jan 0001 00:00:00 +0000

Dapr 工作流允许开发者使用多种编程语言的普通代码定义工作流。工作流引擎运行在 Dapr sidecar 内部，并协调作为应用程序一部分部署的工作流代码。本文描述了：

Dapr 工作流引擎的架构
工作流引擎如何与应用程序代码交互
工作流引擎如何融入整体 Dapr 架构
不同的工作流后端如何与工作流引擎协作

有关如何在应用程序中编写 Dapr 工作流的更多信息，请参见如何：编写工作流。

Dapr 工作流引擎的内部支持来自于 Dapr 的 actor 运行时。下图展示了 Kubernetes 模式下的 Dapr 工作流架构：

要使用 Dapr 工作流构建块，您需要在应用程序中使用 Dapr 工作流 SDK 编写工作流代码，该 SDK 内部通过 gRPC 流连接到 sidecar。这会注册工作流和任何工作流活动，或工作流可以调度的任务。

引擎直接嵌入在 sidecar 中，并通过 durabletask-go 框架库实现。此框架允许您更换不同的存储提供者，包括为 Dapr 创建的存储提供者，该提供者在幕后利用内部 actor。由于 Dapr 工作流使用 actor，您可以将工作流状态存储在状态存储中。

Sidecar 交互

当工作流应用程序启动时，它使用工作流编写 SDK 向 Dapr sidecar 发送 gRPC 请求，并根据服务器流式 RPC 模式获取工作流工作项流。这些工作项可以是从“启动一个新的 X 工作流”（其中 X 是工作流的类型）到“调度活动 Y，输入 Z 以代表工作流 X 运行”的任何内容。

如何：编写一个工作流

Mon, 01 Jan 0001 00:00:00 +0000

本文提供了如何编写由Dapr工作流引擎执行的工作流的高级概述。

注意

如果您还没有尝试过，请尝试工作流快速入门，以快速了解如何使用工作流。

以代码形式编写工作流

Dapr工作流逻辑是通过通用编程语言实现的，这使您可以：

使用您喜欢的编程语言（无需学习新的DSL或YAML模式）。
访问语言的标准库。
构建您自己的库和抽象。
使用调试器并检查本地变量。
为您的工作流编写单元测试，就像应用程序逻辑的其他部分一样。

Dapr sidecar不加载任何工作流定义。相反，sidecar仅负责驱动工作流的执行，而所有具体的工作流任务则由应用程序的一部分来处理。

编写工作流任务

工作流任务是工作流中的基本工作单元，是在业务流程中被编排的任务。

定义您希望工作流执行的工作流任务。任务是一个函数定义，可以接受输入并返回输出。以下示例创建了一个名为hello_act的任务，用于打印当前计数器的值。hello_act是一个从WorkflowActivityContext类派生的函数。

def hello_act(ctx: WorkflowActivityContext, input):
 global counter
 counter += input
 print(f'New counter value is: {counter}!', flush=True)

查看上下文中的hello_act工作流任务。

定义您希望工作流执行的工作流任务。任务被封装在实现工作流任务的WorkflowActivityContext类中。

如何：管理工作流

Mon, 01 Jan 0001 00:00:00 +0000

现在您已经在应用程序中编写了工作流及其活动，您可以使用HTTP API调用来启动、终止和获取工作流的信息。有关更多信息，请阅读工作流API参考。

在代码中管理您的工作流。在编写工作流指南中的工作流示例中，工作流通过以下API在代码中注册：

start_workflow: 启动工作流的一个实例
get_workflow: 获取工作流状态的信息
pause_workflow: 暂停或挂起一个工作流实例，稍后可以恢复
resume_workflow: 恢复一个暂停的工作流实例
raise_workflow_event: 在工作流上触发一个事件
purge_workflow: 删除与特定工作流实例相关的所有元数据
terminate_workflow: 终止或停止特定的工作流实例

from dapr.ext.workflow import WorkflowRuntime, DaprWorkflowContext, WorkflowActivityContext
from dapr.clients import DaprClient

# 合适的参数
instanceId = "exampleInstanceID"
workflowComponent = "dapr"
workflowName = "hello_world_wf"
eventName = "event1"
eventData = "eventData"

# 启动工作流
start_resp = d.start_workflow(instance_id=instanceId, workflow_component=workflowComponent,
 workflow_name=workflowName, input=inputData, workflow_options=workflowOptions)

# 获取工作流信息
getResponse = d.get_workflow(instance_id=instanceId, workflow_component=workflowComponent)

# 暂停工作流
d.pause_workflow(instance_id=instanceId, workflow_component=workflowComponent)

# 恢复工作流
d.resume_workflow(instance_id=instanceId, workflow_component=workflowComponent)

# 在工作流上触发一个事件
d.raise_workflow_event(instance_id=instanceId, workflow_component=workflowComponent,
 event_name=eventName, event_data=eventData)

# 清除工作流
d.purge_workflow(instance_id=instanceId, workflow_component=workflowComponent)

# 终止工作流
d.terminate_workflow(instance_id=instanceId, workflow_component=workflowComponent)

在代码中管理您的工作流。在编写工作流指南中的工作流示例中，工作流通过以下API在代码中注册：