如何使用.NET SDK根据ID删除Azure Service Bus队列中的消息

不管是REST API还是官方.NET SDK，删除队列消息都需要两个必传参数：messageId（消息ID）和lockToken（锁令牌），不存在只靠消息ID直接删除的接口。你给出的REST API路径里也明确要求携带lockToken参数，这个令牌只能在接收消息并加锁的时候从服务端获取，无法提前生成或者仅通过消息ID查询得到。

具体实现逻辑为：先批量接收队列中的消息，匹配到对应消息ID的消息后，调用官方SDK的结算方法完成删除，完整实现代码如下：

using Azure.Messaging.ServiceBus;

async Task DeleteMessageByMessageId(string connectionString, string queueName, string targetMessageId)
{
    await using var serviceBusClient = new ServiceBusClient(connectionString);
    // 接收器默认使用PeekLock接收模式，接收后消息会被暂时锁定，主动结算才会从队列移除
    var receiver = serviceBusClient.CreateReceiver(queueName);
    
    try
    {
        // 单次拉取的最大消息数可根据队列实际消息量级调整
        var receivedMessages = await receiver.ReceiveMessagesAsync(maxMessages: 100);
        
        foreach (var message in receivedMessages)
        {
            if (message.MessageId.Equals(targetMessageId, StringComparison.OrdinalIgnoreCase))
            {
                // Complete方法底层会自动携带当前消息的LockToken发起删除请求
                await receiver.CompleteMessageAsync(message);
                Console.WriteLine($"已删除消息ID为 {targetMessageId} 的消息");
                return;
            }
        }
        
        Console.WriteLine($"未找到消息ID为 {targetMessageId} 的消息");
    }
    catch (ServiceBusException ex) when (ex.Reason == ServiceBusFailureReason.MessageLockLost)
    {
        Console.WriteLine("消息锁已过期，删除失败，请重试");
    }
    finally
    {
        await receiver.CloseAsync();
    }
}

注意事项 #

• Azure Service Bus的消息ID支持用户自定义，不保证全局唯一，若匹配到多条同ID的消息，上述代码只会删除第一条，可根据业务需求调整逻辑删除所有匹配项
• 如果队列消息量很大，可以循环拉取消息，直到遍历完所有消息或者找到目标消息
• 如果队列开启了会话功能，需要改用AcceptSessionAsync创建会话接收器才能正常接收消息
• 消息默认锁定时间为30秒，如果处理耗时较长可以调用RenewMessageLockAsync方法续约锁，避免锁过期导致删除失败

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