你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure Functions 的 Dapr 发布输出绑定

Dapr 发布输出绑定允许在函数执行期间将消息发布到 Dapr 主题。

若要了解 Dapr 扩展的设置和配置详细信息，请参阅 Dapr 扩展概述。

示例

可以使用以下 C# 模式之一创建 C# 函数：

执行模型	说明
独立工作模型	函数代码在单独的 .NET 工作进程中运行。 与受支持的 .NET 和 .NET Framework 版本结合使用。 若要了解详细信息，请参阅开发 .NET 独立工作进程函数。
进程模型	函数代码与 Functions 宿主进程在同一进程中运行。 仅支持 .NET 的长期支持 (LTS) 版本。 若要了解详细信息，请参阅开发 .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);
}

隔离进程

如需更多有关 Dapr 输出发布绑定的示例，可参阅 GitHub 存储库。

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

以下示例使用 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.");
}

Node.js v4

在以下示例中，Dapr 发布输出绑定与由 app 对象注册的 HTTP 触发器配对：

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

以下示例显示了 function.json 文件中的 Dapr 触发器以及使用这些绑定的 JavaScript 代码。

daprPublish 的 function.json 文件如下所示：

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

有关 function.json 文件属性的详细信息，请参阅配置部分。

JavaScript 代码如下所示：

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

以下示例显示了 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

Python v2

以下示例显示了一个 Dapr 发布输出绑定，该绑定使用 v2 Python 编程模型。 在 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'))

Python v1

以下示例显示了一个 Dapr 发布输出绑定，该绑定使用 v1 Python 编程模型。

daprPublish 的 function.json 文件如下所示：

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

有关 function.json 文件属性的详细信息，请参阅配置部分。

下面是 Python 代码：

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

属性

进程内

在进程内模型中，使用 DaprPublish 定义支持以下参数的 Dapr 发布输出绑定：

“function.json”属性	说明	可通过 Attribute 发送	可通过 RequestBody 发送
PubSubName	要发送消息的 Dapr 发布/订阅的名称。	✔	✔
主题	要发送消息的 Dapr 主题的名称。	✔	✔
有效负载	必需。 正在发布的消息。	❌	✔

隔离进程

在独立辅助角色模型中，使用 DaprPublish Output 定义支持以下参数的 Dapr 发布输出绑定：

“function.json”属性	说明	可通过 Attribute 发送	可通过 RequestBody 发送
PubSubName	要发送消息的 Dapr 发布/订阅的名称。	✔	✔
主题	要发送消息的 Dapr 主题的名称。	✔	✔
有效负载	必需。 正在发布的消息。	❌	✔

批注

通过 DaprPublishOutput 注释，可以让函数访问已发布的消息。

元素	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pubSubName	要发送消息的 Dapr 发布/订阅的名称。	✔	✔
topic	要发送消息的 Dapr 主题的名称。	✔	✔
payload	必需。 正在发布的消息。	❌	✔

配置

Node.js v4

下表说明了在代码中设置的绑定配置属性。

properties	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pubsubname	发布服务器组件服务的名称。	✔	✔
topic	发布服务器主题的名称/标识符	✔	✔
payload	必需。 正在发布的消息。	❌	✔

Node.js v3

下表解释了在 function.json 文件中设置的绑定配置属性。

“function.json”属性	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pubsubname	发布服务器组件服务的名称。	✔	✔
topic	发布服务器主题的名称/标识符	✔	✔
payload	必需。 正在发布的消息。	❌	✔

下表解释了在 function.json 文件中设置的绑定配置属性。

“function.json”属性	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pubsubname	发布服务器组件服务的名称。	✔	✔
topic	发布服务器主题的名称/标识符	✔	✔
payload	必需。 正在发布的消息。	❌	✔

Python v2

下表介绍了在 Python 代码中设置的 @dapp.dapr_publish_output 的绑定配置属性。

properties	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pub_sub_name	发布服务器事件的名称。	✔	✔
topic	发布服务器主题的名称/标识符。	✔	✔
payload	必需。 正在发布的消息。	❌	✔

Python v1

下表解释了在 function.json 文件中设置的绑定配置属性。

“function.json”属性	说明	可通过 Attribute 发送	可通过 RequestBody 发送
pubsubname	发布服务器组件服务的名称。	✔	✔
topic	发布服务器主题的名称/标识符	✔	✔
payload	必需。 正在发布的消息。	❌	✔

如果属性在 Attributes 和 RequestBody 中定义，则优先于 RequestBody 中提供的数据。

有关完整示例，请参阅示例部分。

使用情况

要使用 Dapr 发布输出绑定，请先设置 Dapr 发布/订阅组件。 可在 Dapr 官方文档中详细了解可使用的组件及其设置方式。

• Dapr 发布/订阅组件规格
• 如何：发布消息并订阅主题

Python v2

要在 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
   

Python v1

除了设置输出发布/订阅组件外，Python v1 模型不需要你进行任何其他更改。

后续步骤

详细了解 Dapr 发布和订阅。