AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Json.Net系列教程 3.Json.Net序列化和反序列化设置

2013-11-01 1110
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 原文 Json.Net系列教程 3.Json.Net序列化和反序列化设置 上节补充 首先补充一点,Json.Net是支持序列化和反序列化DataTable,DataSet,Entity Framework和NHibernate的.

原文 Json.Net系列教程 3.Json.Net序列化和反序列化设置

上节补充

首先补充一点,Json.Net是支持序列化和反序列化DataTable,DataSet,Entity Framework和NHibernate的.我举例说明DataTable的序列化和反序列化.
创建一个DataTable对象,如下:

复制代码 
            DataTable dt = new DataTable();
            DataColumn dcName = new DataColumn("Name");
            DataColumn dcAge = new DataColumn("Age");
            DataColumn dcCity = new DataColumn("City");

            dt.Columns.Add(dcName);
            dt.Columns.Add(dcAge);
            dt.Columns.Add(dcCity);
            for (int i = 0; i < 10; i++)
            {
                DataRow dr = dt.NewRow();
                dr[0] = "Name" + i;
                dr[1] = "Age" + i;
                dr[2] = "City" + i;
                dt.Rows.Add(dr);
            }
复制代码

序列化:

            string json = JsonConvert.SerializeObject(dt);
            Console.WriteLine(json);

结果:

利用上面得到的序列化字符串反序列化:

复制代码 
            DataTable dt1 = JsonConvert.DeserializeObject<DataTable>(json);
            for (int i = 0; i < dt1.Rows.Count; i++)
            {
                DataRow dr = dt1.Rows[i];
                Console.WriteLine("{0}\t{1}\t{2}\t", dr[0], dr[1], dr[2]);
            }
复制代码

结果:

本节内容

预备知识:

要想实现对Json.Net序列化和反序列化的控制,就要用到类JsonSerializerSettings,用法很简单实例化一个对象,并把它赋值给JsonConvert的参数即可.

            var jSetting = new JsonSerializerSettings();
            string json = JsonConvert.SerializeObject(obj,jSetting);

开始之前,我还是先创建一员工类:

复制代码 
    public class Staff
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Gender { get; set; }
        public string DepartmentName { get; set; }
        public Staff Leader { get; set; }
    }
复制代码
一.空值的处理

这里的空值指的是引用类型为NULL时,Json.Net如何处理.通过设置jSetting.NullValueHandling的值来确定,该值为枚举类型.

NullValueHandling.Ignore
忽略为NULL的值 
NullValueHandling.Include
默认值,包括为NULL的值

 

 

 

 

实例:

复制代码 
            Staff jack = new Staff { Name = "Jack", Age = 31, Gender = "Male", DepartmentName = "Personnel Department", Leader = null };
            var jSetting = new JsonSerializerSettings();
            jSetting.NullValueHandling = NullValueHandling.Ignore;
            string json = JsonConvert.SerializeObject(jack,jSetting);
            Console.WriteLine(json);
复制代码

结果:

2.默认值的处理

 一般是对于值类型的处理,通过设置jSetting.DefaultValueHandling的值来确定,该值为枚举类型.

DefaultValueHandling.Ignore
序列化和反序列化时,忽略默认值 
DefaultValueHandling.Include
序列化和反序列化时,包含默认值

 

 

 

 

给成员设置默任值,用到"DefaultValue(value)"特性,当然别忘了引入命名空间"System.ComponentModel",假设员工的年龄默认值为30

        [DefaultValue(30)]
        public int Age { get; set; }

序列化时我想忽略为默认值的成员

复制代码 
            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male", DepartmentName = "Personnel Department", Leader = null };
            var jSetting = new JsonSerializerSettings();
            jSetting.DefaultValueHandling = DefaultValueHandling.Ignore;
            string json = JsonConvert.SerializeObject(jack,jSetting);
            Console.WriteLine(json);
复制代码

结果:

3.忽略某些属性

首先介绍Json.Net序列化的模式:OptOut 和 OptIn.

OptOut 默认值,类中所有公有成员会被序列化,如果不想被序列化,可以用特性JsonIgnore
OptIn 默认情况下,所有的成员不会被序列化,类中的成员只有标有特性JsonProperty的才会被序列化,当类的成员很多,但客户端仅仅需要一部分数据时,很有用

 

 

