Durable Functions 中的函数链 - Hello 序列示例

项目
08/06/2024

函数链是指以特定顺序执行一系列函数的模式。通常需要将一个函数的输出应用于另一函数的输入。本文介绍在完成 Durable Functions 快速入门（C#、JavaScript、TypeScript、Python、PowerShell 或 Java）时创建的链接序列。有关 Durable Functions 的详细信息，请参阅 Durable Functions 概述。

先决条件

注意

适用于 Azure Functions 的 Node.js 编程模型版本 4 处于预览阶段。新版 v4 模型旨在为 JavaScript 和 TypeScript 开发人员提供更为灵活和直观的体验。在升级指南中详细了解 v3 和 v4 之间的差异。

在以下代码片段中，JavaScript (PM4) 表示编程模型 V4，即新体验。

函数

本文介绍示例应用中的以下函数：

E1_HelloSequence：在一个序列中多次调用 E1_SayHello 的一个业务流程协调程序函数。它存储来自 E1_SayHello 调用的输出并记录结果。
E1_SayHello：在字符串前添加“Hello”的一个活动函数。
HttpStart：HTTP 触发的持久客户端函数，用于启动业务流程协调程序的实例。

E1_HelloSequence 业务流程协调程序函数

        [FunctionName("E1_HelloSequence")]
        public static async Task<List<string>> Run(
            [OrchestrationTrigger] IDurableOrchestrationContext context)
        {
            var outputs = new List<string>();

            outputs.Add(await context.CallActivityAsync<string>("E1_SayHello", "Tokyo"));
            outputs.Add(await context.CallActivityAsync<string>("E1_SayHello", "Seattle"));
            outputs.Add(await context.CallActivityAsync<string>("E1_SayHello_DirectInput", "London"));

            // returns ["Hello Tokyo!", "Hello Seattle!", "Hello London!"]
            return outputs;
        }

所有 C# orchestration 函数都必须具有 DurableOrchestrationContext 类型的参数，此参数存在于 Microsoft.Azure.WebJobs.Extensions.DurableTask 程序集中。借助此上下文对象，可使用其 CallActivityAsync 方法调用其他活动函数并传递输入参数。

代码将在具有不同参数值的序列中调用三次 E1_SayHello。每个调用的返回值都会添加到 outputs 列表，函数末尾会返回该列表。

function.json

如果使用 Visual Studio Code 或 Azure 门户进行开发，则此处为用于业务流程协调程序函数的 function.json 文件的内容。大多数 orchestrator function.json 文件的内容都与以下内容相似。

{
  "bindings": [
    {
      "name": "context",
      "type": "orchestrationTrigger",
      "direction": "in"
    }
  ],
  "disabled": false
}

orchestrationTrigger 绑定类型非常重要。所有 orchestrator 函数都必须使用此触发器类型。

警告

为遵守 orchestrator 函数的“无 I/O”规则，在使用 orchestrationTrigger 触发器绑定时不要使用任何输入或输出绑定。如果需要其他输入或输出绑定，则应改为在业务流程协调程序调用的 activityTrigger 函数的上下文中使用。有关详细信息，请参阅业务流程协调程序函数代码约束一文。

index.js

下面是业务流程协调程序函数：

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

module.exports = df.orchestrator(function* (context) {
    context.log("Starting chain sample");
    const output = [];
    output.push(yield context.df.callActivity("E1_SayHello", "Tokyo"));
    output.push(yield context.df.callActivity("E1_SayHello", "Seattle"));
    output.push(yield context.df.callActivity("E1_SayHello", "London"));

    return output;
});

所有 JavaScript 业务流程函数都必须包括 durable-functions 模块。它是一个库，可用于以 JavaScript 编写 Durable Functions。业务流程协调程序函数与其他 JavaScript 函数之间有三个明显差异：

业务流程协调程序函数是一个生成器函数。
此函数包装在对 durable-functions 模块的 orchestrator 方法的调用（此处为 df）中。
此函数必须是同步的。由于使用“orchestrator”方法处理“context.done”的最终调用，因此此函数应该只是“return”。

