Unity中【UniTask异步流程】如何进行【步骤分段】、【步骤撤销】、【步骤跳转】、【取消异步任务】

news/2024/10/22 7:30:51/

一、UniTask和Task

UniTask是Unity中的Task实现，Task是C#中实现异步操作的一个模块(类)。UniTask与Task有着同样的使用思路（使用习惯，常用API等），可以说UniTask是借鉴Task而开发出来的。

二、需求的来源

以前有一个实验，操作就是点击物体，执行动画，点击物体，执行动画…如此子子孙孙无穷循环，直到地球爆炸（实验结束）。

2.1 原来的脚本

于是很容易就用UniTask的await把所有操作连成一片，写在一个脚本里，甚至一整个实验就一个脚本。

比如下面：

1）、面板参数定义

面板用到的参数全部释放在Inspector上面，代码的话带上注释和空格将近1800行
在这里插入图片描述

2）、异步流程的组织

操作流程的话，写在一个异步方法里，浩浩荡荡写了上千行…写起来倒是比较滑溜了，但是调试和复用的话，就有点…
在这里插入图片描述
在这里插入图片描述

2.2 要改造成什么样

如果用户说他要【上一步】、【下一步】和【跳步】
思路：把一串流程按照操作逻辑分块，不同的块编一个号，放到一个执行列表里面。

1）、从前的脚本是这样：

/// <summary>
/// 主流程：所有流程连成一片，无法分步执行
/// </summary>
/// <returns></returns>
public async UniTask Flow()
{//第一步await UniTask.Delay(1000);//...//第二步await UniTask.Delay(1000);//...//第三步await UniTask.Delay(1000);//...//...//第N步await UniTask.Delay(1000);//...
}

2） 、分块思路

  • （1）定义一个列表StepInfosList，用来装载要执行的步骤。
    /// <summary>/// 步骤信息表：系列化到面板，用于调试和观察，后期执行/// </summary>[Header("步骤信息表")]public List<StepInfo> StepInfosList = new List<StepInfo>();

每一个节点StepInfo的结构如下：
在这里插入图片描述

3） 、分块后的脚本

/// <summary>
/// 步骤信息Class
/// </summary>
[Serializable]
public class StepInfo
{/// <summary>/// 当前序号/// </summary>[Header("当前步骤的序号")]public int index;/// <summary>/// 步骤的名字/// </summary>[Header("步骤的名字")]public string name;/// <summary>/// 正常流程/// </summary>public Func<UniTask> Flow;/// <summary>/// 恢复到【初始状态】的流程/// </summary>public Action Init;/// <summary>/// 跳到【结束状态】的流程/// </summary>public Action Final;
}
  • （2）拆分步骤

把脚本按照逻辑分成不同的块（步骤），装入到执行步骤列表里

/// <summary>
/// 添加步骤：新改的写法——各个步骤单独分开，逐个添加到执行列表里
/// </summary>
/// <param name="ctk"></param>
/// <returns></returns>
public async UniTask AddSteps(CancellationToken ctk)
{//第一步var step = StepInfosList.AddFlow("第一步");step.Flow = async () =>{Debug.Log("Flow() - 第一步");await UniTask.Delay(1000, cancellationToken: ctk);};   //第二步step = StepInfosList.AddFlow("第二步");step.Flow = async () =>{Debug.Log("Flow() - 第二步");await UniTask.Delay(1000, cancellationToken: ctk);}; //第三步step = StepInfosList.AddFlow("第三步");step.Flow = async () =>{Debug.Log("Flow() - 第三步");await UniTask.Delay(1000, cancellationToken: ctk);};//第N步step = StepInfosList.AddFlow("第N步");step.Flow = async () =>{Debug.Log("Flow() - 第N步");await UniTask.Delay(1000, cancellationToken: ctk);};
}

三、跳步会有哪些操作

3.1 跳步的分类

在这里插入图片描述

3.2 跳步的实现

  • 【1】获取目标步骤信息
  • 【2】处理中间步骤的状态
  • 【3】执行目标步骤的流程
