使用 Awaitable 进行异步编程的简介

Awaitable 类是自定义 Unity 类型，可在 C# 异步编程模型中等待并用作异步返回类型。Unity 的大多数异步 API 都支持 async 和 await 模式，包括：

• Unity 协程：NextFrameAsync、WaitForSecondsAsync、EndOfFrameAsync、FixedUpdateAsync
• 切换到后台线程或主线程
• 继承自 AsyncOperation 的所有类型
• Unity 事件
• 异步 GPU 回读

您可以在自己的代码中将 Awaitable 类与 await 运算符结合使用，并作为 async 返回类型使用，如下所示：

async Awaitable<List<Achievement>> GetAchievementsAsync()
{
    var apiResult = await SomeMethodReturningATask(); // or any await-compatible type
    List<Achievement> achievements = JsonConvert.DeserializeObject<List<Achievement>>(apiResult);
    return achievements;
}

async Awaitable ShowAchievementsView()
{
    ShowLoadingOverlay();
    List<Achievement> achievements = await GetAchievementsAsync();
    HideLoadingOverlay();
    ShowAchivementsList(achievements);
}

Awaitable 与 .NET Task 相比

Awaitable 旨在为 Unity 项目中的异步代码提供更有效的 .NET Task 替代方案。与 Task 相比，Awaitable 的效率存在一些重要限制。

最重要的限制是 Awaitable 实例会被池化以限制分配。请参考以下示例：

class SomeMonoBehaviorWithAwaitable : MonoBehavior
{
    public async void Start()
    {
        while(true)
        {
            // do some work on each frame
            await Awaitable.NextFrameAsync();
        }
    }
}

如果不池化，此示例中的每个 MonoBehavior 实例都会每帧分配一个 Awaitable 对象，从而增加垃圾回收器工作量并降低性能。为了缓解此问题，Unity 会在等待 Awaitable 对象后将其返回到内部 Awaitable 池。

重要提示：Awaitable 实例池意味着在一个 Awaitable 实例上多次 await 永远不会安全。这样做可能会导致未定义的行为，例如异常或死锁。

Awaitable 与 .NET ValueTask 相比

.NET ValueTask<TResult> 具有与 Awaitable 相同的一些主要优点和限制。ValueTask 的典型推荐用途是用于大多数时间预期同步完成的异步工作负载。有关更多信息，请参阅了解使用 ValueTask 的原因、方式和时间。

Awaitable、Task 和 ValueTask 汇总

下表总结了 Unity 的 Awaitable 类与 .NET Task 和 ValueTask 之间的功能比较：

何时使用 Awaitable 而非 Task 或 ValueTask

API 的选择取决于异步代码的性能配置文件，但一般情况下：

• 当您需要多次等待或同时等待多个消耗者时，Task 是唯一的选择。
• 如果您的高吞吐量异步代码大多数时间都是同步完成的，ValueTask 是不错的选择。
• Awaitable 在以下情况下是不错的选择：
  • 您无需多次等待您的方法并期望基本上异步完成。
  • 您希望异步任务具有对特定于 Unity 的概念（如主线程以及 Update 和 FixedUpdate 循环）的内置支持。

Awaitable 相比于基于迭代器的协程

Awaitable 协程通常比基于迭代器的协程更加高效，尤其是在迭代器返回非 null 值的情况下，例如 WaitForFixedUpdate。

但是，当同时运行许多 Awaitable 协程时，协程的性能优势会降低。例如，在 while 循环中等待 Awaitable.NextFrameAsync 的 MonoBehaviour（如前一个代码示例所示）如果附加到大型项目中的每个游戏对象，可能会导致性能问题。

其他资源

• Awaitable 完成和延续
• Awaitable 代码示例参考