Unity数据持久化之Json

Unity C#

第1章: 概述

第2章: Json文件格式

第1节：Json配置规则

概述

Json文件演示代码

//注释内容

/*sakjdfkasdf
sadfasdf
asdfasdfsadf*/

//大括号包裹的代表一个对象
{
    //冒号 代表的是 键值对的对应关系
    //逗号 就是分割成员变量的间隔符
    //Json当中的键一定要用 双引号包裹
    "name":"唐老狮",
    "age":18,
    "sex":true,
    //用于测试的 浮点类型 是支持浮点数的
    "testF":1.4,
    //中括号代表数组
    "ids":[1,2,3,4],
    "students":[{"name":"小红", "age":10, "sex":false},
    {"name":"小明", "age":8, "sex":true},
    {"name":"小强", "age":7, "sex":true}],
    "home":{"address":"成都", "street":"春熙路"},
    "son":null,
    //字典的话 键会变成双引号 以后转换时要注意！！！
    "dic":{"1":"123", "2":"234"}
}

注意

在Json中，dic将以类对象的形式存储。

第2节: Excel转Json

概述

注意

该方法仅为一种比较初级的方法，更进一步的方法将用Unity编写的插件来快速执行，将在今后进行学习。

第3章: C#读取存储Json文件

第1节: JsonUtlity

JsonUtlity 序列化

知识点一 JsonUtlity是什么？

JsonUtlity 是Unity自带的用于解析Json的公共类

它可以

1.将内存中对象序列化为Json格式的字符串

2.将Json字符串反序列化为类对象

知识点二必备知识点——在文件中存读字符串

1.存储字符串到指定路径文件中

第一个参数填写的是存储的路径

第二个参数填写的是存储的字符串内容

注意：第一个参数必须是存在的文件路径如果没有对应文件夹会报错

File.WriteAllText(Application.persistentDataPath + “/Test.json”, “唐老狮存储的json文件”);

print(Application.persistentDataPath);

2.在指定路径文件中读取字符串

string str = File.ReadAllText(Application.persistentDataPath + “/Test.json”);

print(str);

知识点三使用JsonUtlity进行序列化

序列化：把内存中的数据存储到硬盘上

方法：

JsonUtility.ToJson(对象)

MrTang t = new MrTang();

t.name = “唐老狮”;

t.age = 18;

t.sex = false;

t.testF = 1.4f;

t.testD = 1.4;

t.ids = new int[] { 1, 2, 3, 4 };

t.ids2 = new List() { 1, 2, 3 };

t.dic = new Dictionary<int, string>() { { 1, “123” }, { 2, “234” } };

t.dic2 = new Dictionary<string, string>() { { “1”, “123” }, { “2”, “234” } };

t.s1 = null;new Student(1, “小红”);

t.s2s = new List() { new Student(2, “小明”), new Student(3, “小强”) };

Jsonutility提供了线程的方法可以把类对象序列化为 json字符串

string jsonStr = JsonUtility.ToJson(t);

File.WriteAllText(Application.persistentDataPath + “/MrTang.json”, jsonStr);

注意：

1.float序列化时看起来会有一些误差

2.自定义类需要加上序列化特性[System.Serializable]

3.想要序列化私有变量需要加上特性[SerializeField]

4.JsonUtility不支持字典

5.JsonUtlity存储null对象不会是null 而是默认值的数据

知识点四使用JsonUtlity进行反序列化

反序列化：把硬盘上的数据读取到内存中

方法：

JsonUtility.FromJson(字符串)

读取文件中的 Json字符串

jsonStr = File.ReadAllText(Application.persistentDataPath + “/MrTang.json”);

使用Json字符串内容转换成类对象

MrTang t2 = JsonUtility.FromJson(jsonStr, typeof(MrTang)) as MrTang;

MrTang t3 = JsonUtility.FromJson(jsonStr);

注意：

如果Json中数据少了，读取到内存中类对象中时不会报错，而是直接定为默认值。

知识点五注意事项

1.JsonUtlity无法直接读取数据集合（如下文的List是一个list的类），你需要用一个类将其装起来来进行序列化。

jsonStr = File.ReadAllText(Application.streamingAssetsPath + “/RoleInfo2.json”);

print(jsonStr);

List roleInfoList = JsonUtility.FromJson<List>(jsonStr);

RoleData data = JsonUtility.FromJson(jsonStr);

2.文本编码格式需要时UTF-8 不然无法加载

总结

1.必备知识点 —— File存读字符串的方法 ReadAllText和WriteAllText

2.JsonUtlity提供的序列化反序列化方法 ToJson 和 FromJson

