Függvényláncolás a Durable Functionsben – Hello sorozatminta

Cikk
07/27/2024

A függvényláncolás egy függvénysorozat adott sorrendben történő végrehajtásának mintáját jelenti. Gyakran az egyik függvény kimenetét egy másik függvény bemenetére kell alkalmazni. Ez a cikk a Durable Functions rövid útmutatójának (C#, JavaScript, TypeScript , Python, PowerShell vagy Java) elvégzésekor létrehozott láncolássorozatot ismerteti. A Durable Functionsről további információt a Durable Functions áttekintésében talál.

Előfeltételek

Feljegyzés

Az Azure Functions Node.js programozási modelljének 4- es verziója általánosan elérhető. Az új v4-modell úgy lett kialakítva, hogy rugalmasabb és intuitívabb felhasználói élményt nyújtson JavaScript- és TypeScript-fejlesztők számára. A migrálási útmutatóban további információt olvashat a v3 és a v4 közötti különbségekről.

A következő kódrészletekben a JavaScript (PM4) a V4 programozási modellt, az új felületet jelöli.

A függvények

Ez a cikk a mintaalkalmazás alábbi funkcióit ismerteti:

E1_HelloSequence: Egy vezénylő függvény , amely sorozatban többször hív meg E1_SayHello . Tárolja a hívások kimeneteit E1_SayHello , és rögzíti az eredményeket.
E1_SayHello: Olyan tevékenységfüggvény , amely egy "Hello" karakterláncot előszűrésként tartalmaz.
HttpStart: Http által aktivált tartós ügyfélfüggvény , amely elindítja a vezénylő egy példányát.

E1_HelloSequence vezénylő függvény

[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;
}

Minden C#-vezénylési függvénynek rendelkeznie kell egy olyan típusú DurableOrchestrationContextparaméterrel, amely a Microsoft.Azure.WebJobs.Extensions.DurableTask szerelvényben létezik. Ezzel a környezeti objektummal meghívhat más tevékenységfüggvényeket , és bemeneti paramétereket adhat át annak metódusával CallActivityAsync .

A kód egymás után háromszor hív E1_SayHello meg különböző paraméterértékeket. A rendszer hozzáadja az egyes hívások visszatérési értékét a outputs listához, amelyet a függvény végén ad vissza.

function.json

Ha a Visual Studio Code-ot vagy az Azure Portalt használja fejlesztésre, a vezénylési függvény function.json fájljának tartalma. A legtöbb vezénylő function.json fájl szinte pontosan így néz ki.

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

A fontos a orchestrationTrigger kötés típusa. Minden vezénylő függvénynek ezt az eseményindítótípust kell használnia.

Figyelmeztetés

A vezénylőfüggvények "nincs I/O" szabályának betartásához ne használjon bemeneti vagy kimeneti kötéseket az orchestrationTrigger eseményindító kötés használatakor. Ha más bemeneti vagy kimeneti kötésekre van szükség, a függvények kontextusában activityTrigger kell használni őket, amelyeket a vezénylő hív meg. További információkért tekintse meg a vezénylő függvénykód korlátozásait ismertető cikket.

index.js

A vezénylő függvény a következő:

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;
});

Minden JavaScript vezénylési függvénynek tartalmaznia kell a modultdurable-functions. Ez egy kódtár, amely lehetővé teszi a Durable Functions JavaScriptben való írását. A vezénylő függvény és az egyéb JavaScript-függvények között három jelentős különbség van:

A vezénylő függvény egy generátorfüggvény.
A függvény a modul orchestrator metódusának durable-functions hívásába van csomagolva (ittdf).
A függvénynek szinkronnak kell lennie. Mivel a "vezénylő" metódus kezeli a "context.done" végső hívását, a függvénynek egyszerűen "return" (visszatérés) kell lennie.

Az context objektum egy df tartós vezénylési környezeti objektumot tartalmaz, amely lehetővé teszi más tevékenységfüggvények meghívását és bemeneti paraméterek átadását annak metódusával callActivity . A kód egymás után háromszor hív E1_SayHello különböző paraméterértékekkel, és jelzi, yield hogy a végrehajtásnak várnia kell a visszaadni kívánt aszinkron tevékenységfüggvény-hívásokra. A rendszer hozzáadja az egyes hívások visszatérési értékét a outputs tömbhöz, amelyet a függvény végén ad vissza.

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;
});

Minden JavaScript vezénylési függvénynek tartalmaznia kell a modultdurable-functions. Ez a modul lehetővé teszi a Durable Functions JavaScriptben való írását. A V4-csomópont programozási modelljének használatához telepítenie kell a verzió előzetes v3.x verzióját durable-functions.

