.NET5 Azure Functions Service Bus Trigger自定义序列化及MessageReceiver获取问题

前置依赖检查 #

首先确认项目已安装正确版本的依赖包：

• Microsoft.Azure.Functions.Worker ≥ 1.8.0
• Microsoft.Azure.Functions.Worker.Extensions.ServiceBus ≥ 5.0.0
• Azure.Messaging.ServiceBus ≥ 7.10.0

问题1：MessageReceiver类型绑定失败 #

原因 #

.NET5 Azure Functions采用进程外（Isolated Worker）运行模型，和传统进程内模型不同，不支持直接绑定MessageReceiver类型，该类型为进程内模型专属类型。

解决方法 #

• 如需对消息执行完成、死信、延长锁等操作，会话启用场景绑定ServiceBusSessionMessageActions类型，非会话场景绑定ServiceBusMessageActions类型即可实现所有MessageReceiver的消息操作能力
• 如需获取原始消息的元数据、锁令牌、原始内容等信息，直接绑定ServiceBusReceivedMessage类型即可

问题2：自定义类型反序列化报错 #

原因 #

进程外模型的默认输入转换器对复杂类型反序列化存在约束，常见触发原因：

• 发送消息时未设置ContentType为application/json，转换器无法识别序列化格式
• 自定义类型中存在无法自动反序列化的字段（如你代码中的object类型Body属性，默认序列化器无法反序列化未知结构的object对象）
• 枚举类型未配置对应序列化规则，无法匹配字符串/数值格式的枚举值

解决方法 #

方案一（推荐，可控性最高）：手动反序列化

先绑定原始消息类型，业务代码中自行完成反序列化操作，示例代码：

[Function(nameof(Run))] 
public async Task Run(
    [ServiceBusTrigger("queuename", IsSessionsEnabled = true, Connection = "ServiceBusConnectionString")] ServiceBusReceivedMessage rawMessage,
    ServiceBusSessionMessageActions sessionActions,
    FunctionContext context)
{
    // 手动反序列化，可自行配置序列化规则
    var queueItem = JsonSerializer.Deserialize<QueueMessagePayload>(rawMessage.Body, new JsonSerializerOptions
    {
        Converters = { new JsonStringEnumConverter() },
        PropertyNameCaseInsensitive = true
    });

    // 业务逻辑实现
    // 示例：完成消息消费
    await sessionActions.CompleteMessageAsync(rawMessage);
}

方案二：配置后直接绑定自定义类型

需要同步修改消息发送逻辑和自定义类型定义：

1. 调整自定义类型定义，替换object类型属性为JsonElement，配置枚举序列化规则，保留公共无参构造函数：

[Serializable]
public class QueueMessagePayload
{
    [JsonConverter(typeof(JsonStringEnumConverter))]
    public ActionEnum Action { get; set; }
    // 替换object为JsonElement，可按需解析为对应类型
    public JsonElement Body { get; set; }
    // 保留公共无参构造函数
    public QueueMessagePayload(){}
}

2. 发送Service Bus消息时，显式设置消息的ContentType属性为application/json。

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