context 对象包含一个 df 持久业务流程上下文对象，可使用其 callActivity 方法调用其他活动函数并传递输入参数。该代码按顺序采用不同的参数值三次调用 E1_SayHello，使用 yield 指示执行应当等待异步活动函数调用返回。每个调用的返回值都会添加到 outputs 数组，函数末尾会返回该列表。

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

const helloActivityName = "sayHello";

df.app.orchestration("helloSequence", function* (context) {
    context.log("Starting chain sample");

    const output = [];
    output.push(yield context.df.callActivity(helloActivityName, "Tokyo"));
    output.push(yield context.df.callActivity(helloActivityName, "Seattle"));
    output.push(yield context.df.callActivity(helloActivityName, "Cairo"));

    return output;
});

所有 JavaScript 业务流程函数都必须包括 durable-functions 模块。此模块可用于以 JavaScript 编写 Durable Functions。若要使用 V4 节点编程模型，需要安装 durable-functions 版的 v3.x 预览版。

业务流程协调程序函数与其他 JavaScript 函数之间有两个明显差异：

业务流程协调程序函数是一个生成器函数。
此函数必须是同步的。函数应仅“返回”。

context 对象包含一个 df 持久业务流程上下文对象，可使用其 callActivity 方法调用其他活动函数并传递输入参数。该代码按顺序采用不同的参数值三次调用 sayHello，使用 yield 指示执行应当等待异步活动函数调用返回。每个调用的返回值都会添加到 outputs 数组，函数末尾会返回该列表。

注意

Python Durable Functions 仅适用于 Functions 3.0 运行时。

function.json

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "context",
      "type": "orchestrationTrigger",
      "direction": "in"
    }
  ]
}

orchestrationTrigger 绑定类型非常重要。所有 orchestrator 函数都必须使用此触发器类型。

警告

init.py

下面是业务流程协调程序函数：

import azure.functions as func
import azure.durable_functions as df


def orchestrator_function(context: df.DurableOrchestrationContext):
    result1 = yield context.call_activity('E1_SayHello', "Tokyo")
    result2 = yield context.call_activity('E1_SayHello', "Seattle")
    result3 = yield context.call_activity('E1_SayHello', "London")
    return [result1, result2, result3]

main = df.Orchestrator.create(orchestrator_function)

所有 Python 业务流程函数都必须包括durable-functions模块。这是可用于以 Python 编写 Durable Functions 的库。业务流程协调程序函数与其他 Python 函数之间有两个明显差异：

业务流程协调程序函数是一个生成器函数。
文件应通过 main = df.Orchestrator.create(<orchestrator function name>) 在文件的末尾指出，将业务流程协调程序函数注册为业务流程协调程序。这有助于将它与在文件中声明的其他帮助器函数区分开来。

借助 context 对象，可使用其 call_activity 方法调用其他活动函数并传递输入参数。该代码按顺序采用不同的参数值三次调用 E1_SayHello，使用 yield 指示执行应当等待异步活动函数调用返回。每个调用的返回值都会在函数末尾返回。

E1_SayHello 活动函数

        [FunctionName("E1_SayHello")]
        public static string SayHello([ActivityTrigger] IDurableActivityContext context)
        {
            string name = context.GetInput<string>();
            return $"Hello {name}!";
        }

活动使用了 ActivityTrigger 属性。使用提供的 IDurableActivityContext 执行活动相关操作，例如，使用 GetInput<T> 访问输入值。

E1_SayHello 的实现是一种相对简单的字符串格式设置操作。

可以直接绑定到传递给活动函数的类型，而非绑定到 IDurableActivityContext。例如：

        [FunctionName("E1_SayHello_DirectInput")]
        public static string SayHelloDirectInput([ActivityTrigger] string name)
        {
            return $"Hello {name}!";
        }

E1_SayHello/function.json

活动函数 E1_SayHello 的 function.json 文件类似于 E1_HelloSequence 的 function.json 文件，只不过前者使用 activityTrigger 绑定类型而非 orchestrationTrigger 绑定类型。

{
  "bindings": [
    {
      "name": "name",
      "type": "activityTrigger",
      "direction": "in"
    }
  ],
  "disabled": false
}

