单例模式是设计模式中很常用的一种模式,它的目的是让一个类在程序运行期间有且只有一个实例。关于 Unity 中如何实现单例模式其实有很多文章,但是我找不到一篇能够完整讲述整个单例模式实现流程的文章,大部分都是直接贴代码,这对于我这种不喜欢知其然,却不知其所以然的人来说是远远不够的,所以我翻阅了国外一些资料,在这里写下这篇文章,旨在通过完整的流程讲述如何在 Unity 中实现单例模式,以及实现该模式时需要注意的一些事项,希望能够帮助初学者。另外,如有任何错误请尽管指出。
项目源码仓库:https://github.com/darylgo/UnitySingleton
1 单例模式的应用场景
在使用 Unity 开发游戏的时候,经常会需要各种 Manager 类用于管理一些全局的变量和方法,例如最常见的 GameManager 用于记录各种需要在整个游戏过程中持久化的数据。本文以 GameManager 为例,假设我们有以下几个需求:
- 整个游戏过程中必须有且只有一个 GameManager
- 在 GameManager 里会记录一个叫 Value 的整型变量
- 切换游戏场景的时候 GameManager 不能被销毁
- 有两个游戏场景分别叫 FirstScene 和 SecondScene
- 每一个场景中都会有一个按钮,点击后会跳转到另一场景,并且对 GameManager.Value 进行 +1 操作
- 每一个场景中都会显示当前 GameManager.Value 的值
下面我们就来一步步实现单例模式下的 GameManager。
2 实现单例模式的 GameManager
首先,我们会定义一个类叫 GameManager,它继承了 MonoBehaviour,具体代码如下所示:
public class GameManager : MonoBehaviour
{
public static GameManager Instance { get; private set; }
public int Value { get; set; } = 0;
private void Awake()
{
Instance = this;
}
}
- 静态的 GameManager 属性 Instance 保证了它可以通过类访问,而不是通过实例访问。
- Instance 属性私有的 set 保证了它只允许在 GameManager 内部赋值,外部只能读取。
- 继承 MonoBehaviour 类的实例都是又 Unity 游戏引擎创建的,不能通过构造函数创建,所以我们在 Awake() 方法里对 Instance 进行赋值,保证了我们能够在第一时间初始化。
创建完 GameManager 类之后,我们需要在游戏场景中创建一个也叫做 GameManager 的 GameObject,并且把 GameManager 类作为 Component 添加到 GameObject 上:
接下来,我们要处理实现单例模式时遇到的第一个问题,就是 Unity 在切换游戏场景的时候,默认会消除上一个游戏场景里所有的 GameObject 对象,所以我们的 GameManager 对象也不可避免的会被销毁,这是我们不希望看到的,所以我们使用 DontDestroyOnLoad() 方法让 GameManager 在切换游戏场景的时候不会被销毁:
public class GameManager : MonoBehaviour
{
public static GameManager Instance { get; private set; }
public int Value { get; set; } = 0;
private void Awake()
{
Instance = this;
DontDestroyOnLoad(gameObject);
}
}
在处理完 GameManager 被销毁的情况之后,我们要再处理另一个问题,就是我们的 GameManager 是在第一个场景里创建的,当我们从第二个游戏场景切换回第一个游戏场景的时候,Unity 并不是恢复第一个游戏场景,而是会重新创建出一个新游戏场景,这就会导致一个新的 GameManager 对象被创建,这就不能保证 GameManager 对象的唯一性,如下所示:
要解决上面的问题,我们需要在 GameManager 类的 Awake() 方法里增加一些逻辑判断,当检查到已经有一个 GameManager 对象存在的时候,就把当前的 GameManager 对象销毁,如下所示:
public class GameManager : MonoBehaviour
{
public static GameManager Instance { get; private set; }
public int Value { get; set; } = 0;
private void Awake()
{
if (Instance == null)
{
Instance = this;
DontDestroyOnLoad(gameObject);
}
else
{
Destroy(gameObject);
}
}
}
3 通用单例模式
单例模式在开发过程中十分常见,所以我们经常会使用泛型写一个单例模式的基类,这样我们就可以通过继承该基类轻松实现单例模式,代码如下所示:
public class Singleton<T> : MonoBehaviour where T : Singleton<T>
{
public static T Instance { get; private set; }
protected void Awake()
{
if (Instance == null)
{
Instance = (T) this;
DontDestroyOnLoad(gameObject);
}
else
{
Destroy(gameObject);
}
}
}
我们使用 Singleton 基类实现我们的 GameManager,代码如下所示:
public class GameManager : Singleton<GameManager>
{
public int Value { get; set; } = 0;
}