文档

Unity 引擎

Unity 引擎

SerializationRules

确定脚本中的字段是否序列化的条件。
阅读时间7 分钟最后更新于 5 天前

Unity 使用自己的 Serialization System,该系统专为在运行时高效运行而设计。因此,Unity 中的Serialization与Other编程环境中的Serialization化行为不同。
Unity 支持标准的 .NET/C#
[Serializable]
和
[NonSerialized]
Attributes,但它们在 Unity 中的行为受 Unity 指定的其他注意事项的约束。Unity 不会自动 Serialize 标记为
[Serializable]
的类,除非该类满足以下各节概述的 Unity Serialization Rules。
Unity 会自动序列化从
UnityEngine.Object
Inherit 继承的内置 Unity 类型,因此您只需将
[Serializable]
应用于这些 Unity 对象中用作字段的自定义类或 structs。
[NonSerialized]
属性在 Unity 中与在标准 C# 中一样用于排除 Serialization 中的字段。但是,在 Unity 上下文中,这也会阻止 Inspector 序列化或显示该 Field。Unity 有自己的属性
[HideInInspector]
,可在 Inspector 中隐藏 Field 而不会阻止 Serialization。

FieldSerializationRules

Unity 中的序列化程序直接 ON C# 类的字段,而不是其 Properties,因此 Unity 仅当字段满足特定条件时才对其进行序列化。以下部分Outlines了如何在 Unity 中使用FieldSerialization。
要使用FieldSerialization,必须确保Field:
  • 是
    public
    ,或具有
    [SerializeField]
    属性
    • 注意
      在某些情况下,
      private
      字段被序列化,请参阅热重新加载
  • 不是
    static
  • 不是
    const
  • 不是
    readonly
  • 具有可序列化的 Field 类型:
    • 原始数据类型(整型、浮点、双例、bool、字符串等)。
    • enum 类型(32 位或更小)。
    • 已修复大小的缓冲区。
    • Unity 内置类型,例如二维向量、矢量、矩形、Matrix4x4、颜色、AnimationCurve。
    • 具有
      [Serializable]
      属性的自定义 structs。
    • 对派生自 UnityEngine.Object 的对象的引用。
    • 具有
      [Serializable]
      属性的自定义类。(请参阅Serialization of Custom class)。
    • 以前列出的 Field 类型之一的 Array 或
      List<T>
      。使用默认按值,如果一个元件在列表或Array中出现两次,则序列化版本的Collection将有两个该元件的副本,而不是出现两次的复制。按引用序列化类CollectionWhen,会保留对同一Object的多个次引用。如需了解更多信息,请参阅
      [SerializeReference]
      API 文档
      。
注意
Unity 不Support多级类型(多维数组、锯齿数组、字典和嵌套容器类型)的Serialization。如果Serialize它们,有两个选项:

自定义类的Serialization

Unity 要Serialize自定类,必须确保类:
当您将
UnityEngine.Object
派生类的实例分配给某个 Field 并且 Unity 保存该 Field 时,Unity 会将该 Field 序列化为该实例的引用。Unity 会独立序列化实例本身,因此在为实例分配多个个字段When不会重复。但对于不派生自
UnityEngine.Object
的自定义类,Unity 会直接将实例的状态包含在引用它们的 MonoBehaviour 或 ScriptableObject 的序列化数据中。有两种方法可以做到这一点:内联和**
[SerializeReference]
**。
  • Inline Serialization:默认情况下,当您未在引用类的 Field 上指定
    [SerializeReference]
    时,Unity 会按值内联序列化自定义类。这意味着,如果将对自定义类实例的引用存储在多个不同字段中,则在序列化When它们将成为单独的对象。然后,When Unity 反序列化字段时,它们包含具有相同数据的不同对象。
  • [SerializeReference]
    Serialization
    :如果您确实指定了
    [SerializeReference]
    ,Unity 会将 Object 建立为 Managed 引用。Host Object 仍然将对象直接存储在其序列化的数据中,但存储在专用的注册表部分中。
[SerializeReference]
会增加一些开销,但支持以下情况:
  • 字段可以为 null。内Serialization不能表示 null,而是用具有未分配字段的内联Object替换 null。
  • 对同一Object的多个引用。如果在不使用
    [SerializeReference]
    的情况下将自定义类实例的引用存储在多个不同字段中,那么当序列化时,它们将成为单独的对象。
  • 图形和循环数据(例如,具有回传到自身的引用的Object)。内类Serialization不Support null 或共享引用,因此数据中的Any循环都可能导致意外结果,例如奇怪的 Inspector 行为、控制控制台错误或无限循环。
  • 多态。如果创建一个派生自父类的类并将其分配给使用父类作为其类型的 Field,则没有
    [SerializeReference]
    Unity 只会序列化属于父类的字段。Unity 反序列化类实例When,它会实例化类不是派类
  • When数据结构需要稳定标识符来点指定的Object时,无需硬编码Object的Array位置或searching整个Array。请参阅 Serialization.ManagedReferenceUtility.SetManagedReferenceIdForObject。
注意
Inline Serialization 更加高效,除非您特别需要
[SerializeReference]
支持的功能之一,否则您应该使用它。ON 如何使用
[SerializeReference]
的完整细节,请参阅 SerializeReference 文档。

Properties的Serialization

Unity 普通不会 Serialize Properties,但以下情况除外:
  • 如果属性具有显式后备 Field,Unity 将根据常规 Serialization Rules 对其进行序列化。例如:
public int MyInt{get => m_backing;private 设置 => m_backing = 值;}[SerializeField] private int m_backing;
  • Unity 仅在热重新加载期间使用自动生成的字段序列化 Properties。
public int MyInt { get; set; }
如果不希望 Unity 使用自动生成的字段来 Serialize 属性,请使用
[field: NonSerialized]
属性。

其他资源