假如客户仅仅需要员工的姓名,此时

复制代码 
    [JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)]
    public class Staff
    {
        [JsonProperty]
        public string Name { get; set; }
        public int Age { get; set; }
        public string Gender { get; set; }
        public string DepartmentName { get; set; }
        public Staff Leader { get; set; }
    }
复制代码

序列化:

            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male", DepartmentName = "Personnel Department", Leader = null };
            string json = JsonConvert.SerializeObject(jack);

结果:

如果客户不想要员工的领导信息

复制代码 
    public class Staff
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Gender { get; set; }
        public string DepartmentName { get; set; }
        [JsonIgnore]
        public Staff Leader { get; set; }
    }
复制代码

序列化:

            Staff tom = new Staff { Name = "Tome", Age = 42, Gender = "Male", DepartmentName = "Personnel Department"};
            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male", DepartmentName = "Personnel Department", Leader = tom };
            string json = JsonConvert.SerializeObject(jack);
            Console.WriteLine(json);

结果:

4.支持非公共成员

Json.Net序列化对象时,默认情况下仅仅序列化公有成员,如果想要非公有成员也被序列化,就要在该成员上加特性"JsonProperty"

5.日期处理

　　JsonConverters会在序列化和反序列化时被用到。JsonConverters允许手动对Json的控制。当Json的结构很复杂 和你想改变一个类型怎么样被序列化时，这是非常有用的。当一个JsonConverters被添加到JsonSerializer时，它会检查每一要被序 列化和反序列化的值，并返回CanConvert，如果为True,则JsonConverter读和写这个值；需要注意的是，虽然 JsonConverter能够使你可以完全的控制Json的值，但是很多的Json.Net序列化的特性被限制，像是类型名称和引用处理。所有的 JsonConvert都在命名空间 "Newtonsoft.Json.Converters"下

5.1 IsoDateTimeConverter 和 JavaScriptDateTimeConverter

这是Json.Net中自带的两个处理日期的类,默认是IsoDateTimeConverter ,它的格式是"yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK".另一个是JavaScriptTimeConverter,它的格式是 "new Date(ticks)",其实返回的是一个JavaScript的Date对象.
有两种方式来应用JsonConverter,改变Json序列化和反序列化的行为.

5.1.1如果你要序列化的日期格式是统一的,可以考虑如下方式

假设我们为员工添加两个日期类型的成员,出生日期和入职日期

复制代码 
    public class Staff
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Gender { get; set; }
        public string DepartmentName { get; set; }
        public Staff Leader { get; set; }
        public DateTime BirthDate { get; set; }
        public DateTime EmploymentDate { get; set; }
    }
复制代码

我们的客户要求日期类型的成员返回javascript的日期对象

            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male",
                DepartmentName = "Personnel Department", BirthDate = new DateTime(1982,2,12), EmploymentDate = new DateTime(2010,12,12) };
            string json = JsonConvert.SerializeObject(jack,new JavaScriptDateTimeConverter());
            Console.WriteLine(json);

结果:

 

5.1.2如果想要不同的日期类型成员序列化后,以不同的形式显示.

现在我们的客户要求出生日期以"ISO"标准日期格式返回,入职日期以Javascript的Date对象格式返回,修改我们的员工类

复制代码 
    public class Staff
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Gender { get; set; }
        public string DepartmentName { get; set; }
        public Staff Leader { get; set; }
        [JsonConverter(typeof(IsoDateTimeConverter))]
        public DateTime BirthDate { get; set; }
        [JsonConverter(typeof(JavaScriptDateTimeConverter))]
        public DateTime EmploymentDate { get; set; }
    }
复制代码

是的,通过特性"JsonConverter"来实现差异化的
序列化:

            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male",
                DepartmentName = "Personnel Department", BirthDate = new DateTime(1982,2,12), EmploymentDate = new DateTime(2010,12,12) };
            string json = JsonConvert.SerializeObject(jack);
            Console.WriteLine(json);

结果:

5.2自定义日期格式

