Unity单例基类的实现方式

游戏开发的过程中我们经常会将各种“Manger”类设为单例，以实现单一资源的全局访问。

Unity中的单例一般分为两类，一种是直接继承自Object的普通单例，还有一种是需要继承MonoBehaviour的Mono单例。接下来我将会讲解这两种单例基类的实现方式。

注意：由于Unity的限制，项目中一般不会出现多线程对单例竞争访问的情况，因此以下实现都是以单线程为前提考虑的，但你依旧可以在此基础上使用经典的双重检查实现线程安全的初始化。

普通单例基类

为了使基类足够通用，我们需要用泛型T来表示单例的类型。并且这个单例也必须是个引用类型（class）（你也不会想用int或struct作为单例对象吧），因此要加上where T : class约束。

public abstract class Singleton<T> where T : class
{
    private static T _instance;

    public static T Instance
    {
        get
        {
            // ...
        }
    }
}

接下来我们就要处理单例的初始化，一般而言你可能会直接使用_instance = new T()进行初始化，但这会带来一个问题——子类T必须有public的无参构造函数。这就表示编译器无法阻止你或别人在程序的其地方使用new T()，导致单例的唯一性被破坏，作为一个强迫症并不能容忍这种潜在的风险。

public abstract class Singleton<T> where T : class, new() // 注意这里要添加new()约束
{
    private static T _instance;

    public static T Instance
    {
        get
        {
            if (_instance == null)
            {
                _instance = new T();
            }
            return _instance;
        }
    }
}

解决方案也很简单，我们先将T的构造函数设为private，防止被外部调用。

在我们需要初始化单例的时候，就通过反射来获取对象T的私有无参构造函数。

注意，这里强调了是私有的无参构造函数，因为我们在GetConstructor的参数中使用了BindingFlags.NonPublic，因此只能获取私有的构造函数。这也是对子类的约束，使其必须将无参构造函数设为私有，否则就会抛出异常。

public abstract class Singleton<T> where T : class
{
    private static T _instance;

    public static T Instance
    {
        get
        {
            if (_instance == null)
            {
                // 反射获取私有无参构造函数
                ConstructorInfo ctor = typeof(T).GetConstructor(BindingFlags.Instance | BindingFlags.NonPublic, null, Type.EmptyTypes, null);

                if (ctor == null)
                {
                    throw new InvalidOperationException("Singleton classes must have exactly one private constructor.");
                }
                // 初始化
                _instance = ctor.Invoke(null) as T;
            }
            return _instance;
        }
    }
}

Mono单例基类

Mono单例的实例化方式比较特殊，首先MonoBehaviour是不能被new的，所以不需要考虑构造函数的问题。

想要实例化一个MonoBehaviour对象，就需要将其挂载到场景的某个GameObject上。因此我们可以通过以下代码，创建一个GameObject对象，然后进行将T挂载到该对象上，以获取T的实例。需要注意的是，Unity在切换场景时会销毁所有对象，挂载在对象上的组件也会一并消失，因此我们需要使用DontDestroyOnLoad标记对象，以防止被销毁。

GameObject singletonObject = new GameObject(typeof(T).Name + "(Singleton)");
DontDestroyOnLoad(singletonObject); // 保留在场景切换时不被销毁
_instance = singletonObject.AddComponent<T>();

最终代码如下：

public abstract class SingletonMono<T> : MonoBehaviour where T : MonoBehaviour
{
    private static T _instance;

    public static T Instance
    {
        get
        {
            if (_instance == null)
            {
                // 在场景中查找是否已存在该类型的实例
                _instance = FindObjectOfType<T>();

                // 如果场景中不存在该类型的实例，则创建一个新的GameObject并添加该组件
                if (_instance == null)
                {
                    GameObject singletonObject = new GameObject(typeof(T).Name + "(Singleton)");
                    DontDestroyOnLoad(singletonObject); // 保留在场景切换时不被销毁
                    _instance = singletonObject.AddComponent<T>();
                }
            }
            return _instance;
        }
    }
}

本文发布于2024年5月22日

最后修改于2024年5月22日