第C#使用Json.Net對(duì)JSON與對(duì)象的序列化與反序列化二、空值的處理

這里的空值指的是引用類型為NULL時(shí),Json.Net如何處理.通過設(shè)置jSetting.NullValueHandling的值來確定,該值為枚舉類型。

NullValueHandling.Ignore:忽略為NULL的值NullValueHandling.Include:默認(rèn)值,包括為NULL的值

實(shí)例:

voidMain()

Staffjack=newStaff{Name="Jack",Age=31,Gender="Male",DepartmentName="PersonnelDepartment",Leader=null};

varjSetting=newJsonSerializerSettings();

jSetting.NullValueHandling=NullValueHandling.Ignore;

stringjson=JsonConvert.SerializeObject(jack,jSetting);

Console.WriteLine(json);

//{"Name":"Jack","Age":31,"Gender":"Male","DepartmentName":"PersonnelDepartment"}

//員工類:

publicclassStaff

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

publicStaffLeader{get;set;}

}

三、默認(rèn)值的處理

一般是對(duì)于值類型的處理,通過設(shè)置jSetting.DefaultValueHandling的值來確定,該值為枚舉類型.

DefaultValueHandling.Ignore：序列化和反序列化時(shí),忽略默認(rèn)值DefaultValueHandling.Include：序列化和反序列化時(shí),包含默認(rèn)值

給成員設(shè)置默任值,用到DefaultValue(value)特性,當(dāng)然別忘了引入命名空間System.ComponentModel,假設(shè)員工的年齡默認(rèn)值為30。

[DefaultValue(30)]

publicintAge{get;set;}

序列化時(shí)我想忽略為默認(rèn)值的成員：

Staffjack=newStaff{Name="Jack",Age=30,Gender="Male",DepartmentName="PersonnelDepartment",Leader=null};

varjSetting=newJsonSerializerSettings();

jSetting.DefaultValueHandling=DefaultValueHandling.Ignore;

stringjson=JsonConvert.SerializeObject(jack,jSetting);

Console.WriteLine(json);

//{"Name":"Jack","Gender":"Male","DepartmentName":"PersonnelDepartment"}

四、忽略某些屬性

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

OptOut：默認(rèn)值。類中所有公有成員會(huì)被序列化，如果不想被序列化，可以用特性JsonIgnore。OptIn：在這種情況下,所有的成員不會(huì)被序列化,類中的成員只有標(biāo)有特性JsonProperty的才會(huì)被序列化,當(dāng)類的成員很多,但客戶端僅僅需要一部分?jǐn)?shù)據(jù)時(shí),很有用。

假如客戶僅僅需要員工的姓名,此時(shí)序列化:

voidMain()

Staffjack=newStaff{Name="Jack",Age=30,Gender="Male",DepartmentName="PersonnelDepartment",Leader=null};

stringjson=JsonConvert.SerializeObject(jack);

Console.WriteLine(json);

//{"Name":"Jack"}

[JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)]

publicclassStaff

[JsonProperty]

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

publicStaffLeader{get;set;}

}

如果客戶不想要員工的領(lǐng)導(dǎo)信息，序列化:

voidMain()

Stafftom=newStaff{Name="Tome",Age=42,Gender="Male",DepartmentName="PersonnelDepartment"};

Staffjack=newStaff{Name="Jack",Age=30,Gender="Male",DepartmentName="PersonnelDepartment",Leader=tom};

stringjson=JsonConvert.SerializeObject(jack);

Console.WriteLine(json);

//{"Name":"Jack","Age":30,"Gender":"Male","DepartmentName":"PersonnelDepartment"}

publicclassStaff

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

[JsonIgnore]

publicStaffLeader{get;set;}

}

五、支持非公共成員

Json.Net序列化對(duì)象時(shí)，默認(rèn)情況下僅僅序列化公有成員，如果想要非公有成員也被序列化,就要在該成員上加特性JsonProperty。

六、日期處理

JsonConverters會(huì)在序列化和反序列化時(shí)被用到。JsonConverters允許手動(dòng)對(duì)Json的控制。當(dāng)Json的結(jié)構(gòu)很復(fù)雜和你想改變一個(gè)類型怎么樣被序列化時(shí)，這是非常有用的。

當(dāng)一個(gè)JsonConverters被添加到JsonSerializer時(shí)，它會(huì)檢查每一個(gè)要被序列化和反序列化的值，并返回CanConvert，如果為True,則JsonConverter讀和寫這個(gè)值；

