Version: 2017.4
脚本限制
内置序列化

脚本序列化

序列化是将数据结构或对象状态转换为 Unity 可存储并在以后可重构的格式的自动过程。Unity 的一些内置功能会使用序列化,比如保存和加载、Inspector 窗口、实例化和预制件等功能。请参阅有关内置序列化使用情况的文档,了解所有相关的背景详情。

数据在 Unity 项目中的组织方式会影响 Unity 序列化该数据的方式,并会对项目的性能产生重大影响。以下是有关 Unity 中的序列化以及如何针对其进行项目优化的一些准则。

另请参阅以下相关文档:序列化错误自定义序列化内置序列化

了解热重载

热重载

热重载是在 Editor 打开的状态下创建或编辑脚本并立即应用脚本行为的过程。无需重新启动游戏和 Editor 即可使更改生效。

更改并保存脚本时,Unity 会热重载所有当前加载的脚本数据。它首先将所有可序列化变量存储在所有加载的脚本中,并在加载脚本后恢复它们。热重载后,所有不可序列化的数据都将丢失。

保存和加载

Unity 使用序列化技术从计算机的硬盘驱动器加载和保存场景资源AssetBundle。这包括保存在您自己的脚本 API 对象(如 MonoBehaviour 组件和 ScriptableObject)中的数据。

Unity Editor 中的许多功能都建立在核心序列化系统之上。对于序列化要特别注意的两点是 Inspector 窗口和热重载。

Inspector 窗口

Inspector 窗口中查看或更改游戏对象的组件字段的值时,Unity 会序列化此数据,然后在 Inspector 窗口中显示数据。Inspector 窗口在显示字段值时不与 Unity Scripting API 通信。

如果在脚本中使用属性,则在 Inspector 窗口中查看或更改值时,绝不会调用任何属性 getter 和 setter,因为 Unity 会直接序列化 Inspector 窗口字段。这意味着:当 Inspector 窗口中的字段值表示脚本属性时,对 Inspector 窗口中值的更改不会调用脚本中的任何属性 getter 和 setter

序列化规则

Unity 中的序列化程序在实时游戏环境中运行。这对性能有重大影响。因此,Unity 中的序列化与其他编程环境中的序列化具有不同的行为。下面列出了一些关于如何在 Unity 中使用序列化的技巧。

如何确保脚本中的字段被序列化

确保其符合以下条件:

可序列化的简单字段类型

  • 具有 Serializable 属性的自定义非抽象、非泛型类
    (请参阅下面的如何确保自定义类可序列化。)

  • 具有 Serializable 属性的自定义结构

  • 对从 UnityEngine.Object 派生的对象的引用

  • 原始数据类型(intfloatdoubleboolstring 等)

  • 枚举类型

  • 某些 Unity 内置类型:Vector2Vector3Vector4RectQuaternionMatrix4x4ColorColor32LayerMaskAnimationCurveGradientRectOffsetGUIStyle

可序列化的容器字段类型

  • 可序列化的简单字段类型的数组

  • 可序列化的简单字段类型的 List<T>

注意:Unity 不支持多级类型(多维数组、交错数组和嵌套容器类型)的序列化。
如果要序列化这些类型,可使用两种方法:将嵌套类型包装在类或结构中,或使用序列化回调 ISerializationCallbackReceiver 执行自定义序列化。有关更多信息,请参阅自定义序列化的文档。

如何确保自定义类可序列化

确保其符合以下条件:

  • 具有 Serializable 属性

  • 非抽象

  • 非静态

  • 非泛型(但可继承自泛型类)

要确保自定义类或结构的字段被序列化,请参阅上面的如何确保脚本中的字段被序列化

序列化程序何时可能出现意外行为?

自定义类的行为类似于结构

对于不是从 UnityEngine.Object 派生的自定义类,Unity 以内联方式按值对它们进行序列化,类似于结构的序列化方式。如果在多个不同的字段中存储对自定义类的实例的引用,则在序列化时它们将成为单独的对象。然后,当 Unity 反序列化这些字段时,它们将包含具有相同数据的不同对象。

