【推荐100个unity插件之37】unity使用三种方式实现对Json数据的序列化和反序列化持久化存储，并举例分析JsonUtlity、LitJSON和Newtonsoft的区别

已于 2025-01-13 21:02:39 修改
阅读量2k 收藏 28
点赞数 33
分类专栏： # 推荐100个unity插件 文章标签： unity json 游戏引擎 游戏 开发语言
于 2024-12-05 10:20:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36303853/article/details/144166951
版权

文章目录

前言

unity对Json数据的序列化和反序列化其实之前已经做过很多了，但是都是零零散散，并没有进行系统的整理，这次我特地单独拿出来讲讲。

传送门：
【unity框架开发12】从零手搓unity存档存储数据持久化系统，实现对存档的创建，获取，保存，加载，删除，缓存，加密，支持多存档（2024/11/23补充）

【推荐100个unity插件之20】一个强大的JSON处理库——Newtonsoft.Json（也称为Json.NET）

【unity框架开发12】从零手搓unity存档存储数据持久化系统，实现对存档的创建，获取，保存，加载，删除，缓存，加密，支持多存档（2024/11/23补充）

一、前置知识

1、获取各种文件路径

Application.persistentDataPath获取的是一个持久化的数据路径，在不同的操作系统上，unity会为我们分配不同的持久化数据路径，这样可以确保应用程序在不同平台上都能正确保存和访问

//设置存档文件路径
savePath = Path.Combine(Application.persistentDataPath, "saveData.json");

不同平台存储的路径不一样，我们可以打印savePath查看自己的存储路径

比如我PC上的就是
在这里插入图片描述

其他：https://blog.csdn.net/qq_36303853/article/details/129688513

2、将字符串存入文件中

File.WriteAllText()将字符串写入到指定路径文件中

  • 第一个参数填写的是存储的路径
  • 第二个参数填写的是存储的字符串内容
  • 注意：第一个参数必须是存在的文件路径如果没有对应文件夹会报错
File.WriteAllText(Application.persistentDataPath + "/Test.json", "json文件");

3、读取文件中的字符串内容

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

4、什么是序列化和反序列化

  • 序列化其实就是把内存中的数据存储到硬盘上
  • 反序列化其实就是把硬盘上的数据读取到内存中

二、JsonUtlity

1、JsonUtlity是什么？

JsonUtlity是Unity自带的用于解析Json的公共类
它可以：

  • 将内存中对象序列化为Json格式的字符串
  • 将Json字符串反序列化为类对象

2、注意

  • float序列化时看起来会有一些误差,但是读取其实不影响
  • 自定义类需要加上序列化特性[System.Serializable]
  • 想要序列化私有变量需要加上特性[SerializeField]
  • JsonUtlity可以序列化vector Color Quaternion等数据
  • JsonUtlity不支持字典
  • JsonUtlity存储null数据不会是null，而是默认值，比如string就会是空字符""

3、实例

定义一些不同类型的数据

public class Data{
    public string name = "小明";
    public string name2 = null;
    public int age = 12;
    public float height = 1.85f;
    public int[] ids = {1, 2, 3};
    public List<int> list = new List<int>{11, 22, 33};
    public Dictionary<int, string> intDic = new Dictionary<int, string>{{1, "内容1"}, {2, "内容2"}, {3, "内容3"}};
    public Dictionary<string, string> strDic = new Dictionary<string, string>{{"key1", "内容1"}, {"key2", "内容2"}, {"key3", "内容3"}};
    public Son son2 = new Son("子数据", 1);
    public List<Son> listSon = new List<Son>{new Son("数据1", 1), new Son("子数据2", 2)};
    public Vector3 vector3 = new Vector3(1, 2, 1);
    public Color color = Color.red;
    public Quaternion rotation = Quaternion.Euler(0f, 90f, 0f);
    [SerializeField]
    private int privateInt = 66;
    [SerializeField]
    protected int protectedInt = 77;

