Durable Functions 是 Azure Functions 的一个扩展,用于构建有状态应用。 可以使用业务流程协调程序函数来协调函数应用中其他持久函数的执行。 业务流程协调程序函数带有状态且可靠,可以长时间运行。
业务流程协调程序代码约束
业务流程协调程序函数使用 事件源 来确保可靠执行并保持本地变量状态。 业务流程协调程序代码的重播行为针对可在业务流程协调程序函数中编写的代码类型创建约束。 例如,业务流程协调程序函数必须具有确定性:业务流程协调程序函数将重播多次,每次必须生成相同的结果。
使用确定性 API
本部分提供一些简单的指导原则,用于帮助确保代码是确定性的。
业务流程协调程序函数可以采用目标语言调用任何 API。 但是,必须确保业务流程协调程序函数只调用确定性 API。 确定性 API 是一种在输入相同时始终返回同一值的 API,不管何时调用,也不管调用频率如何。
下表显示了应该避免使用的 API 的一些示例,因为它们不是确定性的。 这些限制仅适用于业务流程协调程序函数。 其他函数类型没有此类限制。
| API 类别 | Reason | 解决方法 |
|---|---|---|
| 日期和时间 | 返回当前日期或时间的 API 是非确定性的,因为每次重播时它们返回的值都不相同。 | 使用 .NET 中的 CurrentUtcDateTime 属性、 currentUtcDateTime JavaScript 中的 api 或 current_utc_datetime Python 中可安全重播的 api。 |
| GUID 和 UUID | 返回随机 GUID 或 UUID 的 API 是非确定性的,因为每次重播时它们生成的值都不相同。 | 使用 .NET 或 JavaScript 中的 NewGuid newGuid 安全地生成随机 guid。 |
| 随机数 | 返回随机数的 API 是非确定性的,因为每次重播时它们生成的值都不相同。 | 使用活动函数将随机数返回给业务流程。 就重播来说,活动函数的返回值始终是安全的。 |
| 绑定 | 输入和输出绑定通常会执行 I/O 操作,是非确定性的。 即使是业务流程客户端和实体客户端绑定,也不得由业务流程协调程序函数直接使用。 | 在客户端或活动函数中使用输入和输出绑定。 |
| 网络 | 网络调用涉及外部系统,是非确定性的。 | 使用活动函数进行网络调用。 如果需要从业务流程协调程序函数进行 HTTP 调用,则也可使用持久性 HTTP API。 |
| 阻止 API | 阻止 .NET 中的 Thread.Sleep 等 API 和类似的 API 可能导致业务流程协调程序函数出现性能和缩放问题,应该避免使用。 在 Azure Functions 消耗计划中,它们甚至可能导致不必要的运行时收费。 |
在适用的情况下使用阻止 API 的替代方案。 例如,使用 CreateTimer 在业务流程执行中引入延迟。 持久计时器延迟不计入业务流程协调程序函数的执行时间。 |
| 异步 API | 除了 IDurableOrchestrationContext 在 Python 中使用 api、 context.df JavaScript 中的 api 或 api 以外,Orchestrator 代码决不能启动任何异步操作 context 。 例如,在 .NET 中不能使用 Task.Run、Task.Delay 和 HttpClient.SendAsync,在 JavaScript 中不能使用 setTimeout 和 setInterval。 Durable Task Framework 在单个线程上执行业务流程协调程序代码。 它不能与可由其他异步 API 调用的其他任何线程交互。 |
业务流程协调程序函数只应进行持久性异步调用。 应该由活动函数进行任何其他异步 API 调用。 |
| 异步 JavaScript 函数 | 不能将 JavaScript 业务流程协调程序函数声明为 async,因为 node.js 运行时不保证异步函数是确定性的。 |
将 JavaScript orchestrator 函数声明为同步生成器函数 |
| Python 协同程序 | 不能将 Python orchestrator 函数声明为协同程序,即 用关键字声明它们 async ,因为协同程序语义与 Durable Functions 重播模型不符。 |
将 Python orchestrator 函数声明为生成器,这意味着您应该会 context 使用 API yield 而不是 await 。 |
| 线程 API | Durable Task Framework 在单个线程上运行业务流程协调程序代码,不能与任何其他线程交互。 将新线程引入业务流程的执行中可能导致非确定性执行或死锁。 | 在绝大多数情况下,业务流程协调程序函数不应使用线程 API。 例如,在 .NET 中,应避免使用 ConfigureAwait(continueOnCapturedContext: false) ; 这可确保在业务流程协调程序函数的原始上运行任务延续 SynchronizationContext 。 如果需要使用此类 API,请将其使用限制为活动函数。 |
| 静态变量 | 避免在业务流程协调程序函数中使用非常量静态变量,因为其值可能随时间而变,导致非确定性的运行时行为。 | 使用常量,或者将静态变量的使用限制为活动函数。 |
| 环境变量 | 请勿在业务流程协调程序函数中使用环境变量。 其值可能随时间而变,导致非确定性的运行时行为。 | 环境变量只能在客户端函数或活动函数内部引用。 |
| 无限循环 | 请避免在业务流程协调程序函数中出现无限循环。 由于 Durable Task Framework 在业务流程函数的执行过程中会保存执行历史记录,无限循环可能会导致业务流程协调程序实例耗尽内存。 | 对于无限循环方案,请使用如 ContinueAsNew .net、 continueAsNew JavaScript 或 continue_as_new Python 中的 api 来重新启动函数执行,并放弃以前的执行历史记录。 |
尽管这些约束看起来很难应用,但其实并不难遵守。
Durable Task Framework 会尝试检测上述规则的违规。 如果发现违规,该框架将引发 NonDeterministicOrchestrationException 异常。 但是,此检测行为不会捕获所有违规,因此请不要对它有依赖。
版本控制
持久性业务流程可能会连续运行数天、数月、数年,甚至会永久执行。 对 Durable Functions 应用进行代码更新时,如果此类更新影响尚未完成的业务流程,则可能会中断业务流程的重播行为。 因此,在更新代码时请仔细进行计划,这很重要。 有关如何进行代码版本控制的更详细说明,请参阅版本控制一文。
持久任务
Note: 本部分介绍 Durable Task Framework 的内部实现详细信息。 在不了解这些信息的情况下也可以使用 Durable Functions。 本部分旨在帮助读者了解重播行为。
可在业务流程协调程序函数中安全等待的任务有时称为“持久任务”。 这些任务由 Durable Task Framework 创建和管理。 示例包括 .NET 业务流程协调程序函数中的 CallActivityAsync、WaitForExternalEvent 和 CreateTimer 返回的任务。
可以在 .NET 中使用 TaskCompletionSource 对象的列表对这些持久任务进行内部管理。 在重播期间,这些任务在业务流程协调程序代码执行过程中予以创建。 在调度程序枚举相应历史记录事件时,这些任务将会完成。
这些任务通过单个线程以同步方式执行,直至重播完所有历史记录。 在历史记录重播结束时未完成的持久任务会执行相应的操作。例如,消息可能会排队以调用活动函数。
本部分的运行时行为说明应可帮助你理解业务流程协调程序函数为何不能在非持久任务中使用 await 或 yield。 有两个原因:调度程序线程无法等待该任务完成,并且该任务发出的任何回调可能会损坏业务流程协调程序函数的跟踪状态。 进行某些运行时检查是为了帮助检测此类违规。
若要详细了解 Durable Task Framework 如何执行业务流程协调程序函数,请查阅 GitHub 上的持久任务源代码。 具体而言,请参阅 TaskOrchestrationExecutor.cs 和 TaskOrchestrationContext.cs。
后续步骤
历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 cgillum)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。