客户现在提出要求,希望得到的日期格式是符合中国人习惯的格式.要求返回的格式是"2012年4月20日".挑战来了,没有挑战就没有进步,我喜欢挑战.光说是没有用的!先分析一下怎么解决这个问题.我考虑了两种思路.
　　思路一:
研究了一下上面两个日期处理类,发现他们都是继承了基类"DateTimeConverterBase",所以我们可以参考"IsoDatetimeConverter"的实现方式,自己新建一个处理日期格式的转换器类.这种方式的缺点是可能要花大量的时间去研究,比较费时费力.优点就是可以对日期格式随心所欲的控制.
　　思路二:
我又研究了一下"IsoDatetimeConverter",发现它的日期格式其实是由于内部DefaultDateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"导致,而它也提供了修改日期样式的属性"DateTimeFormat",只要我们按照这种格式来写就OK了.

复制代码 
            Staff jack = new Staff { Name = "Jack", Age = 30, Gender = "Male",
                DepartmentName = "Personnel Department", BirthDate = new DateTime(1982,2,12), EmploymentDate = new DateTime(2010,12,12) };
            IsoDateTimeConverter dtConverter = new IsoDateTimeConverter { DateTimeFormat = "yyyy'年'MM'月'dd'日'" };
            string json = JsonConvert.SerializeObject(jack,dtConverter);
            Console.WriteLine(json);
复制代码

 结果:

6.FAQ
1.如何自定义序列化的字段名称?
默认情况下,Json.Net序列化后结果中的字段名称和类中属性的名称一致.如果想自定义序列化后的字段名称,可以使用JsonProperty.例如：
复制代码 
 public class Person
 {
       public int Id { get; set; }

       public string Name { get; set; }
 }
复制代码

默认序列化的结果为: {"Id":1,"Name":"杨过"},如果不想用默认的字段名称，可以使用如下方式：

复制代码 
public class Person
{
       [JsonProperty(PropertyName = "PersonId")]
       public int Id { get; set; }

       [JsonProperty(PropertyName = "PersonName")]
       public string Name { get; set; }
}
复制代码

这样序列化的结果为：{"PersonId":1,"PersonName":"杨过"}