    public override string ToString()
    {
        string result = $"Name: {name}, Name2: {name2}, Age: {age}, Height: {height}, " +
                        $"IDs: {string.Join(", ", ids)}, List: {string.Join(", ", list)}\n" +
                        $"IntDic: {string.Join(", ", intDic)}, StrDic: {string.Join(", ", strDic)}\n" +
                        $"Son2: {son2}, ListSon: {string.Join(", ", listSon)}\n" +
                        $"vector3: {vector3}, color: {color}, rotation: {rotation}\n" +
                        $"privateInt: {privateInt}, protectedInt: {protectedInt}";
        return result;
    }
}

[System.Serializable]
public class Son{
    public string name;
    public int age;

    public Son(string name, int age){
        this.name = name;
        this.age = age;
    }
}

使用JsonUtility.ToJson进行序列化

Data data = new Data();
string jsonData = JsonUtility.ToJson(data);
File.WriteAllText(Application.persistentDataPath + "/Test.json", jsonData);

存储结果

可以看到如前面所说，字典无法存储，float类型存储有些误差，null数据存储的是默认值
在这里插入图片描述

使用JsonUtlity进行反序列化

string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
Data data2 = JsonUtility.FromJson<Data>(jsonStr);
print(data2.ToString());

打印结果，这里还是有打印出字典的原因是因为，字典数据没有读取到，所以输出了默认值
在这里插入图片描述

4、JsonUtility不能直接将数据反序列化为数据集合

比如我们想读取这样的数组json数据
在这里插入图片描述
定义数据

public class Data1
{
    public string name;
    public int age;
    
    public override string ToString()
    {
        string result = $"name: {name}, age: {age}";
        return result;
    }
}

读取

string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
List<Data1> data2 = JsonUtility.FromJson<List<Data1>>(jsonStr);
print(data2[0].ToString());

结果直接会报错
在这里插入图片描述

5、总结

  • File存读字符串的方法ReadAllText和WriteAllText
  • JsonUtility提供的序列化反序列化方法ToJson和FromJson
  • 自定义类需要加上序列化特性[System.Serializable]
  • 想要序列化私有变量需要加上特性[SerializeField]
  • JsonUtility不支持字典
  • JsonUtility不能直接将数据反序列化为数据集合
  • Json文档编码格式必须是UTF-8

三、LitJSON

1、什么是LitJSON？

它是一个第三方库，用于处理Jso的序列化和反序列化,LitJson是c#编写的，体积小、速度快、易于使用,它可以很容易的嵌入到我们的代码中,只需要将LitJson代码拷贝到工程中即可

2、获取LitJson

官网

https://litjson.net/

GitHub

https://github.com/LitJSON/litjson
在这里插入图片描述
导入LitJson进项目
在这里插入图片描述

留代码即可
在这里插入图片描述

3、注意

  • 相对于JsonUtility不需要加特性
  • 不能序列化私有变量
  • 支持字典类型，字典的键建议都是字符串因为Json的特点Json中的键会加上双引号
  • 需要导入LitJson和引用LitJson命名空间
  • LitJson可以准确的保存null类型
  • LitJson无法序列化vector Color Quaternion等数据
  • 类结构需要无参构造函数，否则反序列化时报错
  • 字典虽然支持，但是键为数值反序列化时会有问题，所以字典的键需要严格使用字符串类型才对

4、案例

定义一些不同类型的数据

public class Data{
    public string name = "小明";
    public string name2 = null;
    public int age = 12;
    public float height = 1.85f;
    public int[] ids = {1, 2, 3};
    public List<int> list = new List<int>{11, 22, 33};
    public Dictionary<string, string> strDic = new Dictionary<string, string>{{"key1", "内容1"}, {"key2", "内容2"}, {"key3", "内容3"}};
    public Son son2 = new Son("子数据", 1);
    public List<Son> listSon = new List<Son>{new Son("数据1", 1), new Son("子数据2", 2)};
	