需要注意的是，雖然JsonConverter能夠使你可以完全的控制Json的值，但是很多的Json.Net序列化的特性被限制，像是類型名稱和引用處理。

所有的JsonConvert都在命名空間Newtonsoft.Json.Converters下

1、使用IsoDateTimeConverter和JavaScriptDateTimeConverter標(biāo)準(zhǔn)格式

這是Json.Net中自帶的兩個(gè)處理日期的類：

IsoDateTimeConverter：默認(rèn)的ISO標(biāo)準(zhǔn)日期格式,它的格式是yyyy-MM-ddTHH:mm:ss.FFFFFFFK。JavaScriptTimeConverter：它的格式是newDate(ticks),其實(shí)返回的是一個(gè)JavaScript的Date對(duì)象.

有兩種方式來應(yīng)用JsonConverter,改變Json序列化和反序列化的行為.

1、如果你要序列化的日期格式是統(tǒng)一的,可以考慮如下方式

假設(shè)我們?yōu)閱T工添加兩個(gè)日期類型的成員,出生日期和入職日期，我們的客戶要求日期類型的成員返回javascript的日期對(duì)象

voidMain()

Staffjack=newStaff

Name="Jack",

Age=30,

Gender="Male",

DepartmentName="PersonnelDepartment",

BirthDate=newDateTime(1982,2,12),

EmploymentDate=newDateTime(2010,12,12)

stringjson=JsonConvert.SerializeObject(jack,newJavaScriptDateTimeConverter());

Console.WriteLine(json);

//{"Name":"Jack","Age":30,"Gender":"Male","DepartmentName":"PersonnelDepartment","Leader":null,"BirthDate":newDate(382291200000),"EmploymentDate":newDate(1292083200000)}

publicclassStaff

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

publicStaffLeader{get;set;}

publicDateTimeBirthDate{get;set;}

publicDateTimeEmploymentDate{get;set;}

}

2、如果想要不同的日期類型成員序列化后,以不同的形式顯示.

現(xiàn)在我們的客戶要求出生日期以ISO標(biāo)準(zhǔn)日期格式返回,入職日期以Javascript的Date對(duì)象格式返回,修改我們的員工類，,通過特性JsonConverter來實(shí)現(xiàn)差異化。

voidMain()

Staffjack=newStaff

Name="Jack",

Age=30,

Gender="Male",

DepartmentName="PersonnelDepartment",

BirthDate=newDateTime(1982,2,12),

EmploymentDate=newDateTime(2010,12,12)

stringjson=JsonConvert.SerializeObject(jack);

Console.WriteLine(json);

//{"Name":"Jack","Age":30,"Gender":"Male","DepartmentName":"PersonnelDepartment","Leader":null,"BirthDate":"1982-02-12T00:00:00","EmploymentDate":newDate(1292083200000)}

publicclassStaff

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

publicStaffLeader{get;set;}

[JsonConverter(typeof(IsoDateTimeConverter))]

publicDateTimeBirthDate{get;set;}

[JsonConverter(typeof(JavaScriptDateTimeConverter))]

publicDateTimeEmploymentDate{get;set;}

}

2、自定義日期格式

要求返回的格式是2012年4月20日這種格式，使用IsoDatetimeConverter內(nèi)部的日期格式DefaultDateTimeFormat。

voidMain()

Staffjack=newStaff

Name="Jack",

Age=30,

Gender="Male",

DepartmentName="PersonnelDepartment",

BirthDate=newDateTime(1982,2,12),

EmploymentDate=newDateTime(2010,12,12)

IsoDateTimeConverterdtConverter=newIsoDateTimeConverter{DateTimeFormat="yyyy'年'MM'月'dd'日'"};

stringjson=JsonConvert.SerializeObject(jack,dtConverter);

Console.WriteLine(json);

//{"Name":"Jack","Age":30,"Gender":"Male","DepartmentName":"PersonnelDepartment","Leader":null,"BirthDate":"1982年02月12日","EmploymentDate":"2010年12月12日"}

publicclassStaff

publicstringName{get;set;}

publicintAge{get;set;}

publicstringGender{get;set;}

publicstringDepartmentName{get;set;}

publicStaffLeader{get;set;}

publicDateTimeBirthDate{get;set;}

[JsonConverter(typeof(JavaScriptDateTimeConverter))]

publicDateTimeEmploymentDate{get;set;}

}

七、自定義序列化的字段名稱

默認(rèn)情況下,Json.Net序列化后結(jié)果中的字段名稱和類中屬性的名稱一致.如果想自定義序列化后的字段名稱,可以使用JsonProperty.例如：