/// <summary>
/// 给定步骤名字，执行指定的步骤【所谓任意跳步】
/// </summary>
/// <param name="taskName"></param>
async UniTask RunTask(string taskName)
{if (cts.IsCancellationRequested){Debug.Log("所有的任务已经被取消了！！");return;}//【1】获取目标步骤信息var targetStep = StepInfosList.First(x => x.name.Equals(taskName.Trim()));//【2】处理中间步骤的状态Debug.Log($"#################### 要执行的目标步骤为：targetStep = {targetStep.index}  {targetStep.name}  currentIndex = {currentIndex} ");if (currentIndex == targetStep.index)  //本步骤重新执行：恢复到本步骤初始状态{Debug.Log($"回到【{targetStep.name}】初始状态");if (targetStep.Init == null){Debug.LogWarning($"步骤【{targetStep.index} {targetStep.name}】的Init函数为空，请补全！");}else{targetStep.Init();}}if (currentIndex < targetStep.index)   //往后跳步：中间步骤的状态快速补足{StepInfosList.Where(x => (x.index >= currentIndex) && (x.index < targetStep.index)).ToList().ForEach(s =>{Debug.Log($"回到【{s.name}】结束状态");if (s.Final == null){Debug.LogWarning($"步骤【{s.index} {s.name}】的Final函数为空，请补全！");}else{s.Final();}});}if (currentIndex > targetStep.index)   //往前跳步：中间步骤的状态快速撤销{StepInfosList.Where(x => (x.index >= targetStep.index) && (x.index <= currentIndex)).OrderByDescending(x=>x.index).ToList()        //注意倒序排列——由后往前执行.ForEach(s =>{Debug.Log($"回到【{s.name}】初始状态");if (s.Init == null){Debug.LogWarning($"步骤【{s.index} {s.name}】的Init函数为空，请补全！");}else{s.Init();}});}//【3】执行目标步骤的流程await targetStep.Flow();currentIndex = targetStep.index;Debug.Log($"执行步骤：{targetStep.index}  {targetStep.name} 执行完毕，当前步骤currentIndex = {currentIndex}！");
}

3.3 执行所有步骤

用异步等待来逐个执行所有的步骤，如下所示：

/// <summary>
/// 执行所有的步骤
/// </summary>
/// <returns></returns>
private async UniTask RunAllTasks()
{foreach (var step in StepInfosList){Debug.Log($"当前执行的步骤：{step.index} {step.name}");currentIndex = step.index;await step.Flow();}
}

3.4 如何取消所有步骤

  • 1）定义一个CancellationTokenSource（暂且称它为-异步任务取消标记）
    异步操作必须有取消，如果你不取消，当切换场景的时候，异步流程还在运行，则会出现资源的空引用。

举个不恰当的例子：你在家里玩电脑，然后让你的5岁的娃娃去楼下接妈妈回家。结果你媳妇从地下室坐电梯上来了，结局就是你的娃娃一直没等到他妈妈，结果呢，他呆坐在门口一直等，一直等，天黑也不回家。

问题在哪里：你指派给你小孩接妈妈这个异步操作，没有附加异步取消的令牌。下次你应该对他说：天黑还没等到妈妈的话，你就直接回家吃饭。或者我打电话给你，你就回家。

/// <summary>
/// 异步任务取消的标记
/// </summary>
private CancellationTokenSource cts;
  • 2）取消异步任务
    单凡用到上面cts的await，只要发现cts.IsCancellationRequested变成true，就会停止执行
/// <summary>
/// 取消所有的任务
/// </summary>
void CancelAllTasks()
{cts.Cancel();
}
  • 3） CancellationTokenSource是啥，如何服用？
    CancellationTokenSource就是一个遥控器，遥控器一按关机，那么凡是被该遥控器遥控的电视都关机。那么如何把遥控器绑定给一个电视机呢，也就是如何把一个CancellationTokenSource绑定给一坨异步操作。
    秘诀就是凡是await 操作的地方，你都绑一个CancellationTokenSource的token给它。
var cts = new CancellationTokenSource();
cancelButton.onClick.AddListener(() =>
{cts.Cancel();
});
await UnityWebRequest.Get("http://google.co.jp").SendWebRequest().WithCancellation(cts.Token);await UniTask.DelayFrame(1000, cancellationToken: cts.Token);
  • 4）把所有的步骤绑定在一个CancellationTokenSource上
/// <summary>
/// 创建任务，用一个新的【CancellationTokenSource】控制这些异步任务
/// </summary>
/// <returns>cts</returns>
CancellationTokenSource CreatTasks()
{var cts = new CancellationTokenSource();StepInfosList.Clear();AddSteps(cts.Token).Forget();return cts;
}

四、测试步骤

4.1 测试脚本