	public override string ToString()
    {
        string result = $"Name: {name}, Name2: {name2}, Age: {age}, Height: {height}, " +
                        $"IDs: {string.Join(", ", ids)}, List: {string.Join(", ", list)}\n" +
                        $"StrDic: {string.Join(", ", strDic)}\n" +
                        $"Son2: {son2}, ListSon: {string.Join(", ", listSon)}\n";
        return result;
    }
}

public class Son{
    public string name;
    public int age;
	
	//注意不能省略，下面会说原因
	public Son() { }
	
    public Son(string name, int age){
        this.name = name;
        this.age = age;
    }
}

使用LitJson序列化

Data data = new Data();
string jsonData = JsonMapper.ToJson(data);
File.WriteAllText(Application.persistentDataPath + "/Test.json", jsonData);

存储结果
在这里插入图片描述

使用LitJson进行反序列化

string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
Data data2 = JsonMapper.ToObject<Data>(jsonStr);
print(data2.ToString());

打印结果
在这里插入图片描述

再次强调

  • 类结构需要无参构造函数，否则反序列化时报错，也就是我前面public Son() { }不能省略的原因
  • 字典虽然支持，但是键为数值反序列化时会有问题，所以字典的键需要严格使用字符串类型才对

5、LitJson能直接将数据反序列化为数据集合

比如我们想读取这样的数组json数据
在这里插入图片描述
定义数据

public class Data1
{
    public string name;
    public int age;
    
    public override string ToString()
    {
        string result = $"name: {name}, age: {age}";
        return result;
    }
}

读取

string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
List<Data1> data2 = JsonMapper.ToObject<List<Data1>>(jsonStr);
print(data2[0].ToString());

结果
在这里插入图片描述

6、总结

  • LitJson提供的序列化反序列化方法JsonMapper.ToJson和JsonMapper.ToObject<>
  • LitJson无需加特性
  • LitJson不支持私有变量
  • LitJson支持字典序列化反序列化
  • 字典虽然支持，但是键为数值反序列化时会有问题，所以字典的键需要严格使用字符串类型才对
  • LitJson可以直接将数据反序列化为数据集合
  • LitJson反序列化时自定义类型需要无参构造
  • Json文档编码格式必须是UTF-8
  • 使用LitJson需要导入LitJson和引用LitJson命名空间
  • LitJson可以准确的保存null类型
  • LitJson无法序列化vector Color Quaternion等数据

四、Newtonsoft

1、什么是Newtonsoft？

Newtonsoft.Json 是一个非常流行的 C# JSON 序列化和反序列化库，它可以方便地将 C# 对象转换为 JSON 格式，或者将 JSON 数据解析为 C# 对象。

相比其他的JSON工具，Newtonsoft.Json支持绝大多数平台。有着最丰富的功能和API，不夸张的说，可以支持所有的数据结构类型，包括你自定义的数据结构类型，且序列化反序列化过程可定制。

与之相对的，Newtonsoft.Json的包体也会稍大，如果对包体的大小不追求极限的话，可以说Newtonsoft.Json就是你在Unity开发中使用Json的不二之选。

2、获取Newtonsoft

直接在unity安装插件支持即可
在这里插入图片描述
如果安装了还是无法使用，记得重启unity再试即可

3、注意

  • 使用Newtonsoft需要引入Newtonsoft.Json命名空间
  • Newtonsoft无需加特性
  • Newtonsoft不支持私有变量
  • Newtonsoft支持键为数值或者字符串的字典序列化反序列化
  • Newtonsoft可以直接将数据反序列化为数据集合
  • Newtonsoft可以准确的保存null类型
  • Newtonsoft可以序列化vector Color Quaternion等数据，不过需要额外配JsonSerializerSettings参数

4、案例

定义一些不同类型的数据