publicclassPerson

publicintId{get;set;}

publicstringName{get;set;}

}

默認(rèn)序列化的結(jié)果為:{Id:1,Name:楊過},如果不想用默認(rèn)的字段名稱，可以使用如下方式：

publicclassPerson

[JsonProperty(PropertyName="PersonId")]

publicintId{get;set;}

[JsonProperty(PropertyName="PersonName")]

publicstringName{get;set;}

}

這樣序列化的結(jié)果為：{PersonId:1,PersonName:楊過}

八、枚舉值的自定義格式化問題

默認(rèn)情況下對(duì)于實(shí)體里面的枚舉類型系統(tǒng)是格式化成改枚舉對(duì)應(yīng)的整型數(shù)值,那如果需要格式化成枚舉對(duì)應(yīng)的字符怎么處理呢？Newtonsoft.Json也幫我們想到了這點(diǎn)，下面看實(shí)例

voidMain()

stringjson=JsonConvert.SerializeObject(newTestEnmu());

Console.WriteLine(json);

//{"Type":0}

publicenumNotifyType

///

///Emil發(fā)送

///

Mail=0,

///

///短信發(fā)送

///

SMS=1

publicclassTestEnmu

///

///消息發(fā)送類型

///

publicNotifyTypeType{get;set;}

}

現(xiàn)在改造一下，輸出Type:Mail

publicclassTestEnmu

///

///消息發(fā)送類型

///

[JsonConverter(typeof(StringEnumConverter))]

publicNotifyTypeType{get;set;}

}

其它的都不變，在Type屬性上加上了JsonConverter(typeof(StringEnumConverter))表示將枚舉值轉(zhuǎn)換成對(duì)應(yīng)的字符串,而StringEnumConverter是Newtonsoft.Json內(nèi)置的轉(zhuǎn)換類型,最終輸出結(jié)果：{Type:Mail}

九、Dynamic類型的序列化

在.Net4.0中,Dynamic基本上有兩種用法.

第一種是作為屬性來用，在這種情況下序列化時(shí)會(huì)根據(jù)實(shí)際的類型來序列化。第二種用法是繼承了IDynamicMetaObjectProvider接口或者DynamicObject基類。例如.Net中內(nèi)置的類ExpandoObject,這三者之間的關(guān)系是:ExpandoObject,DynamicObject都繼承了IDynamicMetaObjectProvider.

這種情況下,只有DynamicMetaObject.GetDynamicMemberNames的返回的成員的屬性會(huì)被序列化.

首先新建一個(gè)類,繼承基類DynamicObject,在主程序中,做如下操作:

voidMain()

dynamicmd=newMyDynamic();//必須是用dynamic來聲明變量，不能用MyDynamic,否則它就不是動(dòng)態(tài)類型了。

md.Name="Jack";

Actionstringoutput=newActionstring((value)={Console.WriteLine(value);});

md.Output=output;

Console.WriteLine(JsonConvert.SerializeObject(md));

md.Output(md.Name);

//{"Name":"Jack","Output":{"Delegate":{},"target0":{},"method0":{"Name":"

b__0_0","AssemblyName":"query_dmdxhj,Version=,Culture=neutral,PublicKeyToken=null","ClassName":"UserQuery+c","Signature":"Void

b__0_0(System.String)","Signature2":"System.Void

b__0_0(System.String)","MemberType":8,"GenericArguments":null}}}

//Jack

publicclassMyDynamic:DynamicObject

//用來存儲(chǔ)動(dòng)態(tài)添加的變量和值

privateDictionarystring,objectmembers=newDictionarystring,object

///

///獲取所有的動(dòng)態(tài)成員名稱

///

///動(dòng)態(tài)成員名稱

publicoverrideIEnumerablestringGetDynamicMemberNames()

returnmembers.Keys;

///

///設(shè)置動(dòng)態(tài)成員名稱，也就是在發(fā)生賦值語句時(shí)出發(fā)該方法

///例如：dynamicdy=newMyDynamic();

///dy.Name="Jack";

///

///用于動(dòng)態(tài)設(shè)置操作

///預(yù)設(shè)的值

///

publicoverrideboolTrySetMember(SetMemberBinderbinder,objectvalue)

if(!members.ContainsKey(binder.Name))

members.Add(binder.Name,value);

else

members[binder.Name]=value;

returntrue;

///

///根據(jù)名稱獲取動(dòng)態(tài)成員的值

///例如：dynamicdy=newMyDynamic();

///var