文章标签：
数据格式
JSON
JavaScript
前端开发
关键词：
序列化反序列化
JSON序列化反序列化
JSON反序列化
JSON序列化
.NET教程
杰克.陈
目录
相关文章
程序员小假
|
22天前
|
存储 安全 IDE
说一说序列化与反序列化中存在的问题
本文详细解析了Java中的序列化机制，包括序列化的概念、实现方式及应用场景。通过Student类的实例演示了对象的序列化与反序列化过程，并分析了`Serializable`接口的作用以及`serialVersionUID`的重要意义。此外，文章还探讨了如何通过自定义`readObject()`方法增强序列化的安全性，以及解决可序列化单例模式中可能产生的多实例问题。最后提供了代码示例和运行结果，帮助读者深入理解序列化的原理与实践技巧。
程序员小假
63 2
程序员爱钓鱼
|
24天前
|
JSON JavaScript 前端开发
Go语言JSON 序列化与反序列化 -《Go语言实战指南》
本文介绍了 Go 语言中使用 `encoding/json` 包实现 JSON 与数据结构之间的转换。内容涵盖序列化（`Marshal`）和反序列化（`Unmarshal`），包括基本示例、结构体字段标签的使用、控制字段行为的标签（如 `omitempty` 和 `-`）、处理 `map` 和切片、嵌套结构体序列化、反序列化未知结构（使用 `map[string]interface{}`）以及 JSON 数组的解析。最后通过表格总结了序列化与反序列化的方法及类型要求，帮助开发者快速掌握 JSON 数据处理技巧。
程序员爱钓鱼
51 0
那年春天
|
7月前
|
安全 JavaScript
如何在`package.json`中正确设置依赖版本范围？
正确设置 `package.json` 中的依赖版本范围需要综合考虑项目的需求、依赖库的稳定性和兼容性，以及开发和维护的便利性等因素。通过合理选择版本范围符号，并结合定期的审查和测试，可以有效地管理项目依赖，确保项目的稳定运行。
那年春天
192 1
小王老师呀
|
7月前
|
JSON 数据格式 索引
Python中序列化/反序列化JSON格式的数据
【11月更文挑战第4天】本文介绍了 Python 中使用 `json` 模块进行序列化和反序列化的操作。序列化是指将 Python 对象（如字典、列表）转换为 JSON 字符串，主要使用 `json.dumps` 方法。示例包括基本的字典和列表序列化，以及自定义类的序列化。反序列化则是将 JSON 字符串转换回 Python 对象，使用 `json.loads` 方法。文中还提供了具体的代码示例，展示了如何处理不同类型的 Python 对象。
小王老师呀
193 1
刘大猫.
|
7月前
|
JSON Java 数据格式
springboot中表字段映射中设置JSON格式字段映射
springboot中表字段映射中设置JSON格式字段映射
刘大猫.
236 1
游客moiomvrp3vyac2
|
7月前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第22天】在Java的世界里，对象序列化和反序列化是数据持久化和网络传输的关键技术。本文将带你了解如何在Java中实现对象的序列化与反序列化，并探讨其背后的原理。通过实际代码示例，我们将一步步展示如何将复杂数据结构转换为字节流，以及如何将这些字节流还原为Java对象。文章还将讨论在使用序列化时应注意的安全性问题，以确保你的应用程序既高效又安全。
游客moiomvrp3vyac2
101 4
历年考试不作弊
|
8月前
|
存储 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第9天】在Java的世界里，对象序列化是连接数据持久化与网络通信的桥梁。本文将深入探讨Java对象序列化的机制、实践方法及反序列化过程，通过代码示例揭示其背后的原理。从基础概念到高级应用，我们将一步步揭开序列化技术的神秘面纱，让读者能够掌握这一强大工具，以应对数据存储和传输的挑战。
历年考试不作弊
107 1
软件求生
|
7月前
|
存储 缓存 NoSQL
一篇搞懂！Java对象序列化与反序列化的底层逻辑
本文介绍了Java中的序列化与反序列化，包括基本概念、应用场景、实现方式及注意事项。序列化是将对象转换为字节流，便于存储和传输；反序列化则是将字节流还原为对象。文中详细讲解了实现序列化的步骤，以及常见的反序列化失败原因和最佳实践。通过实例和代码示例，帮助读者更好地理解和应用这一重要技术。
软件求生
275 0
热爱技术的小郑
|
10月前
|
存储 Java
【IO面试题 四】、介绍一下Java的序列化与反序列化
Java的序列化与反序列化允许对象通过实现Serializable接口转换成字节序列并存储或传输，之后可以通过ObjectInputStream和ObjectOutputStream的方法将这些字节序列恢复成对象。
热爱技术的小郑
139 2
历年考试不作弊
|
8月前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第3天】在Java编程的世界里，对象序列化与反序列化是实现数据持久化和网络传输的关键技术。本文将深入探讨Java序列化的原理、应用场景以及如何通过代码示例实现对象的序列化与反序列化过程。从基础概念到实践操作，我们将一步步揭示这一技术的魅力所在。
历年考试不作弊
114 4

热门文章

最新文章

  • 1
    鸿蒙开发：json转对象插件回来了
  • 2
    【Azure Function】分享把Function App从.NET 6.0升级到.NET 8.0 Isolated的步骤
  • 3
    .NET 6中Startup.cs文件注入本地缓存策略与服务生命周期管理实践：AddTransient, AddScoped, AddSingleton。
  • 4
    说一说序列化与反序列化中存在的问题
  • 5
    Go语言JSON 序列化与反序列化 -《Go语言实战指南》
  • 6
    深入对比TOML，JSON和YAML
  • 7
    用Js的eval解析JSON中的注意点
  • 8
    C++ Json工具--Jsoncpp用法简介
  • 9
    json2.js使用参考
  • 10
    jQuery1.4.2的json提示parsererror问题
  • 1
    说一说序列化与反序列化中存在的问题
    63
  • 2
    Go语言JSON 序列化与反序列化 -《Go语言实战指南》
    51
  • 3
    Nettyの网络聊天室&扩展序列化算法
    80
  • 4
    什么是 YAML？：一种简洁高效的数据序列化格式
    861
  • 5
    Go语言中json序列化的一个小坑，建议多留意一下
    173
  • 6
    聊聊 Go 语言中的 JSON 序列化与 js 前端交互类型失真问题
    152
  • 7
    对比JSON和Hessian2的序列化格式
    243
  • 8
    Python中序列化/反序列化JSON格式的数据
    193
  • 9
    除了 JSON 序列化比较，还有哪些方法可以进行深比较？
    115
  • 10
    再也不用心惊胆战地使用FastJSON了——序列化篇
    2292

    • 相关课程

    更多
  • JSON 自学手册图文教程

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)