public class Data
{
    public string name = "小明";
    public string name2 = null;
    public int age = 12;
    public float height = 1.85f;
    public int[] ids = { 1, 2, 3 };
    public List<int> list = new List<int> { 11, 22, 33 };
    public Dictionary<int, string> intDic = new Dictionary<int, string> { { 1, "内容1" }, { 2, "内容2" }, { 3, "内容3" } };
    public Dictionary<string, string> strDic = new Dictionary<string, string> { { "key1", "内容1" }, { "key2", "内容2" }, { "key3", "内容3" } };
    public Son son2 = new Son("子数据", 1);
    public List<Son> listSon = new List<Son> { new Son("数据1", 1), new Son("子数据2", 2) };
    public Vector3 vector3 = new Vector3(1, 2, 1);
    public Color color = Color.red;
    public Quaternion rotation = Quaternion.Euler(0f, 90f, 0f);

    public override string ToString()
    {
        string result = $"Name: {name}, Name2: {name2}, Age: {age}, Height: {height}, " +
                        $"IDs: {string.Join(", ", ids)}, List: {string.Join(", ", list)}\n" +
                        $"IntDic: {string.Join(", ", intDic)}, StrDic: {string.Join(", ", strDic)}\n" +
                        $"Son2: {son2}, ListSon: {string.Join(", ", listSon)}\n"+
                        $"vector3: {vector3}, color: {color}, rotation: {rotation}";
        return result;
    }
}

public class Son
{
    public string name;
    public int age;

    public Son(string name, int age)
    {
        this.name = name;
        this.age = age;
    }
}

使用Newtonsoft序列化

Data data = new Data();
var settings = new JsonSerializerSettings
{
    TypeNameHandling = TypeNameHandling.Auto,
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
    Formatting = Formatting.Indented,
};
string jsonData = JsonConvert.SerializeObject(data, settings);
File.WriteAllText(Application.persistentDataPath + "/Test.json", jsonData);

JsonSerializerSettings 对象介绍

TypeNameHandling = TypeNameHandling.Auto:

  • 这个设置告诉 JSON 序列化器在序列化对象时，自动将类型信息包含在 JSON 数据中。这样，当你反序列化该 JSON 字符串时，可以恢复对象的确切类型。
  • Auto 选项表示只会在对象中包含具体类型信息，如果遇到继承自某个基类的类型时，会自动添加基类的类型信息。其他选项还包括 None（不包括类型信息）和 All（包括所有类型信息）。

ReferenceLoopHandling = ReferenceLoopHandling.Ignore:

  • 这个设置指定在序列化时遇到引用循环（例如，一个对象的属性又引用了自己或其父对象时）应该如何处理。设置为 Ignore 时，序列化器会跳过这些循环引用。
  • 这种情况通常出现在包含互相引用的复杂对象结构中，比如两个对象相互引用对方。

Formatting = Formatting.Indented:

  • 设置序列化的 JSON 字符串格式。Indented 会让输出的 JSON 格式化成易读的缩进格式（即，每层嵌套都会有缩进）。这在调试时非常有用，因为它使得 JSON 内容更加清晰。

结果，因为前面设置了Formatting = Formatting.Indented，存储的内容格式就是这样，我并没有进行美化
在这里插入图片描述

使用Newtonsoft进行反序列化

var settings = new JsonSerializerSettings
{
    TypeNameHandling = TypeNameHandling.Auto,
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
    Formatting = Formatting.Indented,
};
string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
Data data2 = JsonConvert.DeserializeObject<Data>(jsonStr, settings);
print(data2.ToString());

打印结果
在这里插入图片描述

5、Newtonsoft能直接将数据反序列化为数据集合

比如我们想读取这样的数组json数据
在这里插入图片描述
定义数据

public class Data1
{
    public string name;
    public int age;
    
    public override string ToString()
    {
        string result = $"name: {name}, age: {age}";
        return result;
    }
}

读取

string jsonStr = File.ReadAllText(Application.persistentDataPath + "/Test.json");
List<Data1> data2 = JsonConvert.DeserializeObject<List<Data1>>(jsonStr);
print(data2[0].ToString());

结果
在这里插入图片描述

