Unity 2023.1 引入 Awaitable 类

2022 年 5 月，Alexandre Mutel 和 Kristyna Hougaard 在她们的主贴“Unity 和 .NET，下一部是是怎么样的？”中组阁。 Unity 打算选用很多 .NET 的用途，以及选用 async-await 的便于性。还，Unity 或许时未没有其保证。在Unity 2023.1 alphaios版本中，转化了Awaitable类，为书写异步编号供给了很多将会。

等待方法

在整节课中，我不想会更加深入分析在就其实在官网 Unity 表格含有十分表述的的方法。二者相等异步守候关于 。

Awaitable.WaitForSecondsAsync() 允许的您处理任意的网游时。与实时公交继续执行处理的 Task.Delay() 不同的。为了能帮阐发文化差异，稍后我将在代码怎么用块中给予这个小范本。

 private void Start() { Time.timeScale = 0; StartCoroutine(RunGameplay()); Task.WhenAll( WaitWithWaitForSecondsAsync(), WaitWithTaskDelay()); } private IEnumerator RunGameplay() { yield return new WaitForSecondsRealtime(5); Time.timeScale = 1; } private async Task WaitWithWaitForSecondsAsync() { await Awaitable.WaitForSecondsAsync(1); Debug.Log("Waiting WithWaitForSecondsAsync() ended."); } private async Task WaitWithTaskDelay() { await Task.Delay(1); Debug.Log("Waiting WaitWithTaskDelay() ended."); }

在这样的实例中，在 Start() 方式步骤开使时，施用 Time.timeScale 止住传奇日期。想要做出实验报告，将在 RunGameplay() 方式步骤中施用 Coroutine 在 5 秒后还原其的流程。再，你们开机启动3个五秒 待方式步骤。的施用 Awaitable.WaitForSecondsAsync()，另的施用 Task.Delay()。五s后，你们将在抑制台中看到三条新闻“Waiting WaitWithTaskDelay() ended”。 5 秒后，将冒出新闻“Waiting WaitWithTaskDelay() ended”。

还“添加了同一非常方便的具体方法，让您在 Unity 的基本性播放量器循坏中越来越敏锐。同旁内角的贷款用途从明称中就很清析，但是相对应于同旁内角在便用 Coroutines 时的归纳推理：

• EndOfFrameAsync()
• 固定更新异步（）
• NextFrameAsync()

若您是协程的客户，我建立您本身应力测试看看，尽可能最好地解释。

还放入半个种办法 Awaitable.FromAsyncOperation() 以向后兼容旧 API AsyncOperation。

使用 destroyCancellationToken 属性

安全使用协程的方便中的一个是，如器件被和谐除或禁止使用，他们会自行中断。在 Unity 2022.2 中，MonoBehaviour 添加图片了 destroyCancellationToken 的使用属性，能接受您在另一半删出时中断异步制定。请必须说出，能够 CancellationToken 更改来中断每日任务会带来 OperationCanceledException。如跳转方案不回退 Task 或 Awaitable，则应捕捉此异常的。

 private async void Awake() { try { await DoAwaitAsync(); } catch (OperationCanceledException) { } } private async Awaitable DoAwaitAsync() { await Awaitable.WaitForSecondsAsync(1, destroyCancellationToken); Debug.Log("That message won't be logged."); } private void Start() { Destroy(this); }

还有样例中，男朋友在 Start() 方智即消毁，但还有之间，Awake() 采取行动开机 DoAwaitAsync() 的完成。系统命令 Awaitable.WaitForSecondsAsync(1, destroyCancellationToken) 稍候 1 秒，然而应该是输出精度报道“That message won't be logged”。正是因为男朋友被马上册除，因此 destroyCancellationToken 利用扔出 OperationCanceledException 来中断全链的完成。这个，destroyCancellationToken 就避免了我们的半自动加入 CancellationToken 的纠纷。