//加载步骤流程到执行列表中
Debug.Log($"【1】************加载步骤流程到执行列表中:{Time.realtimeSinceStartup}");
cts = CreatTasks();//执行一遍所有的任务
Debug.Log($"【2】************执行一遍所有的任务:{Time.realtimeSinceStartup}");
await RunAllTasks();//等待3秒钟，跳步到第三步执行
Debug.Log($"【3】************等待3秒钟，跳步到第三步执行:{Time.realtimeSinceStartup}");
await UniTask.Delay(3000, cancellationToken: cts.Token);
await RunTask("第三步");//取消所有任务
Debug.Log($"【4】************取消所有任务:{Time.realtimeSinceStartup}");
CancelAllTasks();//等待3秒钟，跳步到第1步执行
Debug.Log($"【5】************等待3秒钟，跳步到第1步执行:{Time.realtimeSinceStartup}");
await UniTask.Delay(3000, cancellationToken: cts.Token);
await RunTask("第一步");

4.2 测试结果

在这里插入图片描述

五、附录：脚本源码

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using Cysharp.Threading.Tasks;
using UnityEngine;/// <summary>
/// 步骤信息Class
/// </summary>
[Serializable]
public class StepInfo
{/// <summary>/// 当前序号/// </summary>[Header("当前步骤的序号")]public int index;/// <summary>/// 步骤的名字/// </summary>[Header("步骤的名字")]public string name;/// <summary>/// 正常流程/// </summary>public Func<UniTask> Flow;/// <summary>/// 恢复到【初始状态】的流程/// </summary>public Action Init;/// <summary>/// 跳到【结束状态】的流程/// </summary>public Action Final;
}/// <summary>
/// 扩展方法
/// </summary>
public static class ExtensionMethods
{/// <summary>/// 在步骤列表MySteps中生成一个只包含步骤名的空步骤/// </summary>/// <param name="MySteps">步骤列表</param>/// <param name="stepName">步骤名字</param>/// <returns></returns>public static StepInfo AddFlow(this List<StepInfo> MySteps, string stepName){int idx = MySteps.Count == 0 ?0:MySteps.Max(x => x.index) + 1;var item = new StepInfo();item.index = idx;item.name = stepName;item.Flow = null;item.Final = null;item.Init = null;MySteps.Add(item);return item;}
}/// <summary>
/// 步骤分步，任意跳转：一段操作流程，包含多个步骤，可以任意跳转到某个步骤执行。
/// 点击【上一步】时，需要对当前步骤所操作的内容进行撤销或者状态还原。
/// 点击【下一步】时，需要把跳过的步骤中的状态补足。
/// </summary>
public class FlowsDemo : MonoBehaviour
{/// <summary>/// 步骤信息表：系列化到面板，用于调试和观察，后期执行/// </summary>[Header("步骤信息表")]public List<StepInfo> StepInfosList = new List<StepInfo>();/// <summary>/// 当前执行的步骤/// </summary>private int currentIndex;/// <summary>/// 异步任务取消的标记/// </summary>private CancellationTokenSource cts;/// <summary>/// 取消所有的任务/// </summary>void CancelAllTasks(){cts.Cancel();}/// <summary>/// 创建任务，用一个新的【CancellationTokenSource】控制这些异步任务/// </summary>/// <returns>cts</returns>CancellationTokenSource CreatTasks(){var cts = new CancellationTokenSource();StepInfosList.Clear();AddSteps(cts.Token).Forget();return cts;}/// <summary>/// 执行所有的步骤/// </summary>/// <returns></returns>private async UniTask RunAllTasks(){foreach (var step in StepInfosList){Debug.Log($"当前执行的步骤：{step.index} {step.name}");currentIndex = step.index;await step.Flow();}}/// <summary>/// 主流程：所有流程连成一片，无法分步执行/// </summary>/// <returns></returns>public async UniTask Flow(){//第一步await UniTask.Delay(1000);//...//第二步await UniTask.Delay(1000);//...//第三步await UniTask.Delay(1000);//...//...//第N步await UniTask.Delay(1000);//...}/// <summary>/// 添加步骤：新改的写法——各个步骤单独分开，逐个添加到执行列表里/// </summary>/// <param name="ctk"></param>/// <returns></returns>public async UniTask AddSteps(CancellationToken ctk){//第一步var step = StepInfosList.AddFlow("第一步");step.Flow = async () =>{Debug.Log("Flow() - 第一步");await UniTask.Delay(1000, cancellationToken: ctk);};step.Init = () => { Debug.Log("Init() - 回到第一步的初始状态");};step.Final = () => { Debug.Log("Final() - 跳到第一步的结束状态"); };//第二步step = StepInfosList.AddFlow("第二步");step.Flow = async () =>{Debug.Log("Flow() - 第二步");await UniTask.Delay(1000, cancellationToken: ctk);};step.Init = () => { Debug.Log("Init() - 回到第二步的初始状态"); };step.Final = () => { Debug.Log("Final() - 跳到第二步的结束状态"); };//第三步step = StepInfosList.AddFlow("第三步");step.Flow = async () =>{Debug.Log("Flow() - 第三步");await UniTask.Delay(1000, cancellationToken: ctk);};//第N步step = StepInfosList.AddFlow("第N步");step.Flow = async () =>{Debug.Log("Flow() - 第N步");await UniTask.Delay(1000, cancellationToken: ctk);};}/// <summary>/// 给定步骤名字，执行指定的步骤【所谓任意跳步】/// </summary>/// <param name="taskName"></param>async UniTask RunTask(string taskName){if (cts.IsCancellationRequested){Debug.Log("所有的任务已经被取消了！！");return;}//【1】获取目标步骤信息var targetStep = StepInfosList.First(x => x.name.Equals(taskName.Trim()));//【2】处理中间步骤的状态Debug.Log($"#################### 要执行的目标步骤为：targetStep = {targetStep.index}  {targetStep.name}  currentIndex = {currentIndex} ");if (currentIndex == targetStep.index)  //本步骤重新执行：恢复到本步骤初始状态{Debug.Log($"回到【{targetStep.name}】初始状态");if (targetStep.Init == null){Debug.LogWarning($"步骤【{targetStep.index} {targetStep.name}】的Init函数为空，请补全！");}else{targetStep.Init();}}if (currentIndex < targetStep.index)   //往后跳步：中间步骤的状态快速补足{StepInfosList.Where(x => (x.index >= currentIndex) && (x.index < targetStep.index)).ToList().ForEach(s =>{Debug.Log($"回到【{s.name}】结束状态");if (s.Final == null){Debug.LogWarning($"步骤【{s.index} {s.name}】的Final函数为空，请补全！");}else{s.Final();}});}if (currentIndex > targetStep.index)   //往前跳步：中间步骤的状态快速撤销{StepInfosList.Where(x => (x.index >= targetStep.index) && (x.index <= currentIndex)).OrderByDescending(x=>x.index).ToList()        //注意倒序排列——由后往前执行.ForEach(s =>{Debug.Log($"回到【{s.name}】初始状态");if (s.Init == null){Debug.LogWarning($"步骤【{s.index} {s.name}】的Init函数为空，请补全！");}else{s.Init();}});}//【3】执行目标步骤的流程await targetStep.Flow();currentIndex = targetStep.index;Debug.Log($"执行步骤：{targetStep.index}  {targetStep.name} 执行完毕，当前步骤currentIndex = {currentIndex}！");}/// <summary>/// 要测试的【步骤名字】/// </summary>[Header("要执行的【步骤名字】")]public string flowName;#if UNITY_EDITOR[ContextMenu("跳到指定的步骤")]
#endifvoid TestFlow(){RunTask(flowName).Forget();}#if UNITY_EDITOR[ContextMenu("取消所有任务")]
#endifvoid TestFlow1(){CancelAllTasks();}#if UNITY_EDITOR[ContextMenu("Demo测试")]
#endifvoid TestFlow3(){Func<UniTask> TestDemo = async () =>{//加载步骤流程到执行列表中Debug.Log($"【1】************加载步骤流程到执行列表中:{Time.realtimeSinceStartup}");cts = CreatTasks();//执行一遍所有的任务Debug.Log($"【2】************执行一遍所有的任务:{Time.realtimeSinceStartup}");await RunAllTasks();//等待3秒钟，跳步到第三步执行Debug.Log($"【3】************等待3秒钟，跳步到第三步执行:{Time.realtimeSinceStartup}");await UniTask.Delay(3000, cancellationToken: cts.Token);await RunTask("第三步");//取消所有任务Debug.Log($"【4】************取消所有任务:{Time.realtimeSinceStartup}");CancelAllTasks();//等待3秒钟，跳步到第1步执行Debug.Log($"【5】************等待3秒钟，跳步到第1步执行:{Time.realtimeSinceStartup}");await UniTask.Delay(3000, cancellationToken: cts.Token);await RunTask("第一步");};Debug.Log($"开始测试:{Time.realtimeSinceStartup}");TestDemo();}
}

