Unity编辑器中Dictionary的序列化

编程入门行业动态更新时间:2024-10-28 04:26:39

编辑器Dictionary序列化

开发过程中，经常需要在Unity的Inspector面板中对场景进行一些数据配置。Unity也为我们提供了许多序列化数据的方式，不过没有提供Dictionary数据的可视化序列化；今天在AssetStrore中找到一款免费的SerializableDictionary插件，非常轻巧，可是很方便，你可以根据自己的需求自定义你需要序列化的Dictionary类型，且不需要写任何写编辑器代码。当你的键值无效或者重复时，会触发警告。

AssetStore: SerializableDictionary

作者为我们提供了一些默认的字典类型，但是我们可以根据自己的需求，自定义一些可在Inspector面板中进行可视化操作的字典类型。

例子一

定义一个支持可视化操作的Dictionary<string,string>

游戏Unity中是不支持泛型数据的序列化的，所以我们序列化对象时需要制定要被序列化的对象的具体类型。

首先在UserSerializableDictionaries.cs文件中声明我们要序列化的字典类型。

[Serializable]
public class StringStringDictionary : SerializableDictionary<string, string> { }

在UserSerializableDictionaryPropertyDrawers.cs中定义需要可视化的字典。

[CustomPropertyDrawer(typeof(StringStringDictionary))]
public class AnySerializableDictionaryPropertyDrawer : SerializableDictionaryPropertyDrawer {}

例子二

定义一个支持可视化操作的 ***Dictionary<string,List< GameObject> >***

由于Unity中不支持序列化嵌套集合和嵌套数组，如果我们使用SerializableDictionary<TKey,TValue[]> 或者SerializableDictionary<TKey,List> 的方式来进行字典的可视化操作，这是不可行的，它不会在 Inspector 面板中显示且值也不会被保存。

所以，我们必须创建一个中间类，在UserSerializableDictionaries.cs文件中声明我们要存储的数据类型，将 List 或者 Array 包裹在其中，如下：

[Serializable]
public class ListGameObjectStorage : SerializableDictionary.Storage<List<GameObject>> { }

声明需要定义的字典类型(注意这里定义了第三个参数，用来指定存储的数据类型)：

[Serializable]
public class StringListObjectsDictionary : SerializableDictionary<string, List<GameObject>,ListGameObjectStorage> { }

在UserSerializableDictionaryPropertyDrawers.cs中定义需要可视化的字典。

[CustomPropertyDrawer(typeof(ListGameObjectStorage))]
public class AnySerializableDictionaryStoragePropertyDrawer: SerializableDictionaryStoragePropertyDrawer {}

[CustomPropertyDrawer(typeof(StringListObjectsDictionary))]
public class AnySerializableDictionaryPropertyDrawer : SerializableDictionaryPropertyDrawer {}

例子三

在字典中可视化操作自定义的数据类型。

Dictionary<string,List< SkyBoxLightingPair > >

假如，我有一个如下的数据类型，需要使用字符串作为键值的形式将其保存在字典中，且要支持 Inspector 面板中的可视化操作。自定义数据类型如下：

[Serializable]
public class SkyBoxLightingPair
{
    public Material skyBoxmaterial;
    public string name;
    public List<string> answerList;
    public Vector3 sunEulerAngles;
    public Dictionary<string,List<GameObject>> mydict=new Dictionary<string, List<GameObject>>();
    public void Show()
    {
        Debug.Log(name);
        Debug.Log(answerList.Count);
        Debug.Log(sunEulerAngles);
    }
}

在UserSerializableDictionaries.cs中为自定义的数据类型定义中间类

[Serializable]
public class ListSkyBoxLightingPairStroge:SerializableDictionary.Storage<List<SkyBoxLightingPair>>{}

声明需要在字典中序列化的数据类型

[Serializable]
public class StringSkyBoxConfigPairDictonary:SerializableDictionary<string,List<SkyBoxLightingPair>,ListSkyBoxLightingPairStroge>{}

为上述定义的数据类型添加属性在 Inspector 面板中绘制的声明：

[CustomPropertyDrawer(typeof(ListSkyBoxLightingPairStroge))]
public class AnySerializableDictionaryStoragePropertyDrawer: SerializableDictionaryStoragePropertyDrawer {}

[CustomPropertyDrawer(typeof(StringSkyBoxConfigPairDictonary))]
public class AnySerializableDictionaryPropertyDrawer : SerializableDictionaryPropertyDrawer {}