本地配置带ServiceBusTrigger的Azure函数遇连接字符串错误求解

问题根源 #

1. ServiceBusTrigger特性的Connection属性值是配置键名，不是指向另一个配置键的别名——绑定系统会直接读取该键对应的值作为Service Bus连接字符串，而非去查找其他配置项。
2. 本地调试时，Azure Functions绑定系统默认仅读取local.settings.json的Values节点配置，不会自动加载appsettings.json（除非自定义配置解析逻辑）。

方案1：直接配置local.settings.json（最简便，推荐本地调试使用） #

修改local.settings.json，将ServiceBus键的值替换为完整的Service Bus连接字符串：

{
  "IsEncrypted": false,
  "Values":
  {
    "AzureWebJobsStorage": "UseDevelopmentStorage=false",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "ServiceBus": "Endpoint=sb://你的服务总线命名空间.servicebus.windows.net/;SharedAccessKeyName=你的密钥名称;SharedAccessKey=你的密钥值"
  }
}

函数代码保持修改后的版本即可：

[FunctionName("MyFunction")]
public void Run([ServiceBusTrigger("MyQueue", Connection = "ServiceBus")]string myQueueItem, ILogger log)
{
    log.LogInformation($"C# ServiceBus queue trigger function processed message: {myQueueItem}");
}

方案2：使用appsettings.json（适配多环境配置场景） #

如果坚持要从appsettings.json读取连接字符串，需要手动让绑定系统识别自定义配置源，步骤如下：

1. 保留已配置的appsettings.json和复制到输出目录的设置
2. 修改Startup.cs，将appsettings中的连接字符串注入到绑定系统可识别的配置中：

[assembly: FunctionsStartup(typeof(Startup))]
namespace MyFunc
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            var context = builder.GetContext();
            // 从appsettings读取连接字符串
            var serviceBusConnStr = context.Configuration["ServiceBusConnectionString"];
            // 将连接字符串注入到配置字典，让绑定系统能找到"ServiceBus"键的值
            context.Configuration["ServiceBus"] = serviceBusConnStr;
        }

        public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
        {
            var context = builder.GetContext();

            builder.ConfigurationBuilder
                    .AddJsonFile(Path.Combine(context.ApplicationRootPath, "appsettings.json"), optional: true, reloadOnChange: false)
                    .AddJsonFile(Path.Combine(context.ApplicationRootPath, $"appsettings.{context.EnvironmentName}.json"), optional: true, reloadOnChange: false);
        }
    }
}

3. 此时local.settings.json中的ServiceBus键可移除，或保留但会被Startup中的代码覆盖。

对之前错误的说明 #

• 最初的错误：将ServiceBus键的值设为ServiceBusConnectionString，绑定系统会直接把这个字符串当成连接字符串解析，而非去查找同名配置项，因此报错。
• 后续添加appsettings后的问题：绑定系统的配置解析逻辑优先于Startup执行，即使Startup能读到appsettings中的值，绑定系统初始时仍无法获取到该配置，导致报错。

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