分享方式：

Azure Functions 的 Dapr 發佈出繫結

  • 文章

Dapr 發佈輸出繫結可讓您在函式執行期間將訊息發佈至 Dapr 主題。

如需 Dapr 延伸模組的安裝和設定詳細資料，請參閱 Dapr 延伸模組概觀。

範例

您可以使用下列其中一種 C# 模式來建立 C# 函式：

執行模型 描述
隔離式背景工作模型 您的函數程式碼在個別的 .NET 背景工作處理序中執行。 搭配支援的 .NET 和 .NET Framework 版本使用。 若要深入了解，請參閱開發 .NET 隔離式背景工作處理序函數。
同處理序模型 您的函數程式碼執行的處理序與 Functions 主機處理序相同。 僅支援長期支援 (LTS) 的 .NET 版本。 若要深入了解，請參閱開發 .NET 類別庫函數。

下列範例示範如何使用 Dapr 發佈輸出繫結，對發佈/訂閱元件和主題執行 Dapr 發佈作業。

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

下列範例會使用 DaprPublishOutput 繫結搭配 DaprTopicTrigger 來建立 "TransferEventBetweenTopics" 函式：

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

在下列範例中，Dapr 發佈輸出繫結會與 HTTP 觸發程序配對，該程式是由 app 物件所註冊：

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

下列範例顯示 function.json 檔案中的 Dapr 觸發程序，以及使用這些繫結的 PowerShell 程式碼。

以下是 daprPublish 的 function.json 檔案：

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

如需 function.json 檔案屬性的詳細資訊，請參閱設定一節。

程式碼：

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

下列範例示範使用 v2 Python 程式設計模型的 Dapr 發佈輸出繫結。 若要在您的 Python 函式應用程式程式碼中使用 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'))

屬性

在內含式模型中，使用 DaprPublish 來定義 Dapr Binding 輸出發佈，其支援下列參數：

function.json 屬性 描述 可透過屬性傳送 可透過 RequestBody 傳送
PubSubName 要傳送訊息的 Dapr 發佈/訂閱名稱。 ✔️ ✔️
主題 要傳送訊息的 Dapr 主題名稱。 ✔️ ✔️
承載 必要。 發佈的訊息。 ❌ ✔️

註釋

DaprPublishOutput 註釋可讓您讓函式存取已發佈的訊息。

元素 描述 可透過屬性傳送 可透過 RequestBody 傳送
pubSubName 要傳送訊息的 Dapr 發佈/訂閱名稱。 ✔️ ✔️
topic 要傳送訊息的 Dapr 主題名稱。 ✔️ ✔️
payload 必要。 發佈的訊息。 ❌ ✔️

組態

下表說明您在程式碼中設定的繫結設定屬性。

屬性 說明 可透過屬性傳送 可透過 RequestBody 傳送
pubsubname 發行者元件服務的名稱。 ✔️ ✔️
topic 發行者主題的名稱/識別碼。 ✔️ ✔️
payload 必要。 發佈的訊息。 ❌ ✔️

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性 描述 可透過屬性傳送 可透過 RequestBody 傳送
pubsubname 發行者元件服務的名稱。 ✔️ ✔️
topic 發行者主題的名稱/識別碼。 ✔️ ✔️
payload 必要。 發佈的訊息。 ❌ ✔️

下表說明您在 Python 程式碼中設定的 @dapp.dapr_publish_output 繫結組態屬性。

屬性 說明 可透過屬性傳送 可透過 RequestBody 傳送
pub_sub_name 發行者活動的名稱。 ✔️ ✔️
topic 發行者主題名稱/識別碼。 ✔️ ✔️
payload 必要。 發佈的訊息。 ❌ ✔️

如果屬性在 Attributes 和 RequestBody 中都有定義，則系統會優先考量 RequestBody 中提供的資料。

如需完整範例，請參閱範例一節。

使用方式

若要使用 Dapr 發佈輸出繫結，請先設定 Dapr 發佈/訂閱件。 您可以在官方 Dapr 文件中深入了解要使用哪個元件，以及如何進行設定。

若要在 Python v2 中使用 daprPublish，請設定您的專案使其具備正確的相依性。

  1. 建立並啟用虛擬環境。

  2. 在 requirements.text 檔案中新增以下這一行：

    azure-functions==1.18.0b3

  3. 在終端機中，安裝 Python 程式庫。

    pip install -r .\requirements.txt

  4. 使用下列組態修改您的 local.setting.json 檔案：

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

下一步

深入了解 Dapr 發佈和訂閱。