如何在 C 中使用 ValueTask#

利用 C# 中的 ValueTask，避免在从异步方法返回任务对象时进行分配

异步编程已经使用了相当长一段时间。近年来，随着异步和等待关键字的引入，它变得更加强大。您可以利用异步编程来提高应用程序的响应能力和吞吐量。

C# 中异步方法的建议返回类型是 Task。如果要编写返回值的异步方法，则应返回 Task<T>。如果要编写事件处理程序，可以改为返回 void。在 C# 7.0 之前，异步方法可以返回 Task、Task<T> 或 void。从 C# 7.0 开始，异步方法还可以返回 ValueTask（作为 System.Threading.Tasks.Extensions 包的一部分提供）或 ValueTask<T>。本文讨论了如何在 C# 中使用 ValueTask。

为什么我应该使用 ValueTask？

任务表示某个操作的状态，即操作是否已完成、是否取消等。异步方法可以返回 Task 或 ValueTask。

现在，由于 Task 是引用类型，因此从异步方法返回 Task 对象意味着每次调用该方法时都要在托管堆上分配该对象。因此，使用 Task 时需要注意的一点是，每次从方法返回 Task 对象时，都需要在托管堆中分配内存。如果方法正在执行的操作的结果立即可用或同步完成，则不需要此分配，因此成本会变得高昂。

这正是ValueTask的救星。ValueTask<T>提供了两个主要优点。首先，ValueTask<T>提高了性能，因为它不需要堆分配，其次，它既简单又灵活地实现。当结果立即可用时，通过从异步方法返回 ValueTask<T> 而不是 Task<T>，可以避免不必要的分配开销，因为此处的"T"表示结构，而 C# 中的结构是值类型（与 Task<T> 中的"T"相反，后者表示类）。

Task 和 ValueTask 表示 C# 中的两种主要的"可等待"类型。请注意，您无法阻止值任务。如果需要阻止，则应使用 AsTask 方法将 ValueTask 转换为任务，然后阻止该引用 Task 对象。

另请注意，每个值任务只能使用一次。此处的"消费"一词意味着 ValueTask 可以异步等待（等待）操作完成，或者利用 AsTask 将 ValueTask 转换为任务。但是，一个值任务只应使用一次，之后应忽略值任务<T>。

C# 中的值任务示例

假设您有一个返回 Task 的异步方法。您可以利用 Task.FromResult 创建 Task 对象，如下面给出的代码片段所示。

public Task<int> GetCustomerIdAsync()
{
    return Task.FromResult(1);
}

上面的代码片段不会创建整个异步状态机魔术，但它会在托管堆中分配一个 Task 对象。若要避免此分配，您可能希望改为利用 ValueTask，如下面给出的代码段所示。

public ValueTask<int> GetCustomerIdAsync()
{
    return new ValueTask(1);
}

以下代码段阐释了 ValueTask 的同步实现。

 public interface IRepository<T>
    {
        ValueTask<T> GetData();
    }

存储库类扩展 IRepository 接口并实现其方法，如下所示。

 public class Repository<T> : IRepository<T>
    {
        public ValueTask<T> GetData()
        {
            var value = default(T);
            return new ValueTask<T>(value);
        }
    }

下面介绍了如何从 Main 方法调用 GetData 方法。

static void Main(string[] args)
        {
            IRepository<int> repository = new Repository<int>();
            var result = repository.GetData();
            if(result.IsCompleted)
                 Console.WriteLine("Operation complete...");
            else
                Console.WriteLine("Operation incomplete...");
            Console.ReadKey();
        }

现在，让我们向存储库中添加另一个方法，这次是名为 GetDataAsync 的异步方法。以下是修改后的 IRepository 接口的外观。

public interface IRepository<T>
    {
        ValueTask<T> GetData();
        ValueTask<T> GetDataAsync();
    }

GetDataAsync 方法由 Repository 类实现，如下面给出的代码片段所示。

public class Repository<T> : IRepository<T>
    {
        public ValueTask<T> GetData()
        {
            var value = default(T);
            return new ValueTask<T>(value);
        }
        public async ValueTask<T> GetDataAsync()
        {
            var value = default(T);
            await Task.Delay(100);
            return value;
        }
    }

何时应在 C# 中使用 ValueTask？

尽管 ValueTask 提供了许多好处，但使用 ValueTask 代替 Task 需要一些权衡。ValueTask 是具有两个字段的值类型，而 Task 是具有单个字段的引用类型。因此，使用 ValueTask 意味着处理更多数据，因为方法调用将返回两个数据字段而不是一个字段。此外，如果等待返回 ValueTask 的方法，则该异步方法的状态机也会更大，因为在 Task 的情况下，它必须容纳包含两个字段的结构，而不是单个引用。

此外，如果异步方法的使用者使用 Task.WhenAll 或 Task.WhenAny，则在异步方法中使用 ValueTask<T> 作为返回类型可能会产生高昂的成本。这是因为您需要使用 AsTask 方法将 ValueTask<T> 转换为 Task<T>这将产生一个分配，如果首先使用了缓存的 Task<T>，则可以轻松避免这种分配。

这是经验法则。当您有一段始终是异步的代码时，即当操作不会立即完成时，请使用 Task。当异步操作的结果已经可用或已有缓存的结果时，请利用 ValueTask。无论哪种方式，您都应该在考虑 ValueTask 之前执行必要的性能分析。