同步消费ValueTask触发CA2012警告的修复方法

CA2012: 除非ValueTask实例已完成，否则不应直接访问其结果。与Task不同，对ValueTask调用Result或GetAwaiter().GetResult()无法保证阻塞至操作完成。如果无法直接await该实例，请先检查其IsCompleted属性（若确认实例已完成，也可断言该属性为true）。

核心原因 #

ValueTask<T>是为高频异步路径优化的值类型，仅支持单次消费，且只有在IsCompleted == true（操作已同步完成）时，才能安全直接访问Result或调用GetAwaiter().GetResult()。如果实例处于未完成状态，直接访问结果既不保证阻塞等待操作完成，还可能触发未定义行为，这就是CA2012警告的触发原因。

针对当前场景有两种可行修复方案：

方案1：优先选择：异步实现（适配事件处理器场景） #

你提到方法在事件处理器中调用，这一场景完全不需要强行同步阻塞——事件处理器原生支持async void签名，这也是事件场景消费异步方法的标准实践，从根源规避同步等待的死锁风险，也不会触发警告。

// 将原同步方法改为异步实现
public async Task CreateListenKeyAsync()
{
    var result = await CreateSpotListenKeyAsync();

    if (result.Success)
    {
        using var document = JsonDocument.Parse(result.Data!);
        lock (_listenKeyLocker)
        {
            if (document.RootElement.TryGetProperty("listenKey", out var listenKeyElement))
            {
                ListenKey = listenKeyElement.GetString();
            }
        }
    }
}

// 定时器事件处理器使用async void签名，为事件场景合法写法
private async void OnKeepAliveTimerElapsed(object? sender, ElapsedEventArgs e)
{
    // 对应将其他同步调用的ListenKey相关方法也改为异步实现即可
    await RestApi.PingListenKeyAsync();
    await CreateListenKeyAsync();
}

方案2：强制同步等待场景的安全写法 #

如果存在硬约束无法修改为异步实现，就按照警告提示先判断完成状态：已完成时直接取结果，未完成时调用AsTask()将ValueTask转换为标准Task实例后再同步等待，转换后的Task可以保证正确的阻塞等待语义。

public void CreateListenKey()
{
    var valueTask = CreateSpotListenKeyAsync();
    CallResult<string> result;
    
    if (valueTask.IsCompletedSuccessfully)
    {
        // 已成功完成状态下直接取结果，无警告
        result = valueTask.Result;
    }
    else
    {
        // 未完成/已失败状态下转Task再同步等待，保证阻塞语义正确
        result = valueTask.AsTask().GetAwaiter().GetResult();
    }

    if (result.Success)
    {
        using var document = JsonDocument.Parse(result.Data!);
        lock (_listenKeyLocker)
        {
            if (document.RootElement.TryGetProperty("listenKey", out var listenKeyElement))
            {
                var listenKey = listenKeyElement.GetString();
                ListenKey = listenKey;
            }
        }
    }
}

注意事项 #

• ValueTask/ValueTask<T>是单次消费结构，上述写法保证了对返回的ValueTask实例只做一次状态判断和一次结果获取，不会出现重复消费的问题。
• 同步阻塞异步方法天生存在死锁风险（如UI线程、经典ASP.NET请求上下文下调用可能导致线程永久卡死），仅在确认无同步上下文死锁风险的场景使用该方案。

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