【已解决】Unity Coroutinue 协程未有效执行的问题

开发平台：Unity 编程平台：Visual Studio 2020以上 使用语言：C#  

问题描述

  在调用 频繁被激活/禁用 的对象时，该对象挂载的协程（Coroutine）仅在首次进入 Runtime 模式下执行。后续禁用再激活操作导致该协程内容不可正确运行的问题。

public RectMask2D Mask2D;
public Vector4 Forward;

public void Start()
{
	StartCoroutinue(DOLineMove);
}

public IEnumerator DOLineMove()
{
	yield return Mask2D.padding -= Forward;
	StartCoroutinue(DOLineMove());
}

 

问题分析

  协程 的运行前提是 所挂载的 GameObject 对象保持 Active 状态。注意：协程 在执行或执行自我迭代的过程中，其挂载的 GameObject 对象必须保持 Active 状态）。在 Unity 生命周期中，初始化阶段为 Awake 、 OnEnable 、Start 三个周期阶段。大致如下：

• Awake 阶段用于捕获脚本挂载对象上的 Component 信息。
• OnEnable 阶段用于事件监听注册行为。
• Start 阶段执行入口程序。

  当 Editor 首次进入 Runtime 模式时， Initialization 阶段方法将依次被执行。故无论在哪一阶段调用 StartCoroutinue(string methodName) 均有效调用该 IEnumerator 类型。问题显而易见的出现在以下层面：

• 内部调用 StopCoroutinue(string methodName) 或 StopAllCoroutine() 不规范导致。 该两种方法禁用脚本内启用的协程对象。一个仅禁用特定对象，另一个则禁用脚本内所有对象。不规范的使用逻辑容易造成该问题出现。
• 脚本对象 或 脚本对象本身 被来源不明的程序自动禁用与再重启导致协程非正常运行。 例如：Awake 阶段应正确执行协程方法。但同 Awake 周期阶段中，另一脚本内修改（·SetActive() 或 enable）状态导致。该情况下，协程将未正常运行。结合 Runtime 模式下 Unity 程序执行周期，下次启用后将直接从 OnEnable 阶段进行。当然，频繁的禁用再启用也会出现问题。（这肯定是人写的BUG）

 

解决方案：定点排查 谁 在篡改（或是 频繁的）脚本的状态？

  排查往往是件麻烦的事情，与项目的代码量息息相关。少则很快解决，多则耗时几小时，甚至一个礼拜都不在话下。或许正是那起初不认为有问题的框架下，在后续的开发中逐渐暴露出隐患问题。最佳的方式是设计遵循 按需加载进场景，而非保留至场景中，激活、禁用。如果已经来不及拯救，那么接下就是唯一可能的有效方法。

1）使用 快速查找 功能逐一排查

  Visual Studio 提供 快速查找 的编辑。通常情况下这一功能用于查询关键词。当然，在排查中也有相当作用。因为与禁用、启用相关，搜索代码中 SetAtive() / enable 中关联的内容，逐一确认排查。（耗时 是不可避免的）

2）使用 浏览定义 快速定位引用

  在程序可执行任意位置处添加 this.gameObject.SetActive(false) 或 this.enable(true) ，右键关键字 SetActive 或 enable 选择 查看所有引用。Visual Studio 将给予所有使用该关键字的引用语句。可方便快速排查。注意！

1. 进行浏览定义时，请确保打开的是该项目的所有程序集。而非个体。
2. 部分情况下，存在开发者使用自封装的 GameObjectUtil.Disable(GameObject obj) 等之类的方法。在这种情况，还需查看该方法被调用的对象与位置信息逐一排查。

3）建立 Coroutinue 单例模式，统一管理协程

  单例模式的优势在于，可供程序全局访问。而在 MonoBehaviour 加持下的 Mono 单例，允许启动、禁止协程。那么，在此 Mono 单例框架完成来自其他脚本中的 IEnumerator 委托也不妨是一种好处。

public class ExampleA : MonoBehavour
{
	public void OnEnable() => GameCoroutinue.Start(DoExample);
	public void OnDisable() => GameCoroutinue.Stop(DoExample);

	private IEnumerator DoExample() { yield return ... ; }
}

只要是 Mono 加持下的单例对象，不存在禁用的说法。 但注意！

1. 你需要在实例 get 中检测是否存在该单例。有则使用，无则创建。
2. 为避免频繁创建。考虑引入 DontDestroyOnLoad() 避免销毁。
3. 考虑线程的非法使用单例。