Dapr Publish 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 közzétételi kimeneti kötése lehetővé teszi, hogy egy függvény végrehajtása során közzétegye az üzenetet egy Dapr-témakörbe.

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 egy Dapr-közzétételi kimeneti kötés használatát mutatja be egy Dapr-közzétételi művelet végrehajtásához egy pubban/alösszetevőben és -témakörben.

[FunctionName("PublishOutputBinding")]
public static void Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "topic/{topicName}")] HttpRequest req,
    [DaprPublish(PubSubName = "%PubSubName%", Topic = "{topicName}")] out DaprPubSubEvent pubSubEvent,
    ILogger log)
{
    string requestBody = new StreamReader(req.Body).ReadToEnd();
    pubSubEvent = new DaprPubSubEvent(requestBody);
}

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

@FunctionName("TransferEventBetweenTopics")
public String run(
        @DaprTopicTrigger(
            pubSubName = "%PubSubName%",
            topic = "A")
            String request,
        @DaprPublishOutput(
            pubSubName = "%PubSubName%",
            topic = "B")
        OutputBinding<String> payload,
        final ExecutionContext context) throws JsonProcessingException {
    context.getLogger().info("Java function processed a TransferEventBetweenTopics request from the Dapr Runtime.");
}

A következő példában a Dapr közzétételi 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('PublishOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "topic/{topicName}",
        name: "req"
    }),
    return: daprPublishOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");
        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { payload: 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 következő function.json fájl:daprPublish

{
  "bindings": 
    {
      "type": "daprPublish",
      "direction": "out",
      "name": "pubEvent",
      "pubsubname": "%PubSubName%",
      "topic": "B"
    }
}

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

# Example to use Dapr Service Invocation Trigger and Dapr State Output binding to persist a new state into statestore
param (
    $subEvent
)

Write-Host "PowerShell function processed a TransferEventBetweenTopics request from the Dapr Runtime."

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $subEvent["data"]

$messageFromTopicA = "Transfer from Topic A: $jsonString".Trim()

$publish_output_binding_req_body = @{
    "payload" = $messageFromTopicA
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name pubEvent -Value $publish_output_binding_req_body

Az alábbi példa egy Dapr Publish 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 daprPublish :

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="TransferEventBetweenTopics")
@app.dapr_topic_trigger(arg_name="subEvent", pub_sub_name="%PubSubName%", topic="A", route="A")
@app.dapr_publish_output(arg_name="pubEvent", pub_sub_name="%PubSubName%", topic="B")
def main(subEvent, pubEvent: func.Out[bytes]) -> None:
    logging.info('Python function processed a TransferEventBetweenTopics request from the Dapr Runtime.')
    subEvent_json = json.loads(subEvent)
    payload = "Transfer from Topic A: " + str(subEvent_json["data"])
    pubEvent.set(json.dumps({"payload": payload}).encode('utf-8'))

Attribútumok

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

function.json tulajdonság Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
PubSubName Az üzenet küldéséhez a Dapr pub/sub neve. ✔️ ✔️
Téma Az üzenet küldéséhez szükséges Dapr-témakör neve. ✔️ ✔️
Hasznos adatok Szükséges. A közzétett üzenet. ❌ ✔️

Jegyzetek

A DaprPublishOutput széljegyzet lehetővé teszi, hogy egy függvény hozzáférjen egy közzétett üzenethez.

Elem Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
pubSubName Az üzenet küldéséhez a Dapr pub/sub neve. ✔️ ✔️
témakör Az üzenet küldéséhez szükséges Dapr-témakör neve. ✔️ ✔️
hasznos adatok Szükséges. A közzétett üzenet. ❌ ✔️

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
pubsubname A közzétevő összetevő szolgáltatásának neve. ✔️ ✔️
témakör A közzétevő témakör neve/azonosítója. ✔️ ✔️
hasznos adatok Szükséges. A közzétett üzenet. ❌ ✔️

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
pubsubname A közzétevő összetevő szolgáltatásának neve. ✔️ ✔️
témakör A közzétevő témakör neve/azonosítója. ✔️ ✔️
hasznos adatok Szükséges. A közzétett üzenet. ❌ ✔️

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

Tulajdonság Leírás Attribútumon keresztül küldhető el Elküldhető a RequestBody-on keresztül
pub_sub_name A közzétevő esemény neve. ✔️ ✔️
témakör A közzétevő témakör neve/azonosítója. ✔️ ✔️
hasznos adatok Szükséges. A közzétett üzenet. ❌ ✔️

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 közzétételi kimeneti kötésének használatához először állítson be egy Dapr pubot/alö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ó daprPublish 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 közzétételéről és a feliratkozásról.