【Unity3d】【原理】【实践】协程的原理和实践

原理

协程，需要从迭代器说起。
协程的执行，可以归结为，每帧执行一次迭代，直到迭代结束，返回。

迭代器，IEnumerator接口的实现。其中的核心迭代功能，在bool MoveNext() 中，若返回为true,则表明当前未结束；若返回false,则表明当前迭代结束。 若迭代未结束，则需是的迭代器的object current 值存在。因为迭代器的用法便是，先判定是否结束，若未结束，则拿到current值，进行后续的逻辑。

C#提供的协程语句 yield,相当于是调用一次MoveNext，若结果是true，则返回current。
其中，

• yield break 返回的是false.
• 若yield return null,返回的MoveNext() 为true, current值为null;
• 若yield return newEnumerator,返回的MoveNext()为true,并且 current 值为 newEnumerator.

因此，自定义实现一个协程：

1. 一个每帧可以迭代的循环执行器。 eg.Monobehavior的Update
2. 处理每次的迭代。其中，若返回的为新的迭代器，则现需要执行新的迭代器。
3. 最终迭代返回为false，则迭代器结束。

实践一：实现协程执行器

1. 每帧调用的方法：

public IEnumerator currentEnumerator; 

/// <summary>
/// 开始一次协程
/// </summary>
public void StartMyCoroutine(IEnumerator enumerator)
{
    if (currentEnumerator == null)
    {
        currentEnumerator = enumerator;
    }
}

void Update()
{
    if (currentEnumerator == null)
        return;
    if (!RunOnceIteration(currentEnumerator))
    {
        // 返回false,则结束
        currentEnumerator = null;
    }
}

/// <summary>
/// 执行一次迭代
/// </summary>
bool RunOnceIteration(IEnumerator enumerator)
{ 
    // 若当前迭代器返回的current也是一个迭代器，则先运行新迭代器的迭代
    if (enumerator.Current is IEnumerator newEnumerator) 
    {
        if (RunOnceIteration(newEnumerator)) 
        {
            return true;
        }
        else // 若是新迭代器迭代后，返回的是false,那么，说明迭代器迭代结束，则运行原迭代器的迭代。
        {
            enumerator.MoveNext();
        }
    }
    
    // 若当前的迭代器的Current不是一个新的迭代器，那么，进行一次迭代
    return enumerator.MoveNext();
}

实践二：使用

使用一个小例子实际测试一下：
假设TestRun1和TestRun2都是等几帧才结束，其中，在TestRun1中，先等TestRun2执行完毕，才执行自己的逻辑.

void Start()
{
    // 在Start中，开始
    this.StartMyCoroutine(TestRun1());
}

IEnumerator TestRun1()
{
    yield return TestRun2(); // 等待TestRun2结束。
    int frameCount = 9; 
    while (frameCount > 0)
    {
        --frameCount;
        Debug.Log($"TestRun1 frameCount:{Time.frameCount}");
        yield return null;
    }

    Debug.Log($"TestRun1 end frameCount:{Time.frameCount}");
}

IEnumerator TestRun2()
{
    int frameCount = 3;
    while (frameCount > 0)
    {
        --frameCount;
        Debug.Log($"TestRun2 frameCount:{Time.frameCount}");
        yield return null;
    }

    Debug.Log($"TestRun2  end frameCount:{Time.frameCount}");
}

代码的全部内容:

using System.Collections;
using UnityEngine;

public class CoroutineMonobehaviour : MonoBehaviour
{
    #region Test Coroutine

    void Start()
    {
        // 在Start中，开始
        this.StartMyCoroutine(TestRun1());
    }

    IEnumerator TestRun1()
    {
        yield return TestRun2(); // 等待TestRun2结束。
        int frameCount = 9; 
        while (frameCount > 0)
        {
            --frameCount;
            Debug.Log($"TestRun1 frameCount:{Time.frameCount}");
            yield return null;
        }

        Debug.Log($"TestRun1 end frameCount:{Time.frameCount}");
    }

    IEnumerator TestRun2()
    {
        int frameCount = 3;
        while (frameCount > 0)
        {
            --frameCount;
            Debug.Log($"TestRun2 frameCount:{Time.frameCount}");
            yield return null;
        }

        Debug.Log($"TestRun2  end frameCount:{Time.frameCount}");
    }

    #endregion

    #region Run Coroutine Methods

    // 当前的迭代器
    public IEnumerator currentEnumerator;

    /// <summary>
    /// 开始一次协程
    /// </summary>
    public void StartMyCoroutine(IEnumerator enumerator)
    {
        if (currentEnumerator == null)
        {
            currentEnumerator = enumerator;
        }
    }

    /// <summary>
    /// Monobehaviour的每帧调用一次迭代
    /// </summary>
    void Update()
    {
        if (currentEnumerator == null)
            return;
        if (!RunOnceIteration(currentEnumerator))
        {
            // 返回false,则迭代器结束,协程结束
            currentEnumerator = null;
        }
    }

    /// <summary>
    /// 执行一次迭代
    /// </summary>
    bool RunOnceIteration(IEnumerator enumerator)
    { 
        // 若当前迭代器返回的current也是一个迭代器，则先运行新迭代器的迭代
        if (enumerator.Current is IEnumerator newEnumerator) 
        {
            if (RunOnceIteration(newEnumerator)) 
            {
                return true;
            }
            else // 若是新迭代器迭代后，返回的是false,那么，说明迭代器迭代结束，则运行原迭代器的迭代。
            {
                enumerator.MoveNext();
            }
        }
        
        // 若当前的迭代器的Current不是一个新的迭代器，那么，进行一次迭代
        return enumerator.MoveNext();
    }

    #endregion
}

把此代码挂在任意一个GameObject上，运行结果为：