所以我们都还在继续应该这样的做，比如，在相亲对象停掉时停掉施行。我举个典例。

 using System; using System.Threading; using UnityEngine; public class Example : MonoBehaviour { private CancellationTokenSource _tokenSource; private async void OnEnable() { _tokenSource = new CancellationTokenSource(); try { await DoAwaitAsync(_tokenSource.Token); } catch (OperationCanceledException) { } } private void OnDisable() { _tokenSource.Cancel(); _tokenSource.Dispose(); } private static async Awaitable DoAwaitAsync(CancellationToken token) { while (!token.IsCancellationRequested) { await Awaitable.WaitForSecondsAsync(1, token); Debug.Log("This message is logged every second."); } } }

在此种方法下，只需挂起此 MonoBehaviour 的喜欢的人出于浏览器点击情形，还是会运送信息“此信息每秒记录表一些”。该喜欢的人能能倒闭并又一次浏览器点击。

一段编码也许看了 是过多的。 Unity 就已经含盖众多以便于的生产工具，比如 Coroutines 和 InvokeRepeating()，行让您更不累地执行力比如主线任务。但这只一款食用举例。我也当我们只治理 Awaitable。

使用 Application.exitCancellationToken 属性

在 Unity 中，只不过在导出器中取消播放电影传统模式后，异步形式的执行程序也不能会自愿变慢。叫小编在工程项目中增多个相仿的角本。

 using System.Threading.Tasks; using UnityEngine; public static class Boot { [RuntimeInitializeOnLoadMethod] public static async Awaitable LogAsync() { while (true) { Debug.Log("This message is logged every second."); await Task.Delay(1000); } } }

此时样例中，切换桌面到插放形式后，将向把控台输入提醒“此提醒每秒记录表一回”。纵使抬起插放图标，它也会不断输入。在你这个事列中，的使用 Task.Delay() 而而不 Awaitable.WaitForSecondsAsync()，毕竟于这儿，是为了提示操作，迟缓而不网游时间段反而是立即要求的。

近似于 destroyCancellationToken，我都可以操作 Application.exitCancellationToken，它会在下线播发形式时突然中断异步最简单的方法的履行。我会修复工具角本。

 using System.Threading.Tasks; using UnityEngine; public static class Boot { [RuntimeInitializeOnLoadMethod] public static async Awaitable LogAsync() { var cancellationToken = Application.exitCancellationToken; while (!cancellationToken.IsCancellationRequested) { Debug.Log("This message is logged every second."); await Task.Delay(1000, cancellationToken); } } }

现如今游戏脚本将按预料来执行。

与事件函数一起使用

在 Unity 中，一系致死案涵数可是协程，列举 Start、OnCollisionEnter 或 OnCollisionExit。可是从Unity 2023.1开使，都会是Awaitable了，有Update()、LateUpdate，有的OnDestroy()。

应审慎实用这些，所以不用办理等等这些的异步进行。随后，谈谈有以下源代码：

 private async Awaitable Awake() { Debug.Log("Awake() started"); await Awaitable.NextFrameAsync(); Debug.Log("Awake() finished"); } private void OnEnable() { Debug.Log("OnEnable()"); } private void Start() { Debug.Log("Start()"); }

在抑制台中，他们将到接下来結果：

 Awake() started OnEnable() Start() Awake() finished

还值得购买切记的是，当异步二维码仍在运行时，MonoBehaviour 使用价值虽然单机游戏文本有可能不复长期存在。在这样情况下下：

 private async Awaitable Awake() { Debug.Log(this != null); await Awaitable.NextFrameAsync(); Debug.Log(this != null); } private void Start() { Destroy(this); }

在下一帧中，MonoBehaviour 被作出已删除文件。在操控台中，我们公司将取得以上最终：

 True Flase

这也可中用 OnDestroy() 具体方法步骤。比如使具体方法步骤异步，则应考虑到在 await 语句后会，MonoBehaviour 已被即为已清空。当因素实际上被清空时，多个处在其上的 MonoBehaviours 的办公这时可能性难以没问题办公。

最该特别留意的是，在用恶性事件变量时，介绍完成先后次序非常重要要。异步代码是什么可以是不会按您能够的先后次序完成，在设计的概念按键精灵脚本时必须不忘初心这一些。

等待事件函数捕获所有类型的异常