注意

业务流程函数调用的所有活动函数都必须使用 activityTrigger 绑定。

E1_SayHello 的实现是一种相对简单的字符串格式设置操作。

E1_SayHello/index.js

module.exports = function (context) {
    context.done(null, `Hello ${context.bindings.name}!`);
};

与业务流程函数不同，活动函数不需要特殊设置。业务流程协调程序函数传递给它的输入位于 context.bindings 对象上，在 activityTrigger 绑定的名称下，在本例中为 context.bindings.name。绑定名称可以设置为导出函数的参数并且可以直接访问，这是示例代码所做的事情。

sayHello 的实现是一种相对简单的字符串格式设置操作。

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

const helloActivityName = "sayHello";

df.app.activity(helloActivityName, {
    handler: function (input) {
        return `Hello ${input}`;
    },
});

与业务流程函数不同，活动函数不需要特殊设置。业务流程协调程序函数传递给它的输入是该函数的第一个参数。第二个参数是调用上下文，在此示例中未使用。

E1_SayHello/function.json

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "name",
      "type": "activityTrigger",
      "direction": "in"
    }
  ]
}

注意

业务流程函数调用的所有活动函数都必须使用 activityTrigger 绑定。

E1_SayHello 的实现是一种相对简单的字符串格式设置操作。

E1_SayHello/init.py

def main(name: str) -> str:
    return f"Hello {name}!"

与业务流程协调程序函数不同，活动函数不需要特殊设置。业务流程协调程序函数传递给它的输入可直接作为函数的参数进行访问。

HttpStart 客户端函数

可以使用客户端函数启动业务流程协调程序函数的实例。你将使用 HTTP 触发的函数 HttpStart 启动 E1_HelloSequence 的实例。

    public static class HttpStart
    {
        [FunctionName("HttpStart")]
        public static async Task<HttpResponseMessage> Run(
            [HttpTrigger(AuthorizationLevel.Function, methods: "post", Route = "orchestrators/{functionName}")] HttpRequestMessage req,
            [DurableClient] IDurableClient starter,
            string functionName,
            ILogger log)
        {
            // Function input comes from the request content.
            object eventData = await req.Content.ReadAsAsync<object>();
            string instanceId = await starter.StartNewAsync(functionName, eventData);

            log.LogInformation($"Started orchestration with ID = '{instanceId}'.");

            return starter.CreateCheckStatusResponse(req, instanceId);
        }
    }

若要与业务流程协调程序进行交互，函数必须包含 DurableClient 输入绑定。你使用客户端来启动业务流程。它还可以帮助你返回 HTTP 响应，并在其中包含用于检查新业务流程状态的 URL。

HttpStart/function.json

{
    "bindings": [
      {
        "authLevel": "anonymous",
        "name": "req",
        "type": "httpTrigger",
        "direction": "in",
        "route": "orchestrators/{functionName}",
        "methods": ["post"]
      },
      {
        "name": "$return",
        "type": "http",
        "direction": "out"
      },
      {
        "name": "starter",
        "type": "orchestrationClient",
        "direction": "in"
      }
    ],
    "disabled": false
  }

若要与业务流程协调程序进行交互，函数必须包含 durableClient 输入绑定。

HttpStart/index.js

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

module.exports = async function (context, req) {
    const client = df.getClient(context);
    const instanceId = await client.startNew(req.params.functionName, undefined, req.body);

    context.log(`Started orchestration with ID = '${instanceId}'.`);

    return client.createCheckStatusResponse(context.bindingData.req, instanceId);
};

使用 df.getClient 获取 DurableOrchestrationClient 对象。你使用客户端来启动业务流程。它还可以帮助你返回 HTTP 响应，并在其中包含用于检查新业务流程状态的 URL。

const df = require("durable-functions");
const { app } = require("@azure/functions");

app.http("httpStart", {
    route: "orchestrators/{orchestratorName}",
    extraInputs: [df.input.durableClient()],
    handler: async (request, context) => {
        const client = df.getClient(context);
        const body = await request.json();
        const instanceId = await client.startNew(request.params.orchestratorName, { input: body });

        context.log(`Started orchestration with ID = '${instanceId}'.`);

        return client.createCheckStatusResponse(request, instanceId);
    },
});