6、总结

  • Newtonsoft提供的序列化反序列化方法JsonConvert.SerializeObject和JsonConvert.DeserializeObject<>
  • 使用Newtonsoft需要引入Newtonsoft.Json命名空间
  • Newtonsoft无需加特性
  • Newtonsoft不支持私有变量
  • Newtonsoft支持键为数值或者字符串的字典序列化反序列化
  • Newtonsoft可以直接将数据反序列化为数据集合
  • Json文档编码格式必须是UTF-8
  • Newtonsoft可以准确的保存null类型
  • Newtonsoft可以序列化vector Color Quaternion等数据，不过需要额外配JsonSerializerSettings参数
  • Newtonsoft还可以对Json格式美化，存储成易读的缩进格式

五、结论

结论毋庸置疑了，Newtonsoft集合了JsonUtlity和LitJSON的所有优点，又巧妙避开了所有缺点，而且它还有自己的优点，比如对Json格式美化。如果一定要说缺点的话，那可能就是Newtonsoft的包体比JsonUtlity和LitJSON大一点，不过也仅仅是大一点而已。

完结

赠人玫瑰，手有余香！如果文章内容对你有所帮助，请不要吝啬你的点赞评论和关注，你的每一次支持都是我不断创作的最大动力。当然如果你发现了文章中存在错误或者有更好的解决方法，也欢迎评论私信告诉我哦！

好了，我是向宇，https://xiangyu.blog.csdn.net

一位在小公司默默奋斗的开发者，闲暇之余，边学习边记录分享，站在巨人的肩膀上，通过学习前辈们的经验总是会给我很多帮助和启发！如果你遇到任何问题，也欢迎你评论私信或者加群找我， 虽然有些问题我也不一定会，但是我会查阅各方资料，争取给出最好的建议，希望可以帮助更多想学编程的人，共勉~
在这里插入图片描述