划得来准备的是，可等到致死案指数函数猎取每个种类的发现问题，这应该是交通意外的。我原一位她们只猎取 OperationCanceledExceptions，这会更故作用。可猎取每个种类的发现问题令鸟卵不适感合于此采用。相左，您能启动异步措施并人工机械猎取必要性的qq消息，如前边的例子图示。

 private async void Awake() { try { await DoAwaitAsync(); } catch (OperationCanceledException) { } } private async Awaitable DoAwaitAsync() { await Awaitable.WaitForSecondsAsync(1, destroyCancellationToken); Debug.Log("That message won't be logged"); } private void Start() { Destroy(this); }

担心零部件在加载时就可以删掉除，之所以 DoAwaitAsync() 的程序执行将被终止。信息内容“该信息内容不要被记录查询”将不要展现在把握台中。必须 OperationCanceledException() 执行死刑获，因此各种错误能够以被抛到。

我祝愿这一种说辞现在会取到改掉。到目前为止，实用错过惨案函数值并不安全保障。

跨线程自由移动

大家都知道，其他对这款老游戏客体和 MonoBehaviours 的实操都只充许在任务程中开展。但是都要开展一大批来计算，这也许会出现这款老游戏卡顿。尽量在任务程之中完成它是。 Awaitable 保证了有两种方案，BackgroundThreadAsync() 和 MainThreadAsync()，它是充许走出任务程并取到任务程。我将保证另一个事列。

 private async Awaitable DoAwaitAsync(CancellationToken token) { await Awaitable.BackgroundThreadAsync(); Debug.Log($"Thread: {Thread.CurrentThread.ManagedThreadId}"); Thread.Sleep(10000); await Awaitable.MainThreadAsync(); if (token.IsCancellationRequested) { return; } Debug.Log($"Thread: {Thread.CurrentThread.ManagedThreadId}"); gameObject.SetActive(false); await Awaitable.BackgroundThreadAsync(); Debug.Log($"Thread: {Thread.CurrentThread.ManagedThreadId}"); }

在这儿里，当措施运行时，它会就能到的双倍的线程。在等你我将你这个双倍线程的id工作输出到操作台。它是不会相等1，所以1是核心程。

其次线程被解除冻结资金 10 秒（Thread.Sleep(10000)），仿真多运算。倘若您在主线剧情程中程序执行力此实际方法，棋牌游戏将在其程序执行力阶段显现解除冻结资金。但在在这种症状下，凡事都接着比较稳定地作业。您能够在这个运算中安全使用 CancellationToken 来变慢不用要的实际方法。

往后，当我们转换回核心任务程。现代任何的 Unity 模块都在以从新运行了。随后，在本身症状下，停止使用一两个游戏游戏构造函数，如找不到核心任务程是不会已经才能做到的。

结论

便是，Unity 2023.1 中导入的新 Awaitable 类为制作师作为了许多创作异步源代码的可能性，于是更更容易创造回应式和高耐磨性的游戏游戏。 Awaitable 类比如三种期待最简单的步骤，譬如 WaitForSecondsAsync()、EndOfFrameAsync()、FixedUpdateAsync() 和 NextFrameAsync()，他们最简单的步骤在 Unity 的大多投放器间歇中作为了更广的机灵性。 destroyCancellationToken 和 Application.exitCancellationToken 的特性还作为一种在男朋友删除图片或撤销投放的模式时为止异步执行命令的便捷化最简单的步骤。

必须 留意的是，虽 Awaitable 类给出了了种在 Unity 中调用异步源代码的新具体方法，但它应有与 Coroutines 和 InvokeRepeating 等其余 Unity 器具切合选择才高达最加效率。与此同时，了解到 async-await 的框架知识基础和其可以为传奇游戏开发设计具体步骤给我们的坏处也非常重要，这类提高了程度和响应的程度。

总来看之，Awaitable 类是 Unity 开拓员的强大的方式，但应谨小慎微的适用，并与其它 Unity 方式和什么概念配合的适用才到达佳视觉效果。重要的的是要对其采取疲劳试验以更好的地熟悉其系统和仅限性。