Azure Functions 的 RabbitMQ 触发器概述RabbitMQ trigger for Azure Functions overview

以下示例显示了一个 C# 函数，该函数将 RabbitMQ 消息作为 RabbitMQ 事件进行读取和记录：The following example shows a C# function that reads and logs the RabbitMQ message as a RabbitMQ Event:

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

以下示例演示如何将消息作为 POCO 读取。The following example shows how to read the message as a POCO.

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

与 Json 对象一样，如果未将消息格式正确设置为 C# 对象，则会发生错误。Like with Json objects, an error will occur if the message isn't properly formatted as a C# object. 如果格式设置正确，则将其绑定到变量 pocObj，该变量可用于所需的任何用途。If it is, it is then bound to the variable pocObj, which can be used for what whatever it is needed for.

以下示例演示 function.json 文件中的一个 RabbitMQ 触发器绑定以及使用该绑定的 C# 脚本函数。The following example shows a RabbitMQ trigger binding in a function.json file and a C# script function that uses the binding. 此函数读取并记录 RabbitMQ 消息。The function reads and logs the RabbitMQ message.

下面是 function.json 文件中的绑定数据：Here's the binding data in the function.json file:

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

C# 脚本代码如下所示：Here's the C# script code:

using System;

public static void Run(string myQueueItem, ILogger log)
{
    log.LogInformation($"C# Script RabbitMQ trigger function processed: {myQueueItem}");
}

以下示例演示 function.json 文件中的一个 RabbitMQ 触发器绑定以及使用该绑定的 JavaScript 脚本函数。The following example shows a RabbitMQ trigger binding in a function.json file and a JavaScript function that uses the binding. 此函数读取并记录 RabbitMQ 消息。The function reads and logs a RabbitMQ message.

下面是 function.json 文件中的绑定数据：Here's the binding data in the function.json file:

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

JavaScript 脚本代码如下所示：Here's the JavaScript script code:

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

以下 Java 函数使用 Java RabbitMQ 类型中的 @RabbitMQTrigger 注释来说明 RabbitMQ 队列触发器的配置。The following Java function uses the @RabbitMQTrigger annotation from the Java RabbitMQ types to describe the configuration for a RabbitMQ queue trigger. 此函数获取放置在队列上的消息，然后将其添加到日志。The function grabs the message placed on the queue and adds it to the logs.

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

在 C# 类库中，使用 RabbitMQTrigger 特性。In C# class libraries, use the RabbitMQTrigger attribute.

下面是某个方法签名中的 RabbitMQTrigger 特性：Here's a RabbitMQTrigger attribute in a method signature:

[FunctionName("RabbitMQTest")]
public static void RabbitMQTest([RabbitMQTrigger("queue")] string message, ILogger log)
{
    ...
}

有关完整示例，请参阅 C# 示例。For a complete example, see C# example.

C# 脚本不支持特性。Attributes are not supported by C# Script.

JavaScript 不支持特性。Attributes are not supported by JavaScript.

使用 RabbitMQTrigger 注释，你’可以创建在创建 RabbitMQ 消息时要运行的函数。The RabbitMQTrigger annotation allows you to create a function that runs when a RabbitMQ message is created. 可用的配置选项包括队列名称和连接字符串名称。Configuration options available include queue name and connection string name. 有关其他参数详细信息，请访问 RabbitMQTrigger Java 注释。For additional parameter details please visit the RabbitMQTrigger Java annotations.

有关更多详细信息，请参阅触发器示例。See the trigger example for more detail.

默认消息类型为 RabbitMQ 事件，RabbitMQ 事件的 Body 属性可以读取为下面列出的类型：The default message type is RabbitMQ Event, and the Body property of the RabbitMQ Event can be read as the types listed below:

• An object serializable as JSON - 消息以有效的 JSON 字符串形式传递。An object serializable as JSON - The message is delivered as a valid JSON string.
• string
• byte[]
• POCO - 消息的格式设置为 C# 对象。POCO - The message is formatted as a C# object. 有关完整示例，请参阅 C# 示例。For a complete example, see C# example.

默认消息类型为 RabbitMQ 事件，RabbitMQ 事件的 Body 属性可以读取为下面列出的类型：The default message type is RabbitMQ Event, and the Body property of the RabbitMQ Event can be read as the types listed below:

• An object serializable as JSON - 消息以有效的 JSON 字符串形式传递。An object serializable as JSON - The message is delivered as a valid JSON string.
• string
• byte[]
• POCO - 消息的格式设置为 C# 对象。POCO - The message is formatted as a C# object. 有关完整示例，请参阅 C# 脚本示例。For a complete example, see C# Script example.

队列消息可通过 context.bindings 获得。The queue message is available via context.bindings. 其中 与 function.json 中定义的名称相匹配。where matches the name defined in function.json. 如果有效负载为 JSON，该值将反序列化为对象。If the payload is JSON, the value is deserialized into an object.

请参阅 Java 特性和注释。Refer to Java attributes and annotations.