在ServiceBusTrigger中访问FunctionContext.RetryContext触发空引用异常

问题描述 #

我尝试在ServiceBusTrigger（服务总线队列）中获取重试次数，代码如下：

using Microsoft.Azure.Functions.Worker;

[Function("SyncQueue")]
public async Task HandleSyncEvent([ServiceBusTrigger("sync-events", Connection = "ServiceBus-ConnectionString")] string syncEvent, FunctionContext context)
{
   var retryCount = context.RetryContext?.RetryCount ?? 0;
   if (retryCount > 0) {}
}

但发现RetryContext不为null时，访问其RetryCount、MaxRetryCount属性仍会抛出NullReferenceException。请问能否在无重试场景下不通过try..catch来解决该问题？

堆栈信息：

System.NullReferenceException
  HResult=0x80004003
  Message=Object reference not set to an instance of an object.
  Source=Microsoft.Azure.Functions.Worker.Grpc
  StackTrace:
   at Microsoft.Azure.Functions.Worker.Grpc.GrpcRetryContext.get_RetryCount()
   at cse.Functions.HandleSyncQueue.<HandleSyncEvent>d__2.MoveNext() in C:\git\backend\services\src\Synchronization\cse.Functions\HandleSyncQueue.cs:line 26

解决方案 #

这是因为GrpcRetryContext的内部实现存在问题：即便RetryContext实例不为null，其内部存储重试次数的字段可能并未初始化，直接访问属性会触发空引用异常。可以通过以下两种方式在无重试场景下避免使用try/catch：

方式1：反射检查内部字段 #

通过反射获取GrpcRetryContext内部的_retryCount字段，判断是否初始化后再取值：

using System.Reflection;
using Microsoft.Azure.Functions.Worker;

[Function("SyncQueue")]
public async Task HandleSyncEvent([ServiceBusTrigger("sync-events", Connection = "ServiceBus-ConnectionString")] string syncEvent, FunctionContext context)
{
    int retryCount = 0;
    var retryContext = context.RetryContext;
    if (retryContext != null)
    {
        var retryCountField = retryContext.GetType().GetField("_retryCount", BindingFlags.NonPublic | BindingFlags.Instance);
        if (retryCountField != null && retryCountField.GetValue(retryContext) is int count)
        {
            retryCount = count;
        }
    }

    if (retryCount > 0)
    {
        // 处理重试逻辑
    }
}

方式2：封装扩展方法统一处理 #

自定义扩展方法，封装安全获取重试次数的逻辑，避免重复代码：

using System.Reflection;
using Microsoft.Azure.Functions.Worker;

public static class FunctionContextExtensions
{
    private static readonly FieldInfo? _retryCountField = typeof(RetryContext)
        .Assembly.GetType("Microsoft.Azure.Functions.Worker.Grpc.GrpcRetryContext")?
        .GetField("_retryCount", BindingFlags.NonPublic | BindingFlags.Instance);

    public static int GetSafeRetryCount(this FunctionContext context)
    {
        var retryContext = context.RetryContext;
        if (retryContext == null || _retryCountField == null)
        {
            return 0;
        }

        var value = _retryCountField.GetValue(retryContext);
        return value is int count ? count : 0;
    }
}

使用时直接调用扩展方法：

[Function("SyncQueue")]
public async Task HandleSyncEvent([ServiceBusTrigger("sync-events", Connection = "ServiceBus-ConnectionString")] string syncEvent, FunctionContext context)
{
    var retryCount = context.GetSafeRetryCount();
    if (retryCount > 0)
    {
        // 处理重试逻辑
    }
}

补充说明 #

该问题属于Microsoft.Azure.Functions.Worker.Grpc包的实现缺陷，后续版本可能会修复。如果不想依赖反射，也可以尝试升级到最新版的Microsoft.Azure.Functions.Worker和Microsoft.Azure.Functions.Worker.Extensions.ServiceBus包，查看是否已解决该问题。

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