Durable Functions 中的永久业务流程 (Azure Functions)

项目
06/02/2023

永久业务流程是永远不会结束的业务流程协调程序函数。当希望将 Durable Functions 用于聚合器和需要无限循环的任何方案时，永久业务流程非常有用。

业务流程历史记录

如业务流程历史记录主题中所述，Durable Task Framework 会跟踪每个函数业务流程的历史记录。只要业务流程协调程序函数继续计划新工作，此历史记录就会不断增长。如果业务流程协调程序函数进入无限循环并持续计划工作，则此历史记录可能会变得非常大并导致明显的性能问题。 永久业务流程概念是为了减轻需要无限循环的应用程序的此类问题而设计的。

重置和重启

业务流程协调程序函数不使用无限循环，而是通过调用业务流程触发器绑定的 continue-as-new 方法来重置其状态。此方法采用 JSON 可序列化参数，该参数将成为用于生成下一个业务流程协调程序函数的新输入。

调用 continue-as-new 时，业务流程实例会使用新的输入值重启自身。将保持同一实例 ID，但业务流程协调程序函数的历史记录会被重置。

注意

Durable Task Framework 会维护同一个实例 ID，但在内部会为由 continue-as-new 重置的业务流程协调程序函数创建一个新的执行 ID。此执行 ID 不对外公开，但在调试业务流程执行时知道该 ID 可能比较有用。

定期工作示例

永久业务流程的一个用例是需要无限期执行定期工作的代码。

[FunctionName("Periodic_Cleanup_Loop")]
public static async Task Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    await context.CallActivityAsync("DoCleanup", null);

    // sleep for one hour between cleanups
    DateTime nextCleanup = context.CurrentUtcDateTime.AddHours(1);
    await context.CreateTimer(nextCleanup, CancellationToken.None);

    context.ContinueAsNew(null);
}

注意

前面的 C# 示例适用于 Durable Functions 2.x。对于 Durable Functions 1.x，必须使用 DurableOrchestrationContext 而不是 IDurableOrchestrationContext。有关版本之间差异的详细信息，请参阅 Durable Functions 版本一文。

const df = require("durable-functions");
const moment = require("moment");

module.exports = df.orchestrator(function*(context) {
    yield context.df.callActivity("DoCleanup");

    // sleep for one hour between cleanups
    const nextCleanup = moment.utc(context.df.currentUtcDateTime).add(1, "h");
    yield context.df.createTimer(nextCleanup.toDate());

    yield context.df.continueAsNew(undefined);
});

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    yield context.call_activity("DoCleanup")

    # sleep for one hour between cleanups
    next_cleanup = context.current_utc_datetime + timedelta(hours = 1)
    yield context.create_timer(next_cleanup)

    context.continue_as_new(None)

main = df.Orchestrator.create(orchestrator_function)

@FunctionName("Periodic_Cleanup_Loop")
public String periodicCleanupLoop(
    @DurableOrchestrationTrigger(name = "runtimeState") String runtimeState) {
        return OrchestrationRunner.loadAndRun(runtimeState, ctx -> {
            ctx.callActivity("DoCleanup").await();

            ctx.createTimer(Duration.ofHours(1)).await();

            ctx.continueAsNew(null);
        });
}

此示例与计时器触发的函数之间的区别是此处的清理触发时间不基于计划。例如，每小时执行某个函数的 CRON 计划将在 1:00、2:00 和 3:00 等时间执行，并且可能会遇到重叠问题。不过，在此示例中，如果清理花费 30 分钟，则它将计划在 1:00、2:30、4:00 等时间执行，因此不可能重叠。

启动永久业务流程

使用 start-new 或 schedule-new 持久客户端方法启动永久业务流程，就像使用任何其他业务流程函数一样。

注意

如果需要确保单一永久业务流程实例正在运行，则在启动业务流程时维护相同的实例 id 非常重要。有关详细信息，请参阅实例管理。

[FunctionName("Trigger_Eternal_Orchestration")]
public static async Task<HttpResponseMessage> OrchestrationTrigger(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequestMessage request,
    [DurableClient] IDurableOrchestrationClient client)
{
    string instanceId = "StaticId";

    await client.StartNewAsync("Periodic_Cleanup_Loop", instanceId); 
    return client.CreateCheckStatusResponse(request, instanceId);
}

注意

前面的代码适用于 Durable Functions 2.x。对于 Durable Functions 1.x，必须使用 OrchestrationClient 属性而不是 DurableClient 属性，并且必须使用 DurableOrchestrationClient 参数类型而不是 IDurableOrchestrationClient。有关版本之间差异的详细信息，请参阅 Durable Functions 版本一文。

const df = require("durable-functions");

module.exports = async function (context, req) {
    const client = df.getClient(context);
    const instanceId = "StaticId";
    
    // null is used as the input, since there is no input in "Periodic_Cleanup_Loop".
    await client.startNew("Periodic_Cleanup_Loop", instanceId, null);

    context.log(`Started orchestration with ID = '${instanceId}'.`);
    return client.createCheckStatusResponse(context.bindingData.req, instanceId);
};

async def main(req: func.HttpRequest, starter: str) -> func.HttpResponse:
    client = df.DurableOrchestrationClient(starter)
    instance_id = 'StaticId'

    await client.start_new('Periodic_Cleanup_Loop', instance_id, None)

    logging.info(f"Started orchestration with ID = '{instance_id}'.")
    return client.create_check_status_response(req, instance_id)

@FunctionName("Trigger_Eternal_Orchestration")
public HttpResponseMessage triggerEternalOrchestration(
        @HttpTrigger(name = "req") HttpRequestMessage<?> req,
        @DurableClientInput(name = "durableContext") DurableClientContext durableContext) {

    String instanceID = "StaticID";
    DurableTaskClient client = durableContext.getClient();
    client.scheduleNewOrchestrationInstance("Periodic_Cleanup_Loop", null, instanceID);
    return durableContext.createCheckStatusResponse(req, instanceID);
}

从永久业务流程退出

如果业务流程协调程序函数需要最终完成，则你需要做的全部工作“不是”调用 ContinueAsNew 而是让函数退出。

如果业务流程协调程序函数处于无限循环中并且需要停止运行，请使用业务流程客户端绑定的终止 API 方法来停止它。有关详细信息，请参阅实例管理。

后续步骤

了解如何实现单一实例业务流程