脚本可直拖到Unity项目,用于在Unity任何线程或异步操作中安全地向主线程发送操作。这是非常重要的,因为Unity很多API(特别是与UI和游戏对象相关的)都必须在主线程上调用。
代码块
//#define UNITY_STANDALONE //BepInEx制作UnityMOD时手动启用
#if UNITY_EDITOR || UNITY_STANDALONE
using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
namespace MetalMaxSystem.Unity
{
/// <summary>
/// 主线程调度器.帮助实现在子线程写执行主线程对象实例参与的动作.
/// 即回调(call back Invoke),让这些动作回到主线程调用.
/// </summary>
public class MainThreadDispatcher : MonoBehaviour
{
private static MainThreadDispatcher _instance;
private static Queue<Action> actions = new Queue<Action>();
private static Queue<IEnumerator> coroutines = new Queue<IEnumerator>();
public static MainThreadDispatcher Instance
{
get
{
if (_instance == null)
{
var obj = GameObject.Find("MainThreadDispatcher");
if (obj == null) obj = new GameObject("MainThreadDispatcher");
_instance = obj.GetComponent<MainThreadDispatcher>();
if (_instance == null) _instance = obj.AddComponent<MainThreadDispatcher>();
DontDestroyOnLoad(obj);
}
return _instance;
}
}
void Update()
{
//即使Enqueue已加锁,Update遍历队列时若不加锁可能遇到Enqueue执行到一半时主线程的Update开始遍历队列->读取到不一致的队列状态
lock (actions)
{
while (actions.Count > 0)
{
actions.Dequeue()?.Invoke();
}
}
lock (coroutines)
{
while (coroutines.Count > 0)
{
StartCoroutine(coroutines.Dequeue());
}
}
}
//↓封装的回调函数(支持在子线程使用,然后由主线程回调执行)
/// <summary>
/// 回调函数.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用Action).
/// 示例MainThreadDispatcher.Instance.Invoke(() =>{涉及主线程对象的动作});
/// </summary>
/// <param name="action">这个匿名委托将被添加到队列,由一个专门处理回调的MonoBehaviour组件实例来跑</param>
public void Invoke(Action action)
{
if (action == null) return;
lock (actions)
{
actions.Enqueue(action);
}
}
/// <summary>
/// 回调函数.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用协程).
/// 示例MainThreadDispatcher.Instance.Invoke(MyCoroutine());
/// </summary>
public void Invoke(IEnumerator coroutine)
{
if (coroutine == null) return;
lock (coroutines)
{
coroutines.Enqueue(coroutine);
}
}
/// <summary>
/// 回调函数.直接传入协程方法体.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用协程).
/// 示例MainThreadDispatcher.Instance.Invoke(() => {
/// yield return new WaitForSeconds(1);
/// Debug.Log("Delayed log");
/// });
/// </summary>
public void Invoke(Func<IEnumerator> coroutineFunc)
{
if (coroutineFunc == null) return;
Invoke(coroutineFunc());
}
/// <summary>
/// [静态]回调函数.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用Action).
/// 示例MainThreadDispatcher.Call(() =>{涉及主线程对象的动作});
/// </summary>
/// <param name="action">这个匿名委托将被添加到队列,由一个专门处理回调的MonoBehaviour组件实例来跑</param>
public static void Call(Action action)
{
if (action == null) return;
var ensure = Instance;
lock (actions)
{
actions.Enqueue(action);
}
}
/// <summary>
/// [静态]回调函数.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用协程).
/// 示例MainThreadDispatcher.Call(MyCoroutine());
/// </summary>
public static void Call(IEnumerator coroutine)
{
if (coroutine == null) return;
var ensure = Instance;
lock (coroutines)
{
coroutines.Enqueue(coroutine);
}
}
/// <summary>
/// [静态]回调函数.直接传入协程方法体.
/// 对Unity引擎组件实例相关动作执行回调(回到主线程调用协程).
/// 示例MainThreadDispatcher.Call(() => {
/// yield return new WaitForSeconds(1);
/// Debug.Log("Delayed log");
/// });
/// </summary>
public static void Call(Func<IEnumerator> coroutineFunc)
{
if (coroutineFunc == null) return;
var ensure = Instance;
Call(coroutineFunc());
}
}
}
//示范操作
//private void TodoOnMainThread(var sprite)
//{
// //在另一个线程或者异步操作中调用
// MainThreadDispatcher.Instance.Invoke(() =>
// {
// var c = GetComponent<MainThreadDispatcher>();
// if (c != null)
// {
// //涉及主线程对象的操作
// }
// });
//}
// 成员变量
// _instance: 这是一个静态的MainThreadDispatcher实例,用于实现单例模式.单例模式确保整个应用程序中只有一个MainThreadDispatcher实例.
// actions: 这是一个Action类型的队列,用于存储需要在主线程上执行的操作.Action是一个代表没有参数且不返回值的委托的类.
// 属性
// Instance: 这是一个静态属性,用于获取MainThreadDispatcher实例.若实例不存在,它会创建一个新的游戏对象,将组件脚本添加到该游戏对象上,并确保该游戏对象在加载新场景时不会被销毁.
// 方法
// Update(): 这是Unity的一个生命周期方法,每帧都会被调用.在这个方法中,它检查_actions队列是否有待执行的操作,若有,则依次取出并执行它们.
// Invoke(Action action): 这个方法允许你将一个操作添加到_actions队列中,以便在主线程上执行.它首先检查传入的操作是否为null,若是,则直接返回.否则,它会锁定_actions队列(以确保线程安全),然后将操作添加到队列中.
// 队列用法
// Clear(): 清空队列中的所有元素.
// Contains(T item): 检查队列是否包含指定的元素.
// CopyTo(T[] array, int arrayIndex): 将队列中的元素复制到指定的数组中,从指定的数组索引开始.
// Dequeue(): 移除并返回队列的第一个元素.若队列为空,则抛出异常.
// Invoke(T item): 将指定的元素添加到队列的末尾.
// GetEnumerator(): 返回一个用于枚举队列中元素的枚举器.
// Peek(): 返回队列的第一个元素,但不移除它.若队列为空,则抛出异常.
// ToArray(): 将队列中的元素复制到一个新数组中.
// TrimExcess(): 设置队列的容量为其当前大小,释放多余的存储空间.
// TryDequeue(out T result): 尝试移除并返回队列的第一个元素,若队列为空,则返回 false 并将 result 设置为默认值.
// TryPeek(out T result): 尝试返回队列的第一个元素但不移除它,若队列为空,则返回 false 并将 result 设置为默认值.
#endif
免责声明:本文系网络转载或改编,未找到原创作者,版权归原作者所有。如涉及版权,请联系删