Azure Functions 的 RabbitMQ 触发器概述

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

• 独立辅助角色模型：编译的 C# 函数，该函数在独立于运行时的工作进程中运行。 需要隔离的工作进程来支持长期支持 （LTS） 和非 LTS 版本的 .NET 和 .NET Framework 上运行的 C# 函数。
• 进程内模型：在 Azure Functions 运行时所在的同一进程中运行的已编译 C# 函数。
• C# 脚本：主要在 Azure 门户中创建 C# 函数时使用。

[Function(nameof(RabbitMQFunction))]
[RabbitMQOutput(QueueName = "destinationQueue", ConnectionStringSetting = "RabbitMQConnection")]
public static string Run([RabbitMQTrigger("queue", ConnectionStringSetting = "RabbitMQConnection")] string item,
    FunctionContext context)
{
    var logger = context.GetLogger(nameof(RabbitMQFunction));

    logger.LogInformation(item);

    var message = $"Output message created at {DateTime.Now}";
    return message;
}

[FunctionName("RabbitMQTriggerCSharp")]
public static void RabbitMQTrigger_BasicDeliverEventArgs(
    [RabbitMQTrigger("queue", ConnectionStringSetting = "rabbitMQConnectionAppSetting")] BasicDeliverEventArgs args,
    ILogger logger
    )
{
    logger.LogInformation($"C# RabbitMQ queue trigger function processed message: {Encoding.UTF8.GetString(args.Body)}");
}

namespace Company.Function
{
    public class TestClass
    {
        public string x { get; set; }
    }

    public class RabbitMQTriggerCSharp{
        [FunctionName("RabbitMQTriggerCSharp")]
        public static void RabbitMQTrigger_BasicDeliverEventArgs(
            [RabbitMQTrigger("queue", ConnectionStringSetting = "rabbitMQConnectionAppSetting")] TestClass pocObj,
            ILogger logger
            )
        {
            logger.LogInformation($"C# RabbitMQ queue trigger function processed message: {pocObj}");
        }
    }
}

以下 Java 函数使用 @RabbitMQTrigger中的 注释来说明 RabbitMQ 队列触发器的配置。 此函数获取放置在队列上的消息，然后将其添加到日志。

@FunctionName("RabbitMQTriggerExample")
public void run(
    @RabbitMQTrigger(connectionStringSetting = "rabbitMQConnectionAppSetting", queueName = "queue") String input,
    final ExecutionContext context)
{
    context.getLogger().info("Java HTTP trigger processed a request." + input);
}

以下示例演示 function.json 文件中的一个 RabbitMQ 触发器绑定以及使用该绑定的 JavaScript 脚本函数。 此函数读取并记录 RabbitMQ 消息。

下面是 function.json 文件中的绑定数据：

{​​
    "bindings": [
        {​​
            "name": "myQueueItem",
            "type": "rabbitMQTrigger",
            "direction": "in",
            "queueName": "queue",
            "connectionStringSetting": "rabbitMQConnectionAppSetting"
        }​​
    ]
}​​

JavaScript 脚本代码如下所示：

module.exports = async function (context, myQueueItem) {​​
    context.log('JavaScript RabbitMQ trigger function processed work item', myQueueItem);
}​​;

以下示例演示如何通过触发器读取 RabbitMQ 队列消息。

RabbitMQ 绑定在 function.json 中定义，其中“类型”设置为 。

{​​
    "scriptFile": "__init__.py",
    "bindings": [
        {​​
            "name": "myQueueItem",
            "type": "rabbitMQTrigger",
            "direction": "in",
            "queueName": "queue",
            "connectionStringSetting": "rabbitMQConnectionAppSetting"
        }​​
    ]
}​​

import logging
import azure.functions as func

def main(myQueueItem) -> None:
    logging.info('Python RabbitMQ trigger function processed a queue item: %s', myQueueItem)

PowerShell 示例当前不可用。

特性

隔离的工作进程和进程内 C# 库都用于RabbitMQTriggerAttribute定义函数，其中属性的特定属性取决于扩展版本。

批注

使用 RabbitMQTrigger 注释，你’可以创建在创建 RabbitMQ 消息时要运行的函数。

配置

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

在本地开发时，请将应用程序设置添加到 集合的 Values。

RabbitMQ 触发器支持的参数类型取决于使用的 C# 形式。

队列消息可通过 context.bindings.<NAME> 获得，其中 <NAME> 与 function.json 中定义的名称匹配。 如果有效负载为 JSON，该值将反序列化为对象。