CA2012:正确使用 ValueTask

原因

从成员调用中返回的 ValueTask 实例的使用方式可能导致异常、损坏或性能不佳。

规则说明

从成员调用中返回的 ValueTask 实例旨在直接等待。 多次尝试使用 ValueTask 或在已知完成之前直接访问其结果可能会导致异常或损坏。 忽略此类 ValueTask 可能指示出现功能 Bug，还可能降低性能。

如何解决冲突

通常情况下，应直接等待 ValueTask，而不是将其丢弃或存储到其他位置（如局部变量或字段）。

何时禁止显示警告

对于从任意成员调用返回的 ValueTask 对象，调用方需要假设 ValueTask 必须使用一次（例如等待）并且仅使用一次。 但是，如果开发人员还控制被调用的成员并对其实现情况有全面了解，则开发人员可能知道可禁止显示警告，例如，如果返回 ValueTask 始终包装 Task 对象。

Example

public class NumberValueTask
{
    public async ValueTask<int> GetNumberAsync()
    {
        await Task.Delay(100);
        return 123;
    }

    public async Task UseValueTaskIncorrectlyAsync()
    {
        // This code violates the rule,
        // because ValueTask is awaited multiple times
        ValueTask<int> numberValueTask = GetNumberAsync();

        int first = await numberValueTask;
        int second = await numberValueTask; // <- illegal reuse

        // ...
    }

    // This code satisfies the rule.
    public async Task UseValueTaskCorrectlyAsync()
    {
        int first = await GetNumberAsync();
        int second = await GetNumberAsync();

        // ..
    }

    public async Task UseValueTaskAsTaskAsync()
    {
        ValueTask<int> numberValueTask = GetNumberAsync();

        Task<int> numberTask = numberValueTask.AsTask();

        int first = await numberTask;
        int second = await numberTask;

        // ...
    }
}

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA2012
// The code that's violating the rule is on this line.
#pragma warning restore CA2012

若要对文件、文件夹或项目禁用该规则，请在none中将其严重性设置为 。

[*.{cs,vb}]
dotnet_diagnostic.CA2012.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅

• 可靠性规则