By Ne0 — May 20, 2024

Odin插件与基于元数据的编辑器实现

请商店购买Odin以支持开发者！

那一天，人类终于回想了起曾一度被Unity所支配的恐怖

Type[,]
Type[][]
List<List<Type>>
Dictionary<Type,Type>
...

这些都是游戏里很常用的数据类型，然而你！用！不！了！
要说强行序列化的办法是有的，Unity提供了自定义序列化的接口，但是麻烦得很，曾经我查了很多资料试图序列化Dictionary，最终结果依然无法让人满意，有很多问题。
也有别的解决途径，使用XML等文件形式来存储数据也是可以的，现在的项目里甚至使用了Excel文件（用以编辑地图）。
很想问为什么Unity发展了这么多年，还是不能原生支持这些类型的序列化。如果你Google一下，可以看到官方论坛里有很多这些关于序列化的问题。

在不借助插件的情况下，唯一可以简单实现的就是锯齿数组，以实现一个Int的锯齿数组为例：

public class DEMO : MonoBehaviour
{
    [System.Serializable]
    public class IntElement
    {
        public int Value;
    }
    [System.Serializable]
    public class Int2D
    {
        public IntElement[] Element;
    }

    public Int2D[] Data;
}

这样就可以获得一个类似锯齿数组的效果，也可以充当二维数组使用。当然，Unity会顺便送你一个屎一样的编辑器。

显然这个编辑器是没法用的，所以你就要写CustomEditor，然后你发现你花了半天写出来的编辑器虽然能用，但是扩展性糟糕，代码难读修改困难。唯一慰藉就是写成之后还稍稍有点成就感。

现在！你有了Odin！

导入插件后，编写代码：

using Sirenix.OdinInspector; //记得Using插件的名字空间

public class DEMO : SerializedMonoBehaviour //要使用Odin的序列化功能需要改为从这个类型派生
{
    [BoxGroup("Data_A")]
    public int[,] Data_A = new int[3, 3];
    public int[][] Data_B = new int[3][];
    public List<List<int>> Data_C = new List<List<int>>();
    public Dictionary<string, int> Data_D = new Dictionary<string, int>();
}

然后...

就是这么快速、简单、无痛。

超强的编辑器扩展！

Unity自带了一些Attributes，比如[Header]、[Range]、[Multiline]、[Space]等，只能对Inspector进行一些简单的扩展和编辑。Odin除了序列化的功能，还包括了强大的编辑器扩展能力，新增了几十种Attributes！

以上是Odin自带的DEMO中的几个范例，如此复杂的编辑器界面仅仅是在属性上添加数个Attributes就实现了。

Odin插件已经运用在手头上的项目上了，根据几个月的使用经验，几乎不需要自己重写编辑器界面，仅靠Attributes的搭配使用就可以完成绝大部分编辑器界面需求了。当然Odin也提供了加强版的编辑器Drawer，如果Attributes不满足需求，自己重写编辑器也会比Unity原生简单许多。
另外提一点，Odin兼容各个平台，但是如果使用了自定义的序列化类型并且需要在PC以外的平台发布的话，需要Tool→Odin Inspector→Preferences→AOT Generation页面里生成一下DLL，否则会报错。

具体使用方法就不说了，参照插件自带的DEMO场景和就可以很容易学会使用了。

最后

Odin实在是太好用，用过之后感觉已经回不去了，现在开个项目第一件事就是导入Odin插件，毕竟之前因为这些问题而疯狂受苦。这里会提供一个旧版本的下载，这个版本可以稳定运行在最新的Unity2017.3，如果有条件请在Asset Store中支持开发者。

Unity引擎对于自定义编辑器的支持已经比传统的游戏引擎要方便一个等级了，它基于Unity的反射机制，在界面框架内已经实现了非常方便的属性编辑功能，比如最为常见和常用的MonoBehavior的属性编辑和查看。相比于自研引擎要自己实现前文所描述的这套元数据编辑器框架，对于常规的配置需求Unity已经做得更好了。

然而，作为开发者来说还是有更加复杂的需求是Unity这套结构目前所不支持的，比如Dictionary的编辑，比如一些动态的显隐控制。好在Unity有强大的Asset Store，Odin这样的插件也就应运而生，虽然55美元的售价稍微有些贵，但我觉得它绝对物超所值！引用一段官方介绍来描述其功能：

Odin puts your Unity workflow on steroids, making it easy to build powerful and advanced user-friendly editors for you and your entire team. With an effortless integration that deploys perfectly into pre-existing workflows, Odin allows you to serialize anything and enjoy Unity with 80+ new inspector attributes, no boilerplate code and so much more!

简答来说，它通过提供更多的新属性来方便我们编写强大的编辑器功能，并且提供了序列化模块。抛开序列化不说，我就举几个自己真正使用过的例子来描述它的一些好用功能。