Partilhar via


Vinculação de saída Dapr Publish para o Azure Functions

A associação de saída de publicação do Dapr permite que você publique uma mensagem em um tópico do Dapr durante a execução de uma função.

Para obter informações sobre detalhes de instalação e configuração da extensão Dapr, consulte a visão geral da extensão Dapr.

Exemplo

Uma função C# pode ser criada usando um dos seguintes modos C#:

Modelo de execução Description
Modelo de trabalhador isolado Seu código de função é executado em um processo de trabalho .NET separado. Use com versões suportadas do .NET e .NET Framework. Para saber mais, consulte Desenvolver funções de processo de trabalho isoladas do .NET.
Modelo em processo Seu código de função é executado no mesmo processo que o processo de host de funções. Suporta apenas versões LTS (Long Term Support) do .NET. Para saber mais, consulte Desenvolver funções de biblioteca de classes .NET.

O exemplo a seguir demonstra o uso de uma ligação de saída de publicação do Dapr para executar uma operação de publicação do Dapr em um componente e tópico pub/sub.

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

O exemplo a seguir cria uma "TransferEventBetweenTopics" função usando a DaprPublishOutput associação com um 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.");
}

No exemplo a seguir, a ligação de saída de publicação do Dapr é emparelhada com um gatilho app HTTP, que é registrado pelo objeto:

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

Os exemplos a seguir mostram gatilhos Dapr em um arquivo function.json e código PowerShell que usa essas associações.

Aqui está o arquivo function.json para daprPublish:

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

Para obter mais informações sobre function.json propriedades do arquivo, consulte a seção Configuração .

No código:

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

O exemplo a seguir mostra uma ligação de saída Dapr Publishing, que usa o modelo de programação Python v2. Para usar daprPublish no código do aplicativo de função Python:

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

Atributos

No modelo em processo, use o DaprPublish para definir uma ligação de saída de publicação Dapr, que suporta estes parâmetros:

function.json propriedade Description Pode ser enviado via Atributo Pode ser enviado via RequestBody
PubSubName O nome do pub/sub do Dapr para enviar a mensagem. ✔️ ✔️
Tópico O nome do tópico Dapr para enviar a mensagem. ✔️ ✔️
Carga útil Obrigatório. A mensagem que está sendo publicada. ✔️

Anotações

A DaprPublishOutput anotação permite que você tenha uma função de acesso a uma mensagem publicada.

Elemento Description Pode ser enviado via Atributo Pode ser enviado via RequestBody
pubSubNome O nome do pub/sub do Dapr para enviar a mensagem. ✔️ ✔️
topic O nome do tópico Dapr para enviar a mensagem. ✔️ ✔️
carga útil Obrigatório. A mensagem que está sendo publicada. ✔️

Configuração

A tabela a seguir explica as propriedades de configuração de vinculação definidas no código.

Property Description Pode ser enviado via Atributo Pode ser enviado via RequestBody
pubsubnome O nome do serviço de componente do editor. ✔️ ✔️
topic O nome/identificador do tópico do editor. ✔️ ✔️
carga útil Obrigatório. A mensagem que está sendo publicada. ✔️

A tabela a seguir explica as propriedades de configuração de associação definidas no arquivo function.json .

function.json propriedade Description Pode ser enviado via Atributo Pode ser enviado via RequestBody
pubsubnome O nome do serviço de componente do editor. ✔️ ✔️
topic O nome/identificador do tópico do editor. ✔️ ✔️
carga útil Obrigatório. A mensagem que está sendo publicada. ✔️

A tabela a seguir explica as propriedades de configuração de vinculação definidas @dapp.dapr_publish_output no código Python.

Property Description Pode ser enviado via Atributo Pode ser enviado via RequestBody
pub_sub_name O nome do evento do editor. ✔️ ✔️
topic O nome/identificador do tópico do editor. ✔️ ✔️
carga útil Obrigatório. A mensagem que está sendo publicada. ✔️

Se as propriedades forem definidas em Atributos e RequestBody, será dada prioridade aos dados fornecidos em RequestBody.

Consulte a seção Exemplo para obter exemplos completos.

Utilização

Para usar a ligação de saída de publicação do Dapr, comece configurando um componente pub/sub do Dapr. Você pode saber mais sobre qual componente usar e como configurá-lo na documentação oficial do Dapr.

Para usar o daprPublish em Python v2, configure seu projeto com as dependências corretas.

  1. Crie e ative um ambiente virtual.

  2. No ficheiro requirements.text , adicione a seguinte linha:

    azure-functions==1.18.0b3
    
  3. No terminal, instale a biblioteca Python.

    pip install -r .\requirements.txt
    
  4. Modifique seu local.setting.json arquivo com a seguinte configuração:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
    

Próximos passos

Saiba mais sobre a publicação e assinatura do Dapr.