http://www.ppmy.cn/news/1217793.html

相关文章

Oracle 查询语句使用不等于（＜＞或者!=）会过滤空值的解决方案

Oracle 查询语句使用不等于（＜＞或者!=）会过滤空值的解决方案

在 Oracle 数据库中&#xff0c;使用不等于符号&#xff08;<> 或 !&#xff09;时&#xff0c;确实会将 NULL 值过滤掉&#xff0c;因为 NULL 代表未知值。要解决这个问题&#xff0c;可以使用 增加 OR IS NULL 或者 NVL函数来筛选出包含 NULL 的值。 例如&#xff0c;…
阅读更多...
Spring整合redis的key时出现\xac\xed\x00\x05t\前缀问题

Spring整合redis的key时出现\xac\xed\x00\x05t\前缀问题

AutowiredRedisTemplate redisTemplate;User usernew User(5,"tomhs","tttt");ValueOperations opsForValue redisTemplate.opsForValue();//存放key,opsForValue.set("user"user.getId(),user);//读取数据;System.out.println(opsForValue.get…
阅读更多...
一篇博客读懂栈——Stack

一篇博客读懂栈——Stack

目录 一、栈的概念与结构 1.1栈的概念 1.2栈的结构 二、栈的实现 2.1开始前准备stack.h 2.2栈的初始化STInit 2.3栈的销毁STDestroy 2.4栈顶插入STPush 2.5栈顶删除STPop 2.6取栈顶元素STTop 2.7检查栈是否为空STEmpty 2.8栈的元素个数STSize 一、栈的概念与结…
阅读更多...
卫星通信和800MHz双管齐下，中国电信对中国移动发起新挑战

