使用ServiceBusTrigger时无法解决「绑定参数异常」问题

问题描述 #

编写首个基于ServiceBusTrigger的Azure函数时，队列连接正常，通过Azure门户的Service Bus Explorer注入消息后函数会尝试执行，但失败重试指定次数后消息移至死信队列。无论使用JSON对象（application/json）还是字符串（text/plain）类型的消息，均出现绑定异常：

System.Private.CoreLib: 执行函数ServiceBusQueueTriggerCSharp时发生异常。Microsoft.Azure.WebJobs.Host: 绑定参数'myQueueItem'时发生异常。

函数代码如下：

using System;
using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace PlayerProcessing.PendingPlayerCustomId;

public class QueueWorker
{
    private readonly ILogger _log;

    public QueueWorker(IServiceProvider serviceProvider)
    {
        _log = serviceProvider.GetService<ILogger<QueueWorker>>();
    }
    
    [FunctionName("ServiceBusQueueTriggerCSharp")]                    
    public void Run(
        [ServiceBusTrigger("pending-player-custom-id", Connection = "AzureServiceBus")] 
        string myQueueItem
    )
    {
        _log.LogInformation($"C# ServiceBus queue trigger function processed message: {myQueueItem}");
    }
}

解决方案 #

1. 修正Logger注入方式 #

避免通过IServiceProvider手动获取Logger，改为构造函数直接注入，确保Logger实例正确初始化：

private readonly ILogger<QueueWorker> _log;

public QueueWorker(ILogger<QueueWorker> logger)
{
    _log = logger;
}

2. 匹配Service Bus扩展包与函数运行模式 #

• In-Process模式：确保安装Microsoft.Azure.WebJobs.Extensions.ServiceBus（推荐5.x版本），该模式下使用[FunctionName]特性是正确的。
• Isolated进程模式：需安装Microsoft.Azure.Functions.Worker.Extensions.ServiceBus（6.x+版本），同时在Program.cs中添加Service Bus服务配置：

var host = new HostBuilder()
    .ConfigureFunctionsWorkerDefaults()
    .ConfigureServices(services =>
    {
        services.AddServiceBus();
    })
    .Build();

host.Run();

3. 切换消息接收参数类型 #

改用ServiceBusReceivedMessage接收消息，手动解析内容，避免自动绑定的编码或格式问题：

public void Run(
    [ServiceBusTrigger("pending-player-custom-id", Connection = "AzureServiceBus")] 
    ServiceBusReceivedMessage message
)
{
    // 根据实际消息编码调整解析方式
    string myQueueItem = message.Body.ToString();
    _log.LogInformation($"C# ServiceBus queue trigger function processed message: {myQueueItem}");
}

4. 验证连接字符串配置 #

• 本地开发：检查local.settings.json中AzureServiceBus配置项为完整的Service Bus连接字符串：

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "AzureServiceBus": "Endpoint=sb://your-servicebus-name.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=your-access-key"
  }
}

• Azure部署：确认函数应用的配置 > 应用程序设置中已添加相同的连接字符串。

5. 统一消息内容编码 #

通过Service Bus Explorer发送消息时，选择UTF-8编码，确保消息内容与字符串绑定的编码要求一致。

内容的提问来源于stack exchange，提问作者Bilal Akil