若要管理业务流程协调程序并与之交互，函数必须包含 durableClient 输入绑定。注册函数时，需要在 extraInputs 参数中指定此绑定。可以通过调用 df.input.durableClient() 获取 durableClient 输入。

使用 df.getClient 获取 DurableClient 对象。你使用客户端来启动业务流程。它还可以帮助你返回 HTTP 响应，并在其中包含用于检查新业务流程状态的 URL。

HttpStart/function.json

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "route": "orchestrators/{functionName}",
      "methods": [
        "post",
        "get"
      ]
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "name": "starter",
      "type": "durableClient",
      "direction": "in"
    }
  ]
}

若要与业务流程协调程序进行交互，函数必须包含 durableClient 输入绑定。

HttpStart/init.py

import logging

import azure.functions as func
import azure.durable_functions as df


async def main(req: func.HttpRequest, starter: str) -> func.HttpResponse:
    client = df.DurableOrchestrationClient(starter)
    instance_id = await client.start_new(req.route_params["functionName"], None, None)

    logging.info(f"Started orchestration with ID = '{instance_id}'.")

    return client.create_check_status_response(req, instance_id)

使用 DurableOrchestrationClient 构造函数获取 Durable Functions 客户端。你使用客户端来启动业务流程。它还可以帮助你返回 HTTP 响应，并在其中包含用于检查新业务流程状态的 URL。

运行示例

若要执行 E1_HelloSequence 业务流程，请将以下 HTTP POST 请求发送到 HttpStart 函数。

POST http://{host}/orchestrators/E1_HelloSequence

注意

前面的 HTTP 代码片段假定 host.json 文件中有一个条目，该条目从所有 HTTP 触发器函数 URL 中删除默认的 api/ 前缀。可以在示例的 host.json 文件中找到此配置的标记。

例如，如果在名为“myfunctionapp”的函数应用中运行示例，请将“{host}”替换为“myfunctionapp.chinacloudsites.cn”。

结果为 HTTP 202 响应，如下所示（已简化）：

HTTP/1.1 202 Accepted
Content-Length: 719
Content-Type: application/json; charset=utf-8
Location: http://{host}/runtime/webhooks/durabletask/instances/96924899c16d43b08a536de376ac786b?taskHub=DurableFunctionsHub&connection=Storage&code={systemKey}

(...trimmed...)

此时，业务流程已进行排队，并将立即开始运行。 Location 标头中的 URL可用于检查执行的状态。

GET http://{host}/runtime/webhooks/durabletask/instances/96924899c16d43b08a536de376ac786b?taskHub=DurableFunctionsHub&connection=Storage&code={systemKey}

结果为业务流程的状态。它运行和完成的速度很快，因此处于已完成状态，并伴有如下所示响应（已简化）：

HTTP/1.1 200 OK
Content-Length: 179
Content-Type: application/json; charset=utf-8

{"runtimeStatus":"Completed","input":null,"output":["Hello Tokyo!","Hello Seattle!","Hello London!"],"createdTime":"2017-06-29T05:24:57Z","lastUpdatedTime":"2017-06-29T05:24:59Z"}

可以看到，实例的 runtimeStatus 为已完成，且 output 包含 orchestrator 函数执行的 JSON 序列化结果。

注意

可对其他触发器类型（如 queueTrigger、eventHubTrigger 或 timerTrigger）实施类似的启动器逻辑。

查看函数执行日志。由于业务流程可靠性主题中所述的重播行为，E1_HelloSequence 函数已多次启动和完成。另一方面，由于未重播这些函数执行，因此只执行三次 E1_SayHello。

后续步骤

此示例演示了简单的函数链业务流程。下一示例演示如何实现扇出/扇入模式。

运行扇出/扇入示例

通过

Durable Functions 中的函数链 - Hello 序列示例

先决条件

函数

E1_HelloSequence 业务流程协调程序函数

E1_SayHello 活动函数

HttpStart 客户端函数

运行示例

后续步骤

其他资源