3.自定义类需要加上序列化特性System.Serializable

4.私有保护成员需要加上[SerializeField]

5.JsonUtlity不支持字典

6.JsonUtlity不能直接将数据反序列化为数据集合

7.Json文档编码格式必须是UTF-8

第2节: LitJson

LitJson 序列化

知识点一 LitJson是什么？

它是一个第三方库，用于处理Json的序列化和反序列化

LitJson是C#编写的，体积小、速度快、易于使用

它可以很容易的嵌入到我们的代码中

只需要将LitJson代码拷贝到工程中即可

知识点二获取LitJson

1.前往LitJson官网

2.通过官网前往GitHub获取最新版本代码：GitHub - LitJSON/litjson: JSON library for the .Net framework

3.将代码（只需要压缩包内src里面的脚本文件即可，工程的其他部分不需要）拷贝到Unity工程中即可开始使用LitJson

知识点三使用LitJson进行序列化

方法：

JsonMapper.ToJson(对象)

MrTang2 t = new MrTang2();

t.name = “唐老狮”;

t.age = 18;

t.sex = true;

t.testF = 1.4f;

t.testD = 1.4;

t.ids = new int[] { 1, 2, 3, 4 };

t.ids2 = new List() { 1, 2, 3 };

t.dic = new Dictionary<int, string>() { { 1, “123” }, { 2, “234” } };

t.dic2 = new Dictionary<string, string>() { { “1”, “123” }, { “2”, “234” } };

t.s1 = null;new Student(1, “小红”);

t.s2s = new List() { new Student2(2, “小明”), new Student2(3, “小强”) };

string jsonStr = JsonMapper.ToJson(t);

print(Application.persistentDataPath);

File.WriteAllText(Application.persistentDataPath + “/MrTang2.json”, jsonStr);

注意：

1.相对JsonUtlity不需要加特性

2.不能序列化私有变量

3.支持字典类型,字典的键建议都是字符串因为 Json的特点 Json中的键会加上双引号

4.需要引用LitJson命名空间

5.LitJson可以准确的保存null类型

知识点四使用LitJson反序列化

方法：

JsonMapper.ToObject(字符串)

jsonStr = File.ReadAllText(Application.persistentDataPath + “/MrTang2.json”);

JsonData是LitJson提供的类对象可以用键值对的形式去访问其中的内容

JsonData data = JsonMapper.ToObject(jsonStr);

print(data[“name”]);

print(data[“age”]);

通过泛型转换更加的方便建议使用这种方式

MrTang2 t2 = JsonMapper.ToObject(jsonStr);

注意：

1.类结构需要无参构造函数，否则反序列化时报错

2.字典虽然支持但是键在使用为数值时会有问题需要使用字符串类型

知识点五注意事项

1.LitJson可以直接读取数据集合（JsonUtlity不行）

如下：

数组：

jsonStr = File.ReadAllText(Application.streamingAssetsPath + “/RoleInfo.json”);

RoleInfo2[] arr = JsonMapper.ToObject<RoleInfo2[]>(jsonStr);

List list = JsonMapper.ToObject<List>(jsonStr);

Dic字典：

jsonStr = File.ReadAllText(Application.streamingAssetsPath + “/Dic.json”);

Dictionary<string, int> dicTest = JsonMapper.ToObject<Dictionary<string, int>>(jsonStr);

2.文本编码格式需要是UTF-8 不然无法加载

总结

1.LitJson提供的序列化反序列化方法 JsonMapper.ToJson和ToObject<>

2.LitJson无需加特性

3.LitJson不支持私有变量

4.LitJson支持字典序列化反序列化

5.LitJson可以直接将数据反序列化为数据集合

6.LitJson反序列化时自定义类型需要无参构造

7.Json文档编码格式必须是UTF-8

总的来说，LitJson的使用方法甚至API几乎都和JsonUtlity一致，只不过在前者的基础上更完善的同时也有一些自己缺陷。下一节会详细对比它们的差异。

第3节: JsonUtlity和LitJson对比

知识点一 JsonUtlity和LitJson相同点

1.他们都是用于Json的序列化反序列化

2.Json文档编码格式必须是UTF-8

3.都是通过静态类进行方法调用

知识点二 JsonUtlity和LitJson不同点

1.JsonUtlity是Unity自带，LitJson是第三方需要引用命名空间

2.JsonUtlity使用时自定义类需要加特性,LitJson不需要

3.JsonUtlity支持私有变量(加特性),LitJson不支持

4.JsonUtlity不支持字典,LitJson支持(但是键只能是字符串)