Unity中使用Newtonsoft.Json优化脚本
TenderRain的博客
04-17 316
解决方案在之前的文章中已经提及，这边就不重复了，后面直接放完整的代码，但是需要注意的是，使用该工具脚本，一定需要先导入Newtonsoft.Json，导入流程可以查看《3、再name中输入com.unity.nuget.newtonsoft-json，在Version中输入3.2.1（这个版本是目前最新版本）然后点击Add等待导入即可。在Unity中序列化一些Unity都有的数据类型时会经常碰到一些问题，就例如我之前那票文章提到的问题，《因此单独整理成了一个工具类，后续如果有增加，再更新文章笔记。
【unity小技巧】unity/C#对文件文件夹的操作，转换二进制数据，并实现持久化读取存储二进制数据，对C#类对象进行二进制序列化和反序列化并存储读取
向宇
12-10 1132
之前我已经写过了实现对Json数据的序列化和反序列化持久化存储： 【推荐100个unity插件之37】unity使用三种方式实现对Json数据的序列化和反序列化持久化存储，并举例分析JsonUtlity、LitJSON和Newtonsoft的区别清晰易懂是他的好处，但是也是一把双刃剑，比如如果我们用json存储数据，只要玩家找到对应的存储信息，就能够快速修改其中的内容（当然我们可以对数据进行加密）。而且由于他把数据转换成了对应的json字符串，我们最终在存储数据时存储的都是字符串数据，在读写时效率较低，内存
Unity Json插件litjson-0.16.0.zip
04-09
一个小巧的json插件, 此版本新增了对float类型反序列化的支持。 说明：Unity 请使用netstandard2.0下的dll 鄙视CSDN乱改积分的流氓行为
Unity3D插件——LitJson
11-28
用法可参见http://blog.csdn.net/candycat1992/article/details/10940245
Unity3D解析Json的插件(源码)，不用Dll
07-04
第一步：先去下载LitJson并导入当前的项目。 unity\项目\Assets\Plugins\LitJson 第二部：引用litJson using LitJson; 第三步：litJson的使用 WWW www = new WWW(url, rawData, headers); yield return www; JsonData jd = JsonMapper.ToObject(www.text); string memberId = jd["memberId"].ToString();
在unity用于json的序列化和反序列化插件（适用语言c#）
05-04
在unity用于json的序列化和反序列化插件（适用语言c#） 配合教程参见我的“unity/c#解析json”
【推荐100个unity插件之20】一个强大的JSON处理库——Newtonsoft.Json（也称为Json.NET）
向宇
06-17 1852
Newtonsoft.Json（也称为Json.NET）是一个强大的JSON处理库，用于在.NET平台上进行JSON序列化和反序列化操作。它提供了一系列功能丰富的API，可以轻松地将.NET对象转换为JSON字符串，并将JSON字符串转换回.NET对象。：适用于需要处理复杂JSON结构或需要高度灵活性的场景，尽管会牺牲一些性能和增加项目体积。如果你需要支持包括字典、私有字段以及自定义序列化行为，Newtonsoft.Json是更好的选择。
Unity反序列化所需的插件
01-20
本篇文章将深入解析Unity反序列化所需的插件——Newtonsoft.Json.dll，详细探讨如何在Unity项目中集成和使用该插件。 Newtonsoft.Json.dll是一个广泛使用的.NET库，它能够将JSON数据格式进行高效解析和转换。JSON...
Unity数据持久化——序列化/二进制/Json/PlayerPrefs
2403_83681139的博客
07-29 1964
序列化是指把对象转换为字节序列的过程，而反序列化是指将字节序列恢复为对象的过程。序列化最主要的用途就是传递对象和保存对象。在Unity中保存和加载、prefab、Scene、Inspector窗口、实例化预制体等都使用了序列化和反序列化。
【Unity数据交互】游戏中常用到的Json序列化
秩沅
11-02 808
【Unity数据交互】Json序列化你记得几分
【unity框架开发12】从零手搓unity存档存储数据持久化系统，实现对存档的创建，获取，保存，加载，删除，缓存，加密，支持多存档（2024/11/23补充）
向宇
10-10 3100
游戏存档不言而喻，是游戏设计中的重要元素，可以提高游戏的可玩性，为玩家提供更多的自由和控制权。我们主要是实现对存档的创建，获取，保存，加载，删除，缓存，加密，支持多存档。存档有两类，一类是用户型存档，存储着某个游戏用户具体的信息，如血量，武器，游戏进度，一类是设置型存档，与任何用户存档都无关，是通用的存储信息，比如屏幕分辨率、音量设置等。存档文件支持很多数据类似，这里我选择Json，可读性较强，易修改。
unity 自动excel转json插件
01-14
unity 自动excel转json插件
unity2018的 Json 文件的序列化反序列化读写
07-23
unity2018的 Json 文件的序列化反序列化读写工程，主要是支持反序列化读取Json文件，序列化写入Json文件的unity2018的Demo。里面自带了Newtonsoft.Json的Newtonsoft.Json.dll。
Unity 常用插件 之 LitJson 插件
04-10
将LitJSON编译好的dll文件通过Import New Asset的方式导入到项目中，再使用Using LitJSON即可使用JSONMapper类中的简便方法
Unity插件LitJson
05-02
在unity中通过JSON加载存储数据的一个插件
【Unity-插件】JsonNet.9.0.1.zip UnityJson解析插件
04-19
Unity用的Json解析工具
Unity中数据存储_JsonUtility
最新发布
4463fger的博客
04-17 614
Unity中关于JsonUtility的介绍
Unity开发——3种Json插件及其使用简单介绍
青岚岁叶的博客
06-15 2216
Unity开发——3种Json插件及其使用简单介绍 LitJson插件、Newtonsoft.Json、JsonUtility 及其实现的读档存档解析服务器数据的功能方法
Unity Json插件-SimpleJson|LitJson
十一岁专栏
12-30 2773
public void ReadCanonConfig() { string str = FileManager.GetUidFromJson(ConstPath.canonConfig); var json = SimpleJSON.JSON.Parse(str); if (System.Convert.ToBoolean(json["auto"].AsInt)) { print(json["li...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

向宇it

创作不易，感谢你的鼓励

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值