如何使用 C# 中的 ValueTask

在 C# 中利用 ValueTask 避免从异步方法返回 Task 对象时分配

翻译自 Joydip Kanjilal 2020年7月6日 的文章 《How to use ValueTask in C#》(https://www.infoworld.com/article/3565433/how-to-use-valuetask-in-csharp.html)

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

C# 中异步方法的推荐返回类型是 Task。如果您想编写一个有返回值的异步方法,那么应该返回 Task<T>; 如果想编写事件处理程序,则可以返回 void。在 C# 7.0 之前,异步方法可以返回 TaskTask<T> 或 void。从 C# 7.0 开始,异步方法还可以返回 ValueTask(作为 System.Threading.Tasks.Extensions 包的一部分可用)或 ValueTask<T>。本文就讨论一下如何在 C# 中使用 ValueTask

要使用本文提供的代码示例,您的系统中需要安装 Visual Studio 2019。如果还没有安装,您可以在这里下载 Visual Studio 2019(https://visualstudio.microsoft.com/downloads/)。

在 Visual Studio 中创建一个 .NET Core 控制台应用程序项目

首先,让我们在 Visual Studio 中创建一个 .NET Core 控制台应用程序项目。假设您的系统中安装了 Visual Studio 2019,请按照下面描述的步骤在 Visual Studio 中创建一个新的 .NET Core 控制台应用程序项目。

  1. 启动 Visual Studio IDE。

  2. 点击 “创建新项目”。

  3. 在 “创建新项目” 窗口中,从显示的模板列表中选择 “控制台应用(.NET Core)”。

  4. 点击 “下一步”。

  5. 在接下来显示的 “配置新项目” 窗口,指定新项目的名称和位置。

  6. 点击 “创建”。

这将在 Visual Studio 2019 中创建一个新的 .NET Core 控制台应用程序项目。我们将在本文后面的部分中使用这个项目来说明 ValueTask 的用法。

为什么要使用 ValueTask ?

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

现在,由于 Task 是一个引用类型,从异步方法返回一个 Task 对象意味着每次调用该方法时都会在托管堆(managed heap)上分配该对象。因此,在使用 Task 时需要注意的一点是,每次从方法返回 Task 对象时都需要在托管堆中分配内存。如果你的方法执行的操作的结果立即可用或同步完成,则不需要这种分配,因此代价很高。

这正是 ValueTask 要出手相助的目的,ValueTask<T> 提供了两个主要好处。首先,ValueTask<T> 提高了性能,因为它不需要在堆(heap)中分配; 其次,它的实现既简单又灵活。当结果立即可用时,通过从异步方法返回 ValueTask<T> 代替 Task<T>,你可以避免不必要的分配开销,因为这里的 “T” 表示一个结构,而 C# 中的结构体(struct)是一个值类型(与 Task<T> 中表示类的 “T” 不同)。

C# 中 Task 和 ValueTask 表示两种主要的 “可等待(awaitable)” 类型。请注意,您不能阻塞(block)一个 ValueTask。如果需要阻塞,则应使用 AsTask 方法将 ValueTask 转换为 Task,然后在该引用 Task 对象上进行阻塞。

另外请注意,每个 ValueTask 只能被消费(consumed)一次。这里的单词 “消费(consume)” 是指 ValueTask 可以异步等待(await)操作完成,或者利用 AsTask 将 ValueTask 转换为 Task。但是,ValueTask 只应被消费(consumed)一次,之后 ValueTask<T> 应被忽略。

C# 中的 ValueTask 示例

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

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

上面的代码片段并没有创建整个异步状态机制,但它在托管堆(managed heap)中分配了一个 Task 对象。为了避免这种分配,您可能希望利用 ValueTask 代替,像下面给出的代码片段所示的那样。

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

下面的代码片段演示了 ValueTask 的同步实现。

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

Repository 类扩展了 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...");elseConsole.WriteLine("Operation incomplete...");Console.ReadKey();
}

现在让我们将另一个方法添加到我们的存储库(repository)中,这次是一个名为 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 意味着要处理更多的数据,因为方法调用将返回两个数据字段而不是一个。另外,如果您等待(await)一个返回 ValueTask 的方法,那么该异步方法的状态机也会更大,因为它必须容纳一个包含两个字段的结构体而不是在使用 Task 时的单个引用。

此外,如果异步方法的使用者使用 Task.WhenAll 或者 Task.WhenAny,在异步方法中使用 ValueTask<T> 作为返回类型可能会代价很高。这是因为您需要使用 AsTask 方法将 ValueTask<T> 转换为 Task<T>,这会引发一个分配,而如果使用起初缓存的 Task<T>,则可以轻松避免这种分配。