卫星通信和800MHz双管齐下，中国电信对中国移动发起新挑战

依靠国内某科技企业的宣传&#xff0c;卫星通信大热&#xff0c;中国电信也由此成为受益者&#xff0c;日前中国电信又大举招标25万座800MHz 5G基站&#xff0c;显示出中国电信积极以技术优势挑战中国移动。 一、中国电信急起直追 自从4G时代以来&#xff0c;中国电信就在国内通…
阅读更多...
2023 年最新企业微信官方会话机器人开发详细教程（更新中）

2023 年最新企业微信官方会话机器人开发详细教程（更新中）

目标是开发一个简易机器人&#xff0c;能接收消息并作出回复。 获取企业 ID 企业信息页面链接地址&#xff1a;https://work.weixin.qq.com/wework_admin/frame#profile 自建企业微信机器人 配置机器人应用详情 功能配置 接收消息服务器配置 配置消息服务器配置 配置环境变量…
阅读更多...
2023nacos源码解读第3集——nacos-client核心功能之微服务调用和配置管理测试

2023nacos源码解读第3集——nacos-client核心功能之微服务调用和配置管理测试

文章目录 1、测试项目2、项目注意事项3、 测试核心功能3.1 测试服务调用与负载均衡3.2 测试配置监听 4、参考文档 1、测试项目 项目地址 nacos-service-a nacos-service-b 2、项目注意事项 项目初始化可以使用aliyun spring initializer ,以更方便的使用springcloud alibaba…
阅读更多...
vscode使用flake8设置单行最长字符限制设置失败的问题

vscode使用flake8设置单行最长字符限制设置失败的问题

vscode使用flake8设置单行最长字符限制设置失败的问题 问题描述解决方案 问题描述 如图所示&#xff0c;使用flake8单行字数过长&#xff0c;就会有有红色底的波浪线 一般情况下很多教程都会让你在setting.json里面设置 但是我打开我的setting.json&#xff0c;发现我已经进…
阅读更多...
Java怎么对复杂的数据类型排序和比大小

Java怎么对复杂的数据类型排序和比大小

目录 一.对复杂的数据类型比大小 Comparable接口 compareTo方法 二.对复杂数据类型排序 三.总结 一.对复杂的数据类型比大小 假如我们现在有个学生类&#xff0c;并且我们实例化出了俩个学生对象&#xff0c;他们各自有各自的名字和年龄属性&#xff0c;我们如何对他们进…
阅读更多...
最新文章

Copyright @ 2022~2023