Dapr State kimeneti kötés az Azure Functionshez

  • Cikk

Fontos

Az Azure Functions Dapr-bővítménye jelenleg előzetes verzióban érhető el, és csak az Azure Container Apps-környezetekben támogatott.

A Dapr-állapot kimeneti kötése lehetővé teszi egy érték Dapr-állapotba mentését egy függvény végrehajtása során.

A Dapr-bővítmény beállítási és konfigurációs részleteiről a Dapr bővítmény áttekintésében olvashat.

Példa

A C#-függvények a következő C#-módok egyikével hozhatók létre:

Végrehajtási modell Leírás
Izolált feldolgozói modell A függvénykód egy külön .NET-feldolgozófolyamatban fut. A .NET és a .NET-keretrendszer támogatott verzióival használható. További információ: .NET izolált feldolgozói folyamatfüggvények fejlesztése.
Folyamaton belüli modell A függvénykód ugyanabban a folyamatban fut, mint a Functions gazdafolyamata. Csak a .NET hosszú távú támogatási (LTS) verzióit támogatja. További információ: .NET-osztálykódtár-függvények fejlesztése.

Az alábbi példa bemutatja, hogy a Dapr-állapot kimeneti kötésének használatával egy új állapotot őrizhet meg az állapottárolóban.

[FunctionName("StateOutputBinding")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] IAsyncCollector<string> state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
    await state.AddAsync(requestBody);

    return new OkResult();
}

Az alábbi példa egy függvényt "CreateNewOrderHttpTrigger" hoz létre a DaprStateOutput kötéssel egy HttpTriggerkövetkezővel:

@FunctionName("CreateNewOrderHttpTrigger")
public String run(
        @HttpTrigger(
            name = "req",
            methods = {HttpMethod.POST},
            authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
        @DaprStateOutput(
            stateStore = "%StateStoreName%",
            key = "product")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java HTTP trigger (CreateNewOrderHttpTrigger) processed a request.");
}

A következő példában a Dapr-állapot kimeneti kötése egy HTTP-eseményindítóval van párosítva, amelyet az app objektum regisztrál:

const { app, trigger } = require('@azure/functions');

app.generic('StateOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "state/{key}",
        name: "req"
    }),
    return: daprStateOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");

        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { value : payload };
    }
});

Az alábbi példák a Dapr-eseményindítókat mutatják be egy function.json fájlban és a PowerShell-kódban, amely ezeket a kötéseket használja.

A kimenet function.json daprState fájlja:

{
  "bindings": 
    {
      "type": "daprState",
      "stateStore": "%StateStoreName%",
      "direction": "out",
      "name": "order",
      "key": "order"
    }
}

A function.json fájltulajdonságokról a Konfiguráció szakaszban talál további információt.

Kódban:

using namespace System
using namespace Microsoft.Azure.WebJobs
using namespace Microsoft.Extensions.Logging
using namespace Microsoft.Azure.WebJobs.Extensions.Dapr
using namespace Newtonsoft.Json.Linq

param (
    $payload
)

# C# function processed a CreateNewOrder request from the Dapr Runtime.
Write-Host "PowerShell function processed a CreateNewOrder request from the Dapr Runtime."

# Payload must be of the format { "data": { "value": "some value" } }

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $payload| ConvertTo-Json

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name order -Value $payload["data"]

Az alábbi példa egy Dapr State kimeneti kötést mutat be, amely a v2 Python programozási modellt használja. A Python-függvényalkalmazás kódjában való használathoz daprState :

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerFunc")
@app.route(route="req", auth_level=dapp.auth_level.ANONYMOUS)
@app.dapr_state_output(arg_name="state", state_store="statestore", key="newOrder")
def main(req: func.HttpRequest, state: func.Out[str] ) -> str:
    # request body must be passed this way '{\"value\": { \"key\": \"some value\" } }'
    body = req.get_body()
    if body is not None:
        state.set(body.decode('utf-8'))
        logging.info(body.decode('utf-8'))
    else:
        logging.info('req body is none')
    return 'ok'

Attribútumok

A folyamatban lévő modellben a dapr-állapot kimeneti kötésének definiálásához használja a DaprState következő paramétereket:

Paraméter Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
StateStore Az állapot mentéséhez használt állapottároló neve. ✔️ ❌
Kulcs Az állapot mentéséhez használt kulcs neve az állapottárolóban. ✔️ ✔️
Érték Szükséges. A tárolt érték. ❌ ✔️

Jegyzetek

A DaprStateOutput széljegyzet lehetővé teszi, hogy egy állapottárolóhoz hozzáférhessen.

Elem Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
stateStore Az állapot mentéséhez használt állapottároló neve. ✔️ ❌
key Az állapot mentéséhez használt kulcs neve az állapottárolóban. ✔️ ✔️
value Szükséges. A tárolt érték. ❌ ✔️

Konfiguráció

Az alábbi táblázat a kódban beállított kötéskonfigurációs tulajdonságokat ismerteti.

Tulajdonság Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
stateStore Az állapot mentéséhez használt állapottároló neve. ✔️ ❌
key Az állapot mentéséhez használt kulcs neve az állapottárolóban. ✔️ ✔️
value Szükséges. A tárolt érték. ❌ ✔️

Az alábbi táblázat a function.json fájlban beállított kötéskonfigurációs tulajdonságokat ismerteti.

function.json tulajdonság Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
stateStore Az állapot mentéséhez használt állapottároló neve. ✔️ ❌
key Az állapot mentéséhez használt kulcs neve az állapottárolóban. ✔️ ✔️
value Szükséges. A tárolt érték. ❌ ✔️

Az alábbi táblázat a Python-kódban beállított kötéskonfigurációs tulajdonságokat @dapp.dapr_state_output ismerteti.

Tulajdonság Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
stateStore Az állapot mentéséhez használt állapottároló neve. ✔️ ❌
key Az állapot mentéséhez használt kulcs neve az állapottárolóban. ✔️ ✔️
value Szükséges. A tárolt érték. ❌ ✔️

Ha a tulajdonságok attribútumokban vannak definiálva, és RequestBodya rendszer prioritást ad a megadott RequestBodyadatoknak.

A teljes példákért tekintse meg a Példa szakaszt .

Használat

A Dapr-állapot kimeneti kötésének használatához először állítson be egy Dapr-állapottároló-összetevőt. A hivatalos Dapr-dokumentációban többet is megtudhat arról, hogy melyik összetevőt használja, és hogyan állíthatja be.

A Python v2-ben való daprState használatához állítsa be a projektet a megfelelő függőségekkel.

  1. Virtuális környezet létrehozása és aktiválása.

  2. requirements.text A fájlban adja hozzá a következő sort:

    azure-functions==1.18.0b3

  3. Telepítse a Python-kódtárat a terminálban.

    pip install -r .\requirements.txt

  4. Módosítsa a local.setting.json fájlt a következő konfigurációval:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Következő lépések

További információ a Dapr-állapotkezelésről.