经验法则是这样的:当您有一段代码总是异步的时,即当操作(总是)不能立即完成时,请使用 Task。当异步操作的结果已经可用时,或者当您已经缓存了结果时,请利用 ValueTask。不管怎样,在考虑使用 ValueTask 之前,您都应该执行必要的性能分析。

ValueTask 是 readonly struct 类型,Task 是 class 类型。
相关链接:C# 中 Struct 和 Class 的区别总结。

作者 :Joydip Kanjilal 
译者 :技术译民
出品 :技术译站(https://ITTranslator.cn/)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/307650.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

一文弄懂Numpy中ndarray的维度(dimension)/轴数(axis/axes)问题

Numpy库的核心是ndarray&#xff0c;实际上就是N维数组&#xff08;N-dimensional array&#xff09;&#xff0c;关于这个数据对象的详细介绍&#xff0c;参考官方文档最为合适。有一点要注意的是&#xff0c;ndarray的内置方法只有30多个&#xff0c;常用的如求平均值可以写a…

leetcode337. 打家劫舍 III

一:题目 二:上码 /*** Definition for a binary tree node.* struct TreeNode {* int val;* TreeNode *left;* TreeNode *right;* TreeNode() : val(0), left(nullptr), right(nullptr) {}* TreeNode(int x) : val(x), left(nullptr), right(nullptr) {}*…

asp.net core 从 3.1 到 5.0

asp.net core 从 3.1 到 5.0Intro就在前几天&#xff0c;微软宣布了 .NET5 发布了 RC1 版本&#xff0c;这也意味着 .NET5 的开发基本稳定了&#xff0c;正式发布之前&#xff0c;不会再新增新的 Feature&#xff0c;只会专注于修复 BUG 提高稳定性。对于开发者来说&#xff0c…

二叉树的几道相似简单递归题

二叉树中递归的思想&#xff0c;在这本Leetbook中讲的很细了&#xff0c;这里不展开。下面是几道例题&#xff1a; 226. 翻转二叉树&#xff08;剑指 Offer 27. 二叉树的镜像&#xff09; 递归法前序遍历&#xff1a; class Solution:def invertTree(self, root: TreeNode) …

leetcoed123. 买卖股票的最佳时机 III

一&#xff1a;题目 二:上码 class Solution { public:/**思路:1.动态规划五步走1>:确定dp数组以及下标的含义因为题目给出至多完成两笔交易 那么我们一天的状态就有5种0 无操作1 第一次买入2 第一次卖出3 第二次买入4 第二次卖出dp[i][j] 表示的是在第i天 [0,4] 其中某个…

送福利 | 送书3本 ASP.NET Core 真机拆解

小编&#xff1a;最近.NET相关图书在多年沉寂后重新恢复&#xff0c;本书作者提供3本送给公众号粉丝&#xff0c;所以参与方式&#xff1a;文章下方留言&#xff0c;你可以聊聊.NET Core 这几年的发展给你的印象&#xff0c;你的感想&#xff0c;点赞最多的前5位获奖。活动截止…

二叉搜索树基础概念与经典题目(Leetcode题解-Python语言)

二叉搜索树&#xff0c;首先上定义&#xff1a; 节点的左子树只包含小于当前节点的数。节点的右子树只包含大于当前节点的数。所有左子树和右子树自身必须也是二叉搜索树。 而二叉搜索树最有用的性质就是&#xff0c;对其中序遍历可以得到一个递增的有序序列。更多的内容&…

异方差 的 BP检验 方法及原理详解

异方差 的 BP检验详解            文章目录 1. `BP`检验的步骤2. 场景示例步骤 ①步骤 ②BP检验,也称为Breusch-Pagan检验,是一种用于检验线性回归模型中异方差性(即误差项方差不恒定)的统计方法。该方法由Trevor S. Breusch和Adrian R. Pagan在1980年提出。 1.…

leetcode309. 最佳买卖股票时机含冷冻期

一&#xff1a;题目 二:上码 class Solution { public:/**思路:1.分析题意那么我们会有四种状态0 买入股票(或者说是之前就买入了股票但是也一直没有操作)1 卖出股票的状态一 两天前就卖出了股票 但是一直没有操作 2 卖出股票状态二 今天卖出股票3 冷冻期 持续一天2.动态规…

.NET Core 下使用 Exceptionless 记录日志

ExceptionLess是一套免费开源分布式系统日志收集框架&#xff0c;也是我无意中发现的&#xff0c;支持自己部署和平台托管的方式接入使用。ExceptionLess官网&#xff1a;https://exceptionless.comExceptionLess开源地址&#xff1a;https://github.com/exceptionless/Excepti…

高度平衡的二叉搜索树基础概念与经典题目(Leetcode题解-Python语言)

高度平衡的二叉搜索树&#xff08;平衡二叉树&#xff09;&#xff0c;定义见此Leetbook。简单来说&#xff0c;就是基于相同节点值构建出来的二叉搜索树中高度最小的&#xff0c;即为平衡二叉树&#xff08;不唯一&#xff09;。有 N 个节点的平衡二叉搜索树&#xff0c;它的高…

spring boot 中@Mapper和@Repository的区别

一:前言 Mapper和Repository是常用的两个注解&#xff0c;两者都是用在dao上&#xff0c;两者功能差不多&#xff0c;容易混淆&#xff0c;有必要清楚其细微区别&#xff1b; 二:区别 Repository需要在Spring中配置扫描地址&#xff0c;然后生成Dao层的Bean才能被注入到Serv…

你没有看错,爬网页数据,C# 也可以像 Jquery 那样

一&#xff1a;背景 1. 讲故事前段时间搞了一个地方性民生资讯号&#xff0c;资讯嘛&#xff0c;都是我抄你的&#xff0c;你抄官媒的&#xff0c;小市民都喜欢奇闻异事&#xff0c;所以就存在一个需求&#xff0c;如何去定向抓取奇闻异事的地方号上的新闻&#xff0c;其实做起…

leetcode300. 最长递增子序列

一:题目 二:上码 class Solution { public:/**思路:1.分析题意:我们在求取答案的过程中;我们的结果是动态的; 如果从某个数有一个递增序列 但是在这个数的后面又有一个数又可以是递增的 而且可能还比起长 2.动态规划五步走1>:确定dp数组的含义以及下标的含义dp[i] 表示的是…

链表基础概念与经典题目(Leetcode题解-Python语言)

所谓链表&#xff0c;就是由链节点元素组成的表&#xff0c;那什么是链节点呢&#xff1f;直接上定义&#xff1a; class ListNode:def __init__(self, val0, nextNone):self.val valself.next next很简单&#xff0c;链节点就是只记录自身的值 val&#xff0c;还有其指向的…

leetcode674. 最长连续递增序列

一:题目 二:上码 1:方法一贪心 class Solution { public:/**思路:1.贪心**/int findLengthOfLCIS(vector<int>& nums) {int ans 1;int count 1;for (int i 1; i < nums.size(); i) {if(nums[i] > nums[i-1]) {count;}else{count 1;//出现不连续的状态}if…

WPF 从 .net core 3.1 到 .net 5.0

WPF 从 .net core 3.1 到 .net 5.0Intro昨天更新了一个简单的 asp.net core webapi 项目&#xff0c;从 3.1 更新到了 5.0&#xff0c;今天更新一个 WPF 应用到 net 5.0项目文件更新首先项目文件中的 SDK 发生了变化&#xff0c;原来是 Microsoft.NET.Sdk.WindowsDesktop 更新后…

最小堆最大堆基础概念与经典题目(Leetcode题解-Python语言)

堆是一种特别的完全二叉树&#xff0c;符合以下两个定义即为堆&#xff1a; 1、完全二叉树&#xff1b; 2、每一个节点的值都必须大于等于或者小于等于其孩子节点的值。若是大于等于&#xff0c;即为最大堆&#xff0c;若是小于等于&#xff0c;即为最小堆。显然&#xff0c;…

进击吧! Blazor !第三期 信息交互

Blazor 是一个 Web UI 框架&#xff0c;可通过 WebAssembly 在任意浏览器中运行 .Net 。Blazor 旨在简化快速的单页面 .Net 浏览器应用的构建过程&#xff0c;它虽然使用了诸如 CSS 和 HTML 之类的 Web 技术&#xff0c;但它使用 C&#xff03;语言和 Razor 语法代替 JavaScrip…

leetcode718. 最长重复子数组

一:题目 二:上码 class Solution { public:/**思路:1.分析题意:1 2 3 6 7 41 2 6 7 4 3这里我们先遇到的1 2 但后来我们又遇见了6 7 4 那么我们的要的答案就是动态变化的2.动态规划五步走1>:确定dp数组以及下标的含义dp[i][j] 表示 以下标i-1结尾的A数组和以下标…