Unity单例封装

1.前言

本篇主要针对Unity单例模式，完成一个可以重复继承使用的抽象类，减少重复的工作与代码。同时，对存在的多种单例进行优劣分析。

2.Unity单例问题分析

2.1 单例原则

单例要满足以下两个原则：

2.1.1 单一原则

即不能存在两个单例对象，这看起来是一句废话，且在C#编程中不会出现，但在Unity中进行组件化编程的时候却会存在。因为unity继承自Monobehavior的类是一个组件可以通过挂载形成一个实例。不用手动new产生。这就容易违背此原则。

2.1.2 功能封装原则

单例是为了将特定功能且功能关联的方法，封装在一个模块能，方便处理各种问题。并且避免各种重复产生实例对象，所以单例一般都会隐藏public构造函数。

2.2 存在问题

2.2.1 单例原则违背

目前，网络充斥这大量单例模式，都或多或少存在各种问题，各种解决方案臃肿，没有必要进行如此处理。点击查看详细叙述。
本文最后也会对不推荐的单例写法进行分析。

2.2.2 单例滥用

采用unity进行开发时，不可避免的会涉及到ui的切换以及相互调用。在很多教程或者网络教学视频中，大量采用单例，笔者曾看过一个教程，大部分脚本都采用单例进行处理。好处是增加灵活性，方便调用与切换，坏处则时不易维护，增加开销，尤其是当用到下文不推荐的方式。所以一定不要为了方便不同脚本之间相互调用而采用单例。

3.简单单例模式

3.1 推荐方式

此方式最简单粗暴，有效。唯一缺陷是看着一点都不高端。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public abstract class MonoSingleton<T> : MonoBehaviour where T : MonoSingleton<T>
{
    private static T instance;

    public static T Instance
    {
        get
        {
            return instance;
        }
    }

    protected virtual void Awake()
    {
        instance = (T)this;
    }
}

3.2 使用FindObjectOfType的单例

3.2.1 单例代码

代码如下所示，此方法看起来很完美，考虑周全，其实存在很多问题与隐患。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public abstract class MonoSingleton<T> : MonoBehaviour where T : MonoSingleton<T>
{
    private static T instance;

    public static T Instance
    {
        get
        {
            if (instance == null)
            {
                instance = FindObjectOfType<T>();
            }

            if (instance != null || !instance.initialized)
            {
                instance.StartComponent();
            }

            return instance;
        }
    }

    protected bool initialized = false;

    protected virtual void StartComponent()
    {
        initialized = true;
    }

    private void Start()
    {
        if (!initialized)
        {
            StartComponent();
        }
    }
}

3.2.2 FindObjectOfType的使用

FindObjectOfType此方法是遍历所有激活游戏物体，查找组件，返回第一个找到的对象。此方法有以下几个问题：

问题一：性能开销，要查找所有激活物体以及脚本，性能消耗不可避免。如果所有的单例都采用此方式，则在刚启动时一起性能开销峰值。

问题二：此方法需要游戏物体激活状态使用，即如果游戏物体未激活状态调用此游戏物体，则单例为空，如果不知道FindObjectOfType的用法，可能不会找问题，所以上述单例脚本中StartComponent也就没有太大意义。

3.3 在单例中生成游戏物体

3.3.1 脚本如下：

using UnityEngine;

public abstract class MonoSingleton<T> : MonoBehaviour where T : MonoSingleton<T>
{
    private static T instance;

    public static T Instance
    {
        get
        {
            if (instance == null)
            {
                var instances =Resources.FindObjectsOfTypeAll(typeof(T)) as T[];

                if (instances.Length > 0)
                {
                    instance = instances[0];
                }

                if (instance == null)
                {
                    GameObject InstanceObj = new GameObject("MonoSingleton");
                    instance = InstanceObj.AddComponent<T>();
                }
            }
            return instance;
        }
    }
}

3.3.2 FindObjectsOfTypeAll使用

此部分问题同上，而且还不如使用FindObjectsOfType。

3.3.3 在自身创建游戏物体

对于跟UI逻辑相关的脚本中，不建议创建自身脚本所在的游戏物体。当涉及到场景加载时销毁游戏物体时会有很大的风险，尤其是当在OnDisable中调用此单例时。因为unity销毁游戏物体时是随机的，当销毁时会调用OnDisable方法。如果此单例已经销毁，在别的脚本OnDestroy直接调用时，会引发生成新游戏物体的错误。

4.C#的几种单例

以下两种方法不涉及Unity组件问题单例：

4.1 Unity中使用

当unity主线程中使用，不涉及线程安全问题时可用如下代码：

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public abstract class Singleton<T> where T : Singleton<T>,new()
{
    private static T instance;

    public static T Instance
    {
        get
        {
            if (instance == null)
            {
                instance = new T();
                instance.Init();
            }

            return instance;
        }
    }

    protected virtual void Init() { }
}

4.2 线程安全单例

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public abstract class Singleton<T> where T : Singleton<T>, new()
{
    private static object threadSafeLock = new object();

    private static T instance;
    
    public static T Instance
    {
        get
        {
            if (instance == null)
            {
                lock(threadSafeLock)
                {
                    if (instance == null)
                    {
                        instance = new T();
                        instance.Init();
                    }
                }
            }

            return instance;
        }
    }

    protected virtual void Init() { }
}

5.总结

总之在使用单例时，不要为了灵活方便而频繁使用单例。同时做好处理和规划，防止单例未初始化而调用，同时慎用Awake方法，不要为了能比start早执行而使用。