A vezénylő függvény és az egyéb JavaScript-függvények között két jelentős különbség van:

A vezénylő függvény egy generátorfüggvény.
A függvénynek szinkronnak kell lennie. A függvénynek egyszerűen "return" (visszatérés) kell lennie.

Az context objektum egy df tartós vezénylési környezeti objektumot tartalmaz, amely lehetővé teszi más tevékenységfüggvények meghívását és bemeneti paraméterek átadását annak metódusával callActivity . A kód egymás után háromszor hív sayHello különböző paraméterértékekkel, és jelzi, yield hogy a végrehajtásnak várnia kell a visszaadni kívánt aszinkron tevékenységfüggvény-hívásokra. A rendszer hozzáadja az egyes hívások visszatérési értékét a outputs tömbhöz, amelyet a függvény végén ad vissza.

Feljegyzés

A Python Durable Functions csak a Functions 3.0-s futtatókörnyezetekhez érhető el.

function.json

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

A fontos a orchestrationTrigger kötés típusa. Minden vezénylő függvénynek ezt az eseményindítótípust kell használnia.

Figyelmeztetés

init.py

A vezénylő függvény a következő:

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)

Minden Python vezénylési függvénynek tartalmaznia kell a durable-functions csomagot. Ez egy kódtár, amely lehetővé teszi a Durable Functions pythonban való írását. A vezénylő függvény és más Python-függvények között két jelentős különbség van:

A vezénylő függvény egy generátorfüggvény.
A fájlnak a fájl végén megadott main = df.Orchestrator.create(<orchestrator function name>) módon regisztrálnia kell a vezénylői funkciót vezénylőként. Ez segít megkülönböztetni a fájlban deklarált többi segédfüggvénytől.

Az context objektum lehetővé teszi más tevékenységfüggvények meghívását és bemeneti paraméterek átadását annak metódusával call_activity . A kód egymás után háromszor hív E1_SayHello különböző paraméterértékekkel, és jelzi, yield hogy a végrehajtásnak várnia kell a visszaadni kívánt aszinkron tevékenységfüggvény-hívásokra. Az egyes hívások visszatérési értéke a függvény végén lesz visszaadva.

E1_SayHello tevékenységfüggvény

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

A tevékenységek az attribútumot ActivityTrigger használják. A megadott IDurableActivityContext műveletekkel tevékenységgel kapcsolatos műveleteket hajthat végre, például a bemeneti értékhez való hozzáférést a használatával GetInput<T>.

A megvalósítás E1_SayHello egy viszonylag triviális sztringformázási művelet.

Ahelyett, hogy a tevékenységfüggvényhez kötést IDurableActivityContextvégez, közvetlenül a tevékenységfüggvénybe átadott típushoz köthet. Példa:

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

E1_SayHello/function.json

A tevékenységfüggvény E1_SayHello function.json fájlja E1_HelloSequence hasonló ahhoz, hogy kötéstípus helyett kötéstípust activityTrigger orchestrationTrigger használ.

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

Feljegyzés

A vezénylési függvény által hívott összes tevékenységfüggvénynek a kötést kell használnia activityTrigger .

A megvalósítás E1_SayHello egy viszonylag triviális sztringformázási művelet.

E1_SayHello/index.js

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

A vezénylési függvénnyel ellentétben a tevékenységfüggvénynek nincs szüksége speciális beállításra. A vezénylő függvény által neki átadott bemenet a context.bindings kötés neve alatt található az activityTrigger objektumon – ebben az esetben context.bindings.name. A kötés neve megadható az exportált függvény paramétereként, és közvetlenül is elérhető, ami a mintakód feladata.

A megvalósítás sayHello egy viszonylag triviális sztringformázási művelet.

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

const helloActivityName = "sayHello";

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

A vezénylési függvénnyel ellentétben a tevékenységfüggvénynek nincs szüksége speciális beállításra. A vezénylő függvény által neki átadott bemenet a függvény első argumentuma. A második argumentum a meghívási környezet, amelyet ebben a példában nem használunk.

E1_SayHello/function.json

A tevékenységfüggvény E1_SayHello function.json fájlja E1_HelloSequence hasonló ahhoz, hogy kötéstípus helyett kötéstípust activityTrigger orchestrationTrigger használ.

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

Feljegyzés

A vezénylési függvény által hívott összes tevékenységfüggvénynek a kötést kell használnia activityTrigger .

A megvalósítás E1_SayHello egy viszonylag triviális sztringformázási művelet.

E1_SayHello/init.py

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

A vezénylő függvénnyel ellentétben a tevékenységfüggvénynek nincs szüksége speciális beállításra. A vezénylő függvény által neki átadott bemenet közvetlenül elérhető a függvény paramétereként.

