Unity高级-数据序列化-Json

JSON

JSON（JavaScript Object Notation） 是一种轻量级的数据交换格式。它基于 [ECMAScript] (欧洲计算机协会制定的js规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。 易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

JSON 语法规则

在 JS 语言中，一切都是对象。因此，任何支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。但是对象和数组是比较特殊且常用的两种类型：
对象表示为键值对
数据由逗号分隔
花括号保存对象
方括号保存数组

JSON 键/值对

JSON 键值对是用来保存 JS 对象的一种方式，和 JS 对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号 "" 包裹，使用冒号 : 分隔，然后紧接着值：
{"firstName": "Json"}
这很容易理解，等价于这条 JavaScript 语句：
{firstName : "Json"}

JSON 与 JS 对象的关系

很多人搞不清楚 JSON 和 Js 对象的关系，甚至连谁是谁都不清楚。其实，可以这么理解：
JSON 是 JS 对象的字符串表示法，它使用文本表示一个 JS 对象的信息，本质是一个字符串。
如
var obj = {a: 'Hello', b: 'World'};//这是一个对象，注意键名也是可以使用引号包裹的。
var json = '{"a": "Hello", "b": "World"}';//这是一个 JSON 字符串，本质是一个字符串。

和XML的比较

可读性

JSON和XML的可读性可谓不相上下，一边是简易的语法，一边是规范的标签形式，很难分出胜负。

可扩展性

XML天生有很好的扩展性，JSON当然也有，没有什么是XML可以扩展而JSON却不能扩展的。而且JSON可以存储Javascript复合对象，有着xml不可比拟的优势。

Json解析-LitJson

using LitJson;
using System;

public class Person
{
    // C# 3.0 auto-implemented properties
    public string   Name     { get; set; }
    public int      Age      { get; set; }
    public DateTime Birthday { get; set; }
}

public class JsonSample
{
    public static void Main()
    {
        PersonToJson();
        JsonToPerson();
    }

    public static void PersonToJson()
    {
        Person bill = new Person();

        bill.Name = "William Shakespeare";
        bill.Age  = 51;
        bill.Birthday = new DateTime(1564, 4, 26);

        string json_bill = JsonMapper.ToJson(bill);

        Console.WriteLine(json_bill);
    }

    public static void JsonToPerson()
    {
        string json = @"
            {
                ""Name""     : ""Thomas More"",
                ""Age""      : 57,
                ""Birthday"" : ""02/07/1478 00:00:00""
            }";

        Person thomas = JsonMapper.ToObject(json);

        Console.WriteLine("Thomas' age: {0}", thomas.Age);
    }
}

Json解析-JsonUtility

JsonUtility-Unity5引入的Json工具，
原本Json相对简单，但是这套工具使用的是Unity Serializer。和我们日常使用的Json序列化有点差异。
支持序列化MonoBehaviour的子类，ScriptableObject的子类以及包含[Serializable]标签的类和结构。
这套Api主要优势是Unity内置，可以序列化和反序列化Vector3等数据。在很多简单的场景，可以方便我们开发。总的来说就是不好用。可以结合其他json工具使用。

序列化ScriptableObject和MonoBehavior

public class JsonTest : MonoBehaviour
{
    /// 

    /// 序列化字段
    /// 
    public int Value;

    void Start()
    {
        // 赋值Value为2
        Value = 1;

        // {"Value":1}
        var json = JsonUtility.ToJson(this);

        // 赋值Value为2
        Value = 2;

        // 数据被重新写入，Value赋值为1
        JsonUtility.FromJsonOverwrite(json, this);

        // ArgumentException: Cannot deserialize JSON to new instances of type 'JsonTest.'
        // 不支持直接反序列化生成一个MonoBehavior的子类
        var fromJson = JsonUtility.FromJson(json);
    }
}

序列化List和Dictionary和Array

如果要支持List和Array，建议写一个包装类，将其包含再里边。并且泛型中加入[Serializable]标签
如果要支持Dictionary，建议改写成List。

// 没有包含[Serializable]的类，不可被包含在序列化类内
public class Item1
{
    public string Str;
}

// 包含标签可以正常序列化
[Serializable]
public class Item2
{
    public string Str;
}

public class ListCollection
{
    // 可正常序列化
    public List Item0;
    // 没有标签不可正常序列化
    public List Item1;
    // 有标签可以正常序列化
    public List Item2;
}

public void Run()
{
    var collection = new ListCollection()
    {
        Item0 = new List() { 0, 1, 2, 3, 4 },
        Item1 = new List() { new Item1() { Str = "1" }, new Item1() { Str = "2" } },
        Item2 = new List() { new Item2() { Str = "1" }, new Item2() { Str = "2" } }
    };

    // {"Item0":[0,1,2,3,4],"Item2":[{"Str":"1"},{"Str":"2"}]}
    Debug.Log(JsonUtility.ToJson(collection));
    // {}
    Debug.Log(JsonUtility.ToJson(collection.Item0));
    // {}
    Debug.Log(JsonUtility.ToJson(collection.Item1));
    // {}
    Debug.Log(JsonUtility.ToJson(collection.Item2));

    // ArgumentException: JSON must represent an object type.
    var fromJson = JsonUtility.FromJson>("[0,1,2,3,4]");
    Debug.Log(fromJson.Count);
}

这里提供一个快速包装方法。需要的朋友可以考虑使用。

// 出处: https://forum.unity3d.com/threads/how-to-load-an-array-with-jsonutility.375735/#post-2585129
public class JsonHelper
{
    public static T[] getJsonArray(string json)
    {
        string newJson = "{ \"array\": " + json + "}";
        Wrapper wrapper = JsonUtility.FromJson> (newJson);
        return wrapper.array;
    }

    [Serializable]
    private class Wrapper
    {
        public T[] array;
    }
}