5.JsonUtlity不能直接将数据反序列化为数据集合(数组字典),LitJson可以

6.JsonUtlity对自定义类不要求有无参构造，LitJson需要

7.JsonUtlity存储空对象时会存储默认值而不是null，LitJson会存null

知识点三如何选择两者

根据实际需求

建议使用LitJson

原因：LitJson不用加特性，支持字典，支持直接反序列化为数据集合，存储null更准确

第4节: 总结

知识点总结

第4章: 实践小项目

Json数据管理类代码

该单例类提供简便的保持和读取json文件的api，并且提供LitJson和JsonUtlity两种方式选择。

sing LitJson;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using UnityEngine;

/// <summary>
/// 序列化和反序列化Json时  使用的是哪种方案
/// </summary>
public enum JsonType
{
    JsonUtlity,
    LitJson,
}

/// <summary>
/// Json数据管理类 主要用于进行 Json的序列化存储到硬盘 和 反序列化从硬盘中读取到内存中
/// </summary>
public class JsonMgr
{
    private static JsonMgr instance = new JsonMgr();
    public static JsonMgr Instance => instance;

    private JsonMgr() { }

    //存储Json数据 序列化
    public void SaveData(object data, string fileName, JsonType type = JsonType.LitJson)
    {
        //确定存储路径
        string path = Application.persistentDataPath + "/" + fileName + ".json";
        //序列化 得到Json字符串
        string jsonStr = "";
        switch (type)
        {
            case JsonType.JsonUtlity:
                jsonStr = JsonUtility.ToJson(data);
                break;
            case JsonType.LitJson:
                jsonStr = JsonMapper.ToJson(data);
                break;
        }
        //把序列化的Json字符串 存储到指定路径的文件中
        File.WriteAllText(path, jsonStr);
    }

    //读取指定文件中的 Json数据 反序列化
    public T LoadData<T>(string fileName, JsonType type = JsonType.LitJson) where T : new()
    {
        //确定从哪个路径读取
        //首先先判断 默认数据文件夹中是否有我们想要的数据 如果有 就从中获取
        string path = Application.streamingAssetsPath + "/" + fileName + ".json";
        //先判断 是否存在这个文件
        //如果不存在默认文件 就从 读写文件夹中去寻找
        if(!File.Exists(path))
            path = Application.persistentDataPath + "/" + fileName + ".json";
        //如果读写文件夹中都还没有 那就返回一个默认对象
        if (!File.Exists(path))
            return new T();

        //进行反序列化
        string jsonStr = File.ReadAllText(path);
        //数据对象
        T data = default(T);
        switch (type)
        {
            case JsonType.JsonUtlity:
                data = JsonUtility.FromJson<T>(jsonStr);
                break;
            case JsonType.LitJson:
                data = JsonMapper.ToObject<T>(jsonStr);
                break;
        }

        //把对象返回出去
        return data;
    }
}

一个遗留的问题

Excel转变为Json的过程需要自动化：

解决思路：

等待之后解决

如果觉得文章对你有用，请随意赞赏

Unity数据持久化之Json

http://www.klned.com/archives/1690220899963

作者

Zhang

发布于

2023-05-20

更新于

2023-07-25

许可协议

CC BY 4.0

Unity数据持久化之Json

第1章: 概述

第2章: Json文件格式

第1节：Json配置规则

概述

Json文件演示代码

注意

第2节: Excel转Json

概述

注意

第3章: C#读取存储Json文件

第1节: JsonUtlity

JsonUtlity 序列化

知识点一 JsonUtlity是什么？

知识点二 必备知识点——在文件中存读字符串

知识点三 使用JsonUtlity进行序列化

知识点四 使用JsonUtlity进行反序列化

知识点五 注意事项

总结

第2节: LitJson

LitJson 序列化

知识点一 LitJson是什么？

知识点二 获取LitJson

知识点三 使用LitJson进行序列化

知识点四 使用LitJson反序列化

知识点五 注意事项

总结

第3节: JsonUtlity和LitJson对比

知识点一 JsonUtlity和LitJson相同点

知识点二 JsonUtlity和LitJson不同点

知识点三 如何选择两者

第4节: 总结

知识点总结

第4章: 实践小项目

Json数据管理类代码

一个遗留的问题

作者

发布于

更新于

许可协议

知识点二必备知识点——在文件中存读字符串

知识点三使用JsonUtlity进行序列化

知识点四使用JsonUtlity进行反序列化

知识点五注意事项

知识点二获取LitJson

知识点三使用LitJson进行序列化

知识点四使用LitJson反序列化

知识点五注意事项

知识点三如何选择两者