HttpStart ügyfélfüggvény

A vezénylő függvény egy példányát ügyfélfüggvény használatával indíthatja el. A HTTP által aktivált függvényt fogja használni a HttpStart példányok E1_HelloSequenceelindításához.

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);
    }
}

A vezénylőkkel való interakcióhoz a függvénynek tartalmaznia kell egy bemeneti kötést DurableClient . Vezénylés indításához használja az ügyfelet. Az új vezénylés állapotának ellenőrzéséhez az URL-eket tartalmazó HTTP-választ is visszaadhatja.

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
  }

A vezénylőkkel való interakcióhoz a függvénynek tartalmaznia kell egy bemeneti kötést 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);
};

Objektum lekérésére DurableOrchestrationClient használhatódf.getClient. Vezénylés indításához használja az ügyfelet. Az új vezénylés állapotának ellenőrzéséhez az URL-eket tartalmazó HTTP-választ is visszaadhatja.

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);
    },
});

A vezénylők kezeléséhez és kezeléséhez a függvénynek bemeneti kötésre durableClient van szüksége. Ezt a kötést meg kell adni az extraInputs argumentumban a függvény regisztrálásakor. A durableClient bemenet a hívással df.input.durableClient()kérhető le.

Objektum lekérésére DurableClient használhatódf.getClient. Vezénylés indításához használja az ügyfelet. Az új vezénylés állapotának ellenőrzéséhez az URL-eket tartalmazó HTTP-választ is visszaadhatja.

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"
    }
  ]
}

A vezénylőkkel való interakcióhoz a függvénynek tartalmaznia kell egy bemeneti kötést 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)

A konstruktor használatával DurableOrchestrationClient szerezze be a Durable Functions-ügyfelet. Vezénylés indításához használja az ügyfelet. Az új vezénylés állapotának ellenőrzéséhez az URL-eket tartalmazó HTTP-választ is visszaadhatja.

Minta futtatása

A E1_HelloSequence vezénylés végrehajtásához küldje el a következő HTTP POST-kérést a HttpStart függvénynek.

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

Feljegyzés

Az előző HTTP-kódrészlet feltételezi, hogy van egy bejegyzés a host.json fájlban, amely eltávolítja az alapértelmezett api/ előtagot az összes HTTP-eseményindító függvény URL-címéről. A konfiguráció jelölője a host.json mintákban található fájlban található.

Ha például egy "myfunctionapp" nevű függvényalkalmazásban futtatja a mintát, cserélje le a(z) "{host}" kifejezést a "myfunctionapp.azurewebsites.net" kifejezésre.

Az eredmény egy HTTP 202-válasz, mint ez (vágva a rövidítés):

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...)

Ezen a ponton a vezénylés várólistára kerül, és azonnal elindul. A fejléc url-címe Location a végrehajtás állapotának ellenőrzésére használható.

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

Az eredmény a vezénylés állapota. Gyorsan fut és fejeződik be, így a kész állapotban jelenik meg az alábbihoz hasonló válaszsal (a rövidítés kedvéért levágva):

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"}

Mint látható, a runtimeStatus példány befejeződött, és a output vezénylő függvény végrehajtásának JSON-szerializált eredményét tartalmazza.

Feljegyzés

Hasonló kezdő logikát implementálhat más triggertípusokhoz, például queueTrigger: , eventHubTriggervagy timerTrigger.

Tekintse meg a függvény végrehajtási naplóit. A E1_HelloSequence függvény többször is elindult és befejeződött a vezénylés megbízhatósági témakörében leírt visszajátszási viselkedés miatt. Másrészt csak három végrehajtás E1_SayHello volt, mivel ezek a függvényvégrehajtások nem kerülnek visszajátszásra.

Következő lépések

Ez a minta egy egyszerű függvénylánc-vezénylést mutatott be. A következő minta bemutatja, hogyan valósíthatja meg a ventilátor-out/ventilátor-in mintát.

Futtassa a ventilátor-out/ventilátor mintát

Megosztás a következőn keresztül:

Függvényláncolás a Durable Functionsben – Hello sorozatminta

Előfeltételek

A függvények

E1_HelloSequence vezénylő függvény

function.json

index.js

function.json

init.py

E1_SayHello tevékenységfüggvény

E1_SayHello/function.json

E1_SayHello/index.js

E1_SayHello/function.json

E1_SayHello/init.py

HttpStart ügyfélfüggvény

HttpStart/function.json

HttpStart/index.js

HttpStart/function.json

HttpStart/init.py

Minta futtatása

Következő lépések

Visszajelzés

További források