文档

Unity 引擎

Unity 引擎

Serialization 最佳实践

Serialization 的最佳做法。
阅读时间4 分钟最后更新于 5 天前

Apply以下编码实践和组织原则来防止错误并优化Project中的Serialization性能。

线程安全

大多数 Unity API 只能从主要线程调用。不要从 Serializable 类型的构造函数和 Field 初始化器调用 Unity API,因为它们运行在单独的加载线程中。
在开发版中,如果尝试从加载线程中调用主要线程 API,Unity 会抛出报错。在释放版构版本中,代码运行没有错误,但可能会在应用程序程序中产生崩溃和Other意外行为。
提示
为了减少 Serialization 期间的错误风险,请勿调用可能影响 Project 状态或涉及 Other Unity 对象的 API 方法。可安全调用的 API 包括
Debug.Log
和适用于 Simple 数据类型的 API,例如 数学函数 和
Vector3
。

finalizers:

不要从 finaler 方法启动 Serialization。终结器不ON线程运行。垃圾回收器决定它们何时运行,在某些情况下,它们可能根本无法运行。
尝试从终结器Serialize数据可能会导致意外行为和崩溃。有关更多信息,请参阅 Microsoft 文档 ON Finalizer。

组织数据

您可以按以下方式组织数据,以确保 Unity Serialization 的Optimal 使用:
  • 目标是让 Unity Serialize可能小的数据设置。这样做的目的不是为了Save计算机硬盘驱动器ON的Space,而是为了make您可以与Project的早期版本保持向后兼容性。如果在以后的开发中处理大量序列化数据,向后兼容可能会变得更加困难。
  • 永远不要让 Unity 序Serialize副本的数据或缓存的数据。这会导致向后兼容性出现严重问题:由于数据可能Sync,因此存在高的报错风险。
  • 添加引用自定义 C# 类或structs的字段When,使用谨慎。在字段中引用自定义定义 C# 类或structsWhen,Unity 会将引用Object的整个内容容嵌入到引用Object的序列化的数据中。如果此结构变得复杂或深度嵌套,则在将来Change结构时可能很难迁移此数据。此外,Object 中的数据很容易在序列化的数据中无意重复多次。相反,应力求保持 MonoBehaviour 和 ScriptableObject 派生中的结构平坦和Simple。
  • 在对象之间共享数据的方法是使用 ScriptableObjects。当您引用派生自
    UnityEngine.Object
    的类(例如派生自 ScriptableObject 的类)时,Unity 仅序列化引用,而不是整个 Object 图。因此,数据仅在 ScriptableObject 中序列化一次,而不是在引用数据的每个点。同样,如果要在单一 MonoBehaviour 或 ScriptableObject 中多次引用相同的自定义 C# 类,可以使用
    [SerializeReference]
    属性。有关更多信息,请参阅 Serialization of custom class。

其他资源