C#使用Json.Net进行序列化和反序列化及定制化
序列化（Serialize）是将对象转换成字节流，并将其用于存储或传输的过程，主要用途是保存对象的状态，以便在需要时重新创建该对象；反序列化（Deserialize）则是将上面的字节流转换为相应对象的过程；在.Net阵营中，Json.Net是由官方推荐的高性能开源序列化/反序列化工具，其官方网站：https://www.newtonsoft.com/json；
一、将对象序列化为Json格式字符串
首先是正常的序列化操作，对于给定的类：
private class MyClass
{
public int MyNum;
public string MyStr;
}
将该类的实例序列化为Json格式字符串，首先引用命名空间Newtonsoft.Json：
MyClass myClass = new MyClass { MyNum = 10, MyStr = "Hello World" };
Console.WriteLine(JsonConvert.SerializeObject(myClass));
其打印结果：
{"MyNum":10,"MyStr":"Hello World"}
在打印到本地Log文件以供自己查看使用时，可以选择转换为带有缩进的Json格式字符串：
Console.WriteLine(JsonConvert.SerializeObject(myClass, Formatting.Indented));
此时打印结果为：
{
"MyNum": 10,
"MyStr": "Hello World"
}
二、将Json格式字符串反序列化为对象
对于给定的字符串：
string jsonStr = @"{""MyNum"": 10,""MyStr"": ""Hello World""}";
将其反序列化为MyClass类型的对象：
MyClass myClass = JsonConvert.DeserializeObject<MyClass>(jsonStr); Console.WriteLine(myClass.MyStr); //Hello World
三、使用JObject动态序列化/反序列化
以上例子都是使用强类型进行序列化和反序列操作，但有时也会用到不指定类型而直接操作Json格式数据的情况，此时就需要用位于命名空间ewtonsoft.Json.Linq中的JObject类型的对象：
string jsonStr = @"{""MyNum"": 10,""MyStr"": ""Hello World""}";
JObject jObject = JObject.Parse(jsonStr);
Console.WriteLine(jObject.ToString(Formatting.None)); //{"MyNum":10,"MyStr":"Hello World"}
//打印一条属性的值
Console.WriteLine(jObject["MyStr"].Value<string>()); //Hello World
//添加一条属性
jObject.Add("MyStr2", "HaHa");
//打印当前Json字符串
Console.WriteLine(jObject.ToString(Formatting.None)); //{"MyNum":10,"MyStr":"Hello World","MyStr2":"HaHa"}
四、定制化序列化/反序列过程
1.在C#中，定制化的配置通常使用特性来完成，这里也不例外，例如简单的，在序列化/反序列时忽略某个字段/属性：
private class MyClass
{
[JsonIgnore]
public int MyNum;
public string MyStr;
}
此时，无论序列化还是反序化时，字段MyNum都不再参与这些过程；
2.自定义某个字段/属性的序列化/反序列化规则：
当接收到的Json格式字符串与本地已有类型不统一时，需要进行自定义的反序列化过程，反之亦然，例如Json字符串中以字符串"TRUE"表示布尔类型true（不自定义，这个过程依然走的通，只是以此举例），以字符串"FALSE"表示布尔类型false时，需要自定义如下：
/// <summary>
/// 自定义布尔类型数据转换规则
/// </summary>
public class MyBoolConverter : JsonConverter
{
private const string TrueStr = "TRUE";
private const string FalseStr = "FALSE";
public override bool CanConvert(Type objectType) => true;
//反序列化
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
if (reader.ValueType == typeof(string))
{
if ((string)reader.Value == TrueStr)
{
return true;
}
else
{
return false;
}
}
return false;
}
//序列化
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
if (value.GetType() == typeof(bool))
{
bool result = (bool)value;
if (result)
{
writer.WriteValue(TrueStr);
}
else
{
writer.WriteValue(FalseStr);
}
}
}
}
然后，在需要操作的类型定义中的字段/属性中加入该特性：
private class MyClass
{
[JsonConverter(typeof(MyBoolConverter))]
public bool MyBool;
}
此时：
string jsonStr = @"{""MyBool"": ""TRUE""}";
MyClass1 myClass = JsonConvert.DeserializeObject<MyClass1>(jsonStr);
Console.WriteLine(myClass.MyBool); //True
Console.WriteLine(JsonConvert.SerializeObject(myClass)); //{"MyBool":"TRUE"}
以上就是本次整理的C#使用Json.Net进行序列化和反序列化及定制化全部知识点内容，感谢大家对脚本之家的支持。
相关文章
本篇文章是对C#中内存管理以及优化的方法进行了详细的分析介绍，需要的朋友参考下2013-05-05
这篇文章主要为大家详细介绍了C# WindowsForm程序同时启动多个窗口类，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-06-06
这篇文章主要介绍了C#的TimeSpan案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-08-08
这篇文章主要介绍了C#中获取程序路径的几种方法及其区别说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-07-07
这篇文章介绍了C#判断字符串是否数字或字母的实例，有需要的朋友可以参考一下2013-06-06
在当今的软件开发领域,数据的交换与存储变得愈发频繁,JSON作为一种轻量级的数据交换格式,在 WPF平台开发的桌面应用里,我们常常需要与各种数据源交互,动态处理JSON字符串就成为了一项必备技能,本文将深入探讨如何在 WPF 平台上,仅使用纯C#代码实现对JSON字符串的动态处理2025-01-01
.Net6中加入了两个新的时间类型：DateOnly和TimeOnly，但DateOnly和TimeOnly都有相应的应用场景，所以本文就来自定义一个时间类型YearMonth，用于解决实际项目开发中的需求，希望对大家有所帮助2023-07-07
在 C# 的应用开发中,数据访问是极为关键的部分,ADO.NET作为.NET 框架下用于数据访问的核心技术,能够帮助开发者便捷地与各类数据源进行交互,本文将深入剖析ADO.NET,带你掌握使用 C# 通过ADO.NET访问数据的方法,需要的朋友可以参考下2025-02-02
这篇文章主要介绍了C#为配置文件加密的实现方法,可实现对配置文件中的敏感信息进行加密,非常具有实用价值,需要的朋友可以参考下2014-10-10
C#使用BitConverter与BitArray类进行预定义基础类型转换
这篇文章介绍了C#使用BitConverter与BitArray类进行预定义基础类型转换的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-05-05
最新评论