Unity 2022新特性：UniTask与destroyCancellationToken集成指南
项目地址: https://gitcode.com/gh_mirrors/un/UniTask 在Unity开发中，异步操作的生命周期管理一直是开发者面临的重要挑战。当MonoBehaviour被销毁时，如果仍有未完成的异步任务，可能会导致空引用异常或资源泄漏。Unity 2022引入的destroyCancellationToken机制与UniTask的结合，为解决这一问题提供了优雅的解决方案。本文将详细介绍如何在UniTask中集成和使用destroyCancellationToken，确保异步操作安全可靠地执行。
核心概念：CancellationToken与销毁生命周期
CancellationToken（取消令牌）是.NET中的一种机制，用于通知异步操作应该被取消。在Unity中，当一个MonoBehaviour被销毁时，我们希望所有关联的异步操作也随之取消，以避免内存泄漏和错误。UniTask通过扩展方法将destroyCancellationToken与MonoBehaviour的生命周期绑定，实现了这一需求。
UniTask提供了GetCancellationTokenOnDestroy扩展方法，该方法定义在src/UniTask/Assets/Plugins/UniTask/Runtime/UnityAsyncExtensions.MonoBehaviour.cs文件中：
public static UniTask StartAsyncCoroutine(this UnityEngine.MonoBehaviour monoBehaviour, Func<CancellationToken, UniTask> asyncCoroutine)
{
var token = monoBehaviour.GetCancellationTokenOnDestroy();
return asyncCoroutine(token);
}
集成步骤：从获取令牌到取消任务
1. 获取销毁取消令牌
在MonoBehaviour中，通过this.GetCancellationTokenOnDestroy()方法可以获取与该组件生命周期绑定的CancellationToken。当组件被销毁时，该令牌会自动触发取消。
using Cysharp.Threading.Tasks;
using UnityEngine;
public class Example : MonoBehaviour
{
private CancellationToken _destroyCancellationToken;
private void Awake()
{
_destroyCancellationToken = this.GetCancellationTokenOnDestroy();
}
}
2. 将令牌传递给UniTask
获取令牌后，将其传递给需要执行的UniTask方法。大多数UniTask异步方法都接受CancellationToken作为可选参数。
private async UniTask LoadResourceAsync()
{
try
{
// 使用销毁令牌取消异步操作
var resource = await Resources.LoadAsync<GameObject>("Prefab").ToUniTask(cancellationToken: _destroyCancellationToken);
// 处理资源加载完成后的逻辑
}
catch (OperationCanceledException)
{
// 处理任务取消的情况
Debug.Log("Resource loading was canceled due to object destruction.");
}
}
3. 注册取消回调
除了直接传递令牌外，还可以通过Register方法注册取消回调，在任务被取消时执行清理操作。UniTask提供了RegisterWithoutCaptureExecutionContext方法，该方法定义在src/UniTask/Assets/Plugins/UniTask/Runtime/CancellationTokenExtensions.cs文件中：
public static CancellationTokenRegistration RegisterWithoutCaptureExecutionContext(this CancellationToken cancellationToken, Action callback)
{
var restoreFlow = false;
if (!ExecutionContext.IsFlowSuppressed())
{
ExecutionContext.SuppressFlow();
restoreFlow = true;
}
try
{
return cancellationToken.Register(callback, false);
}
finally
{
if (restoreFlow)
{
ExecutionContext.RestoreFlow();
}
}
}
使用示例：
private void OnEnable()
{
_destroyCancellationToken.RegisterWithoutCaptureExecutionContext(OnDestroyed);
}
private void OnDestroyed()
{
Debug.Log("Object destroyed, cleaning up resources.");
// 执行清理操作
}
高级用法：令牌链接与超时控制
令牌链接
UniTask允许将多个CancellationToken链接在一起，实现更灵活的取消逻辑。例如，可以将destroyCancellationToken与一个超时令牌链接，实现"组件销毁或超时则取消"的逻辑：
var timeoutCts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(
_destroyCancellationToken,
timeoutCts.Token
);
try
{
await SomeLongRunningTask().WithCancellation(linkedCts.Token);
}
catch (OperationCanceledException ex)
{
if (timeoutCts.Token.IsCancellationRequested)
{
Debug.Log("Task timed out.");
}
else
{
Debug.Log("Task canceled due to object destruction.");
}
}
超时控制
UniTask提供了Timeout扩展方法，可以为异步操作设置超时时间，并自动取消超时的任务：
try
{
await SomeAsyncTask()
.WithCancellation(_destroyCancellationToken)
.Timeout(TimeSpan.FromSeconds(10));
}
catch (TimeoutException)
{
Debug.Log("Task timed out.");
}
catch (OperationCanceledException)
{
Debug.Log("Task canceled due to object destruction.");
}
常见问题与解决方案
问题1：任务未被正确取消
原因：可能是因为没有正确将CancellationToken传递给UniTask，或者在任务启动前组件已经被销毁。
解决方案：确保在启动异步任务前获取CancellationToken，并在任务执行过程中定期检查取消状态。
问题2：取消回调未执行
原因：可能是因为使用了错误的注册方法，或者在注册前令牌已经被取消。
解决方案：使用RegisterWithoutCaptureExecutionContext方法注册回调，并在组件的OnEnable方法中进行注册，确保在组件激活时注册回调。
问题3：内存泄漏
原因：即使任务被取消，如果没有正确清理资源，仍然可能导致内存泄漏。
解决方案：在OperationCanceledException捕获块中执行必要的资源清理操作，并使用UniTask的Forget()方法确保任务不会被意外保留。
最佳实践与注意事项
-
始终传递销毁令牌：对于所有与MonoBehaviour生命周期相关的异步操作，都应该传递
destroyCancellationToken，以确保组件销毁时任务能够被正确取消。 -
使用
StartAsyncCoroutine方法：UniTask提供的StartAsyncCoroutine方法会自动管理CancellationToken，是启动异步协程的推荐方式：
private void Start()
{
this.StartAsyncCoroutine(LoadResourceAsync);
}
-
避免在取消后访问已销毁对象：在任务取消后，避免访问可能已经被销毁的Unity对象，以免引发空引用异常。
-
合理使用
try/catch：对于可能被取消的异步操作，使用try/catch块捕获OperationCanceledException，并在其中执行必要的清理逻辑。
总结
UniTask与destroyCancellationToken的集成，为Unity异步操作的生命周期管理提供了强大而简洁的解决方案。通过本文介绍的方法，开发者可以确保异步任务在组件销毁时能够被正确取消，从而避免内存泄漏和运行时错误。
官方文档：docs/index.md UniTask源码：src/UniTask/Assets/Plugins/UniTask/Runtime/UniTask.cs CancellationToken扩展：src/UniTask/Assets/Plugins/UniTask/Runtime/CancellationTokenExtensions.cs
掌握这一技术，将有助于提升Unity项目的稳定性和性能，为用户提供更流畅的游戏体验。如果你在使用过程中遇到问题，可以查阅UniTask的官方文档或在社区寻求帮助。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
