共用方式為

適用於 Azure Functions 的 Dapr 主題觸發程序

  • 發行項

您可以使用以下 Dapr 事件在 Dapr 主題訂閱上觸發 Azure Functions。

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

範例

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

執行模型 描述
隔離式背景工作模型 您的函數程式碼在個別的 .NET 背景工作處理序中執行。 搭配支援的 .NET 和 .NET Framework 版本使用。 若要深入了解，請參閱開發 .NET 隔離式背景工作處理序函數。
同處理序模型 您的函數程式碼執行的處理序與 Functions 主機處理序相同。 僅支援長期支援 (LTS) 的 .NET 版本。 若要深入了解，請參閱開發 .NET 類別庫函數。 
[FunctionName("TransferEventBetweenTopics")]
public static void Run(
    [DaprTopicTrigger("%PubSubName%", Topic = "A")] CloudEvent subEvent,
    [DaprPublish(PubSubName = "%PubSubName%", Topic = "B")] out DaprPubSubEvent pubEvent,
    ILogger log)
{
    log.LogInformation("C# function processed a TransferEventBetweenTopics request from the Dapr Runtime.");


    pubEvent = new DaprPubSubEvent("Transfer from Topic A: " + subEvent.Data);
}

以下是使用 Dapr 主題觸發程序訂閱主題的 Java 程式碼：

@FunctionName("PrintTopicMessage")
public String run(
        @DaprTopicTrigger(
            pubSubName = "%PubSubName%",
            topic = "B")
        String payload,
        final ExecutionContext context) throws JsonProcessingException {
    Logger logger = context.getLogger();
    logger.info("Java function processed a PrintTopicMessage request from the Dapr Runtime.");

使用 app 物件來註冊 daprTopicTrigger：

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

app.generic('TransferEventBetweenTopics', {
    trigger: trigger.generic({
        type: 'daprTopicTrigger',
        name: "subEvent",
        pubsubname: "%PubSubName%",
        topic: "A"
    }),
    return: daprPublishOutput,
    handler: async (request, context) => {
        context.log("Node function processed a TransferEventBetweenTopics request from the Dapr Runtime.");
        context.log(context.triggerMetadata.subEvent.data);

        return { payload: context.triggerMetadata.subEvent.data };
    }
});

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

以下是 daprTopicTrigger 的 function.json 檔案：

{
  "bindings": [
    {
      "type": "daprTopicTrigger",
      "pubsubname": "%PubSubName%",
      "topic": "B",
      "name": "subEvent",
      "direction": "in"
    }
  ]
}

如需 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

param (
    $subEvent
)

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

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

Write-Host "Topic B received a message: $jsonString"

下列範例示範使用 v2 Python 程式設計模型的 Dapr 主題觸發程序。 若要在您的 Python 函式應用程式程式碼中使用 daprTopicTrigger：

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="PrintTopicMessage")
@app.dapr_topic_trigger(arg_name="subEvent", pub_sub_name="%PubSubName%", topic="B", route="B")
def main(subEvent) -> None:
    logging.info('Python function processed a PrintTopicMessage request from the Dapr Runtime.')
    subEvent_json = json.loads(subEvent)
    logging.info("Topic B received a message: " + subEvent_json["data"])

屬性

在內含式模型中，使用 DaprTopicTrigger 來觸發 Dapr 發佈/訂閱繫結，其支援下列屬性。

參數 描述
PubSubName Dapr 發佈/訂閱的名稱。
主題 Dapr 主題的名稱。

註釋

DaprTopicTrigger 註釋可讓您建立函式，以在收到主題時執行。

元素 描述
pubSubName Dapr 發佈/訂閱的名稱。
topic Dapr 主題的名稱。

組態

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

屬性 說明
pubsubname Dapr 發佈/訂閱元件類型的名稱。
topic 主題的名稱。

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

function.json 屬性 描述
pubsubname Dapr 發佈/訂閱元件類型的名稱。
topic 主題的名稱。

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

屬性 說明 可透過屬性傳送 可透過 RequestBody 傳送
pub_sub_name Dapr 訂閱元件類型的名稱。 ✔️ ❌
topic 訂閱主題。 ✔️ ❌

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

使用方式

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

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

  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 發佈和訂閱。