思享工具箱

Json.Net序列化和反序列化设置

摘要：
首先补充一点,Json.Net是支持序列化和反序列化DataTable,DataSet,EntityFramework和NHibernate的.我举例说明DataTable的序列化和反序列化.创建一个DataTable对象,如下:DataTabledt=newDataTable();DataColumndcName=newDataColumn("Name");DataColumndcAge=new

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

            DataTable dt = newDataTable();
            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);

结果:

Json.Net序列化和反序列化设置第1张

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

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

结果:

Json.Net序列化和反序列化设置第2张

本节内容

1.空值的处理

2.默认值的处理

3.忽略某些属性

4.支持非公共成员

5.日期处理

6.FAQ

预备知识:

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

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

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

public classStaff
    {
        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 = newJsonSerializerSettings();
            jSetting.NullValueHandling =NullValueHandling.Ignore;
            string json =JsonConvert.SerializeObject(jack,jSetting);
            Console.WriteLine(json);

结果:

Json.Net序列化和反序列化设置第3张

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 = newJsonSerializerSettings();
            jSetting.DefaultValueHandling =DefaultValueHandling.Ignore;
            string json =JsonConvert.SerializeObject(jack,jSetting);
            Console.WriteLine(json);

结果:

Json.Net序列化和反序列化设置第4张

3.忽略某些属性

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

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

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

[JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)]
    public classStaff
    {
        [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);

结果:

Json.Net序列化和反序列化设置第5张

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

    public classStaff
    {
        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);

结果:

Json.Net序列化和反序列化设置第6张

4.支持非公共成员

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

5.日期处理

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

5.1IsoDateTimeConverter和JavaScriptDateTimeConverter

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

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

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

    public classStaff
    {
        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,newJavaScriptDateTimeConverter());
            Console.WriteLine(json);

结果:

Json.Net序列化和反序列化设置第7张

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

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

    public classStaff
    {
        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);

结果:

Json.Net序列化和反序列化设置第8张

5.2自定义日期格式

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

            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);

结果:

Json.Net序列化和反序列化设置第9张

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

       public string Name { get; set; }
 }

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

public classPerson
{
       [JsonProperty(PropertyName = "PersonId")]
       public int Id { get; set; }

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

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

标签：#序列化#datatable | 浏览：158 | 发布日期：

免责声明：文章转载自《Json.Net序列化和反序列化设置》仅用于学习参考。如对内容有疑问，请及时联系本站处理。

上篇JavaScript的事件对象中的特殊属性和方法（鼠标，键盘）Android 5.0 以上监听网络变化下篇

宿迁高防，2C2G15M，22元/月；香港BGP，2C5G5M，25元/月 雨云优惠码：MjYwNzM=

相关文章

监控Spark应用方法简介

监控Spark应用有很多种方法。Web接口每一个SparkContext启动一个web UI用来展示应用相关的一些非常有用的信息，默认在4040端口。这些信息包括：任务和调度状态的列表RDD大小和内存使用的统计信息正在运行的executor的信息环境信息你可以在浏览器中打开http://<driver-node>:4040网址来访问这些信息。如...

【原创】打造基于Dapper的数据访问层

前言 闲来无事，花几天功夫将之前项目里用到的一个数据访问层整理了出来。实现单个实体的增删改查，可执行存储过程，可输出返回参数，查询结果集可根据实际情况返回DataTable、DataSet和强类型，同时支持不同类型数据库。目前成熟的ORM框架多不胜数，虽然有种重复造轮子的感觉，但相信朋友们和我一样，享受造轮子的过程并把它当成一种乐趣，对吧。 调用示例 1、...

DataTables warning (table id = 'myTable'): Requested unknown parameter '0' from the data source for row 0

第一种方式：不用在js里设置列Html： <table id="myTable"> <thead> <tr> <th>Title-1</th> <th>Title-2</th&...

Serializable

转自http://blog.csdn.net/cdl2008sky/article/details/6747396 Serizlizable 作用 对于一个存在于Java虚拟机中的对象来说，其内部的状态只保持在内存中。JVM停止之后，这些状态就丢失了。在很多情况下，对象的内部状态是需要被持久化下来的。提到持久化，最直接的做法是保存到文件系统或是数据库之中。...

springboot2.1.3 + redisTemplate + Lock 操作 redis 3.0.5

近期在整合springboot + redis 的功能，本来想用原生的jedit api，最后想想有点 low，搜了一把，boot已经提供给我们操作的方法，那就是 使用 redisTemplate 或 StringRedisTemplate， 两者是有区别的，可以看下面的说明 1. 两者的关系是StringRedisTemplate继承RedisTempl...

rest-framework框架——视图三部曲

一、mixins类编写视图 1、配置url urlpatterns = [ ... re_path(r'^authors/$', views.AuthorView.as_view(), name="author"), re_path(r'^authors/(?P<pk>d+)/$', views.AuthorDet...

最新文章

随机推荐

思享工具箱导航