Dapr Uitvoerbinding publiceren voor Azure Functions

Met de Dapr-uitvoerbinding kunt u tijdens het uitvoeren van een functie een bericht publiceren naar een Dapr-onderwerp.

Zie het overzicht van de Dapr-extensie voor meer informatie over het instellen en configureren van de Dapr-extensie.

Opmerking

U kunt een C#-functie maken met behulp van een van de volgende C#-modi:

Uitvoeringsmodel	Beschrijving
Geïsoleerde werkrolmodel	Uw functiecode wordt uitgevoerd in een afzonderlijk .NET-werkproces. Gebruiken met ondersteunde versies van .NET en .NET Framework. Zie .NET geïsoleerde werkprocesfuncties ontwikkelen voor meer informatie.
Model in proces	Uw functiecode wordt uitgevoerd in hetzelfde proces als het Functions-hostproces. Ondersteunt alleen LTS-versies (Long Term Support) van .NET. Zie .NET-klassebibliotheekfuncties ontwikkelen voor meer informatie.

In-proces

In het volgende voorbeeld ziet u hoe u een Dapr-uitvoerbinding gebruikt om een Dapr-publicatiebewerking uit te voeren naar een pub/subonderdeel en onderwerp.

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

Geïsoleerd proces

Meer voorbeelden voor de Dapr-uitvoerpubliceerbinding zijn beschikbaar in de GitHub-opslagplaats.

[Function("PublishOutputBinding")]
[DaprPublishOutput(PubSubName = "%PubSubName%", Topic = "{topicName}")]
public static DaprPubSubEvent Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "topic/{topicName}")] HttpRequestData req,
    FunctionContext functionContext)
{
    string requestBody = new StreamReader(req.Body).ReadToEnd();

    return new DaprPubSubEvent(requestBody);
}

In het volgende voorbeeld wordt een "TransferEventBetweenTopics" functie gemaakt met behulp van de DaprPublishOutput binding met een DaprTopicTrigger:

@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.");
}

Node.js v4

In het volgende voorbeeld wordt de Dapr-uitvoerbinding gekoppeld aan een HTTP-trigger, die is geregistreerd door het app object:

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

Node.js v3

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en JavaScript-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprPublish:

{
  "bindings": 
    {
      "type": "daprPublish",
      "direction": "out",
      "pubsubname": "messagebus",
      "topic": "{topicName}",
      "name": "payload"
    }
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

Dit is de JavaScript-code:

module.exports = async function (context, req) {
    context.log("Node HTTP trigger function processed a request.");
    context.bindings.payload = { payload: req.body };
    context.done(null);
};

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en PowerShell-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprPublish:

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

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

In code:

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

Python v2

In het volgende voorbeeld ziet u een Dapr Publish-uitvoerbinding, die gebruikmaakt van het v2 Python-programmeermodel. Ga als volgt te werk om deze te gebruiken daprPublish in de code van uw Python-functie-app:

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

Python v1

In het volgende voorbeeld ziet u een Dapr Publish-uitvoerbinding, die gebruikmaakt van het python-programmeermodel v1.

Dit is het function.json-bestand voor daprPublish:

{
  "scriptFile": "__init__.py",
  "bindings": 
    {
      "type": "daprPublish",
      "direction": "out",
      "name": "pubEvent",
      "pubsubname": "messagebus",
      "topic": "B"
    }
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

Dit is de Python-code:

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

Kenmerken

In-proces

Gebruik in het procesmodel de DaprPublish methode om een Dapr-uitvoerbinding te definiëren die ondersteuning biedt voor deze parameters:

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
PubSubName	De naam van de Dapr pub/sub om het bericht te verzenden.	✔️	✔️
Onderwerp	De naam van het Dapr-onderwerp om het bericht te verzenden.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Geïsoleerd proces

Gebruik in het geïsoleerde werkrolmodel de DaprPublish Output definitie van een Dapr-uitvoerbinding die ondersteuning biedt voor deze parameters:

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
PubSubName	De naam van de Dapr pub/sub om het bericht te verzenden.	✔️	✔️
Onderwerp	De naam van het Dapr-onderwerp om het bericht te verzenden.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Aantekeningen

Met de DaprPublishOutput aantekening kunt u een functie toegang hebben tot een gepubliceerd bericht.

Element	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pubSubName	De naam van de Dapr pub/sub om het bericht te verzenden.	✔️	✔️
onderwerp	De naam van het Dapr-onderwerp om het bericht te verzenden.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Configuratie

Node.js v4

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in de code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pubsubname	De naam van de onderdeelservice van de uitgever.	✔️	✔️
onderwerp	De naam/id van het uitgeversonderwerp.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Node.js v3

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pubsubname	De naam van de onderdeelservice van de uitgever.	✔️	✔️
onderwerp	De naam/id van het uitgeversonderwerp.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pubsubname	De naam van de onderdeelservice van de uitgever.	✔️	✔️
onderwerp	De naam/id van het uitgeversonderwerp.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Python v2

In de volgende tabel worden de bindingsconfiguratie-eigenschappen @dapp.dapr_publish_output uitgelegd die u in uw Python-code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pub_sub_name	De naam van de gebeurtenis van de uitgever.	✔️	✔️
onderwerp	De naam/id van het uitgeveronderwerp.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Python v1

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
pubsubname	De naam van de onderdeelservice van de uitgever.	✔️	✔️
onderwerp	De naam/id van het uitgeversonderwerp.	✔️	✔️
Nettolading	Vereist. Het bericht dat wordt gepubliceerd.	❌	✔️

Als eigenschappen zijn gedefinieerd in zowel kenmerken als RequestBody, wordt prioriteit gegeven aan gegevens die zijn opgegeven in RequestBody.

Zie de sectie Voorbeeld voor volledige voorbeelden.

Gebruik

Als u de Dapr-uitvoerbinding wilt gebruiken, begint u met het instellen van een Dapr pub/subonderdeel. Meer informatie over welk onderdeel u moet gebruiken en hoe u dit kunt instellen in de officiële Dapr-documentatie.

• Dapr pub/subcomponentspecificaties
• Procedure: Een bericht publiceren en zich abonneren op een onderwerp

Python v2

Als u het daprPublish project in Python v2 wilt gebruiken, stelt u uw project in met de juiste afhankelijkheden.

1. Een virtuele omgeving maken en activeren.

2. Voeg in het requirements.text bestand de volgende regel toe:

   azure-functions==1.18.0b3
   

3. Installeer de Python-bibliotheek in de terminal.

   pip install -r .\requirements.txt
   

4. Wijzig uw local.setting.json bestand met de volgende configuratie:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

Voor het Python v1-model zijn geen aanvullende wijzigingen vereist, afgezien van het instellen van het uitvoer pub/subonderdeel.

Volgende stappen

Meer informatie over publiceren en abonneren op Dapr.