需要序列化具有引用的复杂对象图时,不要让 Unity 自动序列化对象。相反,应使用 ISerializationCallbackReceiver 手动序列化它们。这样可以防止 Unity 从对象引用创建多个对象。有关更多信息,请参阅 ISerializationCallbackReceiver 的文档。

这种情况仅适用于自定义类。Unity 以“内联”方式对自定义类进行序列化,因为这些类的数据会成为使用这些类的 MonoBehaviourScriptableObject 的完整序列化数据的一部分。当字段引用 UnityEngine.Object 派生的某个类(例如 public Camera myCamera)时,Unity 会序列化对摄像机 UnityEngine.Object 的实际引用。如果脚本派生自 MonoBehaviourScriptableObject(二者均从 UnityEngine.Object 派生而来),在脚本的实例中也适用相同的序列化原则。

自定义类不支持 null

思考在反序列化一个使用以下脚本的 MonoBehaviour 时进行了多少次分配。

class Test : MonoBehaviour
{
    public Trouble t;
}
[Serializable]
class Trouble
{
   public Trouble t1;
   public Trouble t2;
   public Trouble t3;
}

出现一次以下分配并不奇怪:Test 对象的一次分配。另外,出现两次以下分配也不奇怪:Test 对象的一次分配和 Trouble 对象的一次分配。

但是,Unity 实际上进行超过一千次的分配。序列化程序不支持 null。如果序列化程序对某个对象进行序列化,并且一个字段为 null,则 Unity 将实例化该类型的新对象,并对该对象进行序列化。显然,这可能导致无限循环,因此存在七级的深度限制。达到该限制时,Unity 停止序列化具有自定义类、结构、列表或数组类型的字段。

由于 Unity 的子系统很多都是在序列化系统之上构建的,因此 Test MonoBehaviour 的这种异常大型的序列化流会导致所有这些子系统的执行速度低于必要速度。

不支持多态

如果具有 public Animal[] animals 并输入一个 Dog、一个 Cat 和一个 Giraffe 的实例,则在序列化之后有三个 Animal 实例。

解决此限制的一种方法是认识到它仅适用于内联序列化的自定义类。对其他 UnityEngine.Objects 的引用被序列化为实际引用,对于这些情况,多态确实有效。可创建一个 ScriptableObject 派生类或另一个 MonoBehaviour 派生类,并引用该类。这样做的缺点是需要在某处存储该 Monobehaviour 或脚本化对象,并且无法有效地对其进行内联序列化。

设置这些限制的原因是序列化系统的核心基础之一是提前知道对象的数据流布局;它取决于类的字段类型,而不是存储在字段内的具体内容。

提示

序列化的优化应用

您可以组织数据来确保从 Unity 的序列化获得最佳使用效果。

  • 组织数据的目的是让 Unity 序列化尽可能小的数据集。这样做的主要目的不是为了节省计算机硬盘驱动器上的空间,而是为了确保您可以保持与项目以前版本的向后兼容性。如果使用大型的序列化数据集,那么在开发后期保持向后兼容性会变得更加困难。

  • 组织数据时确保绝不会让 Unity 序列化重复的数据或缓存的数据。否则会导致向后兼容性出现严重问题:存在着很高的错误风险,因为数据太容易失去同步。

  • 避免使用嵌套的递归结构引用其他类。序列化结构的布局总是必须相同;独立于数据,仅依赖于脚本中公开的内容。引用其他对象的唯一方法是通过 UnityEngine.Object 派生的类。这些类是完全独立的;它们只互相引用,没有嵌入内容。

使 Editor 代码可热重载

重新加载脚本时,Unity 会在所有加载的脚本中序列化并存储所有变量。重新加载脚本后,Unity 会将它们恢复为序列化前的原始值。

重新加载脚本时,Unity 会恢复满足序列化要求的所有变量(包括私有变量),即使变量没有 SerializeField 属性也是如此。在某些情况下,需要特意防止恢复私有变量:例如,如果您希望从脚本重新加载后引用为 null。在这种情况下,请使用 NonSerializable 属性。

Unity 绝不会恢复静态变量,因此对于重新加载脚本后需要保留的状态,不要使用静态变量。


• 2017–05–15 页面已修订并进行了编辑审查

脚本限制
内置序列化