03Json序列化

2024-04-14 1681 words 4 minutes

Contents

JSON序列化

JSON是一种通用的数据格式结构。Unity中有很多工具可以将Class转换成JSON结构并持久化。本文主要记录一些Unity中可以用到的JSON序列化库工具，并且做一些简单的对比。以方便将来JSON相关的时候进行处理。

目前看到主要有一些JSON序列化工具

JsonUtility
LitJson
Newtonsoft.Json

基础效率对比

工具名	序列化(ms)	反序列化	数据大小
次数	$10^6$	$10^5$
JsonUtility	4106	740	164
LitJson	20096	8553	175
Newtonsoft.Json	31540	4971	174

一个简单的序列化结果对比：类型描述

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


[Serializable]
public class JsonTestTarget
{
    public string strValue;
    public int intValue;
    public float floatValue;
    public InnerJsonTestTarget innerTarget;
    public Dictionary<string, int> dictValue;
    public List<int> listValue;
}

[Serializable]
public class InnerJsonTestTarget
{
    public string strValue;
    public int intValue;
    public float floatValue;
}

序列化后的结果：

1
2
3
4
5
6


// JsonUtility 长度:164
{"strValue":"Test1","intValue":10,"floatValue":10.539999961853028,"innerTarget":{"strValue":"InnerTest1","intValue":1239,"floatValue":1940.0},"listValue":[2,3,5,7]}
// JsonLit 长度:175
{"strValue":"Test1","intValue":10,"floatValue":10.54,"innerTarget":{"strValue":"InnerTest1","intValue":1239,"floatValue":1940.0},"dictValue":{"key1":10},"listValue":[2,3,5,7]}
// Newtonsoft.Json 长度:174
{"strValue":"Test1","intValue":10,"floatValue":10.54,"innerTarget":{"strValue":"InnerTest1","intValue":1239,"floatValue":1940},"dictValue":{"key1":10},"listValue":[2,3,5,7]}

但每个工具都有细节，可以参看下面的说明：

JsonUtility

Unity自带的序列化工具，使用起来简单，速度是最快的。

官方文档说明，其序列化实例的类型必须是MonoBehaviour，ScriptableObject或者被Serializable attribute标注的普通Class/Struct。不支持的字段会被忽略，例如private field，static field以及那些被NonSerialized attribute标注的字段。

另一点是，尽量传递原始类型给该方法，因为有些情况下，其序列化结果不一定如预期一样。例如传递一个数组进入该方法，其不会产生一个包含每个元素的JSON数组，而是一个对象，包含了数组中对象的所有public field。

对于JsonUtility支持的序列化类型可参考Unity的Serialization Rule： https://docs.unity3d.com/Manual/script-Serialization.html

但是其实际支持的数据格式有限，支持以下类型：

基础数据类型
- 数字数据类型：int,float,double,decimal,long等
- 字符数据类型：char,string
- Unity内置类型：Vector2,Vector3,Quarteration等
容器数据类型
- 支持List,Array集合类型
- 不支持Dictionary,Query,stack等集合类型，而且对应字段不会出现在json中。
对于传入的类型，可以不用Serializable标注。但是如果其内部字段为某个类型，则对应类型需要用Serializable标注，才可以序列化。而且标注的类型被嵌套在List,Array中也可以被序列化。例如如下结构也可被序列化：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


public class JsonUtilityTarget
{
    public JsonInnerTarget innerValue;
    public List<JsonInnerTarget> innerList;
}

[Serializable]
public class JsonInnerTarget
{
    public int intValue;
}