【Newtonsoft.Json Json.Net】02.01、序列化设置Serialization Settings

JsonSerializer有多个属性，用于自定义如何序列化JSON。这些也可以通过JsonSerializerSettings参数，在JsonConvert上使用。

属性的用法：

{//JsonConvert
    string json = "";
    var serializerSettings = new JsonSerializerSettings
    {
        DateFormatHandling = DateFormatHandling.IsoDateFormat,ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor,//ContractResolver = new.. .//MassTransit contract resolver that includes private setters
    };
    PageInfo obj = JsonConvert.DeserializeObject<PageInfo>(json,serializerSettings);
}
{//JsonSerializer 
    PageInfo obj = new PageInfo();

    JsonSerializer serializer = new JsonSerializer();
    serializer.DateFormatHandling = DateFormatHandling.IsoDateFormat;

    using (StreamWriter sw = new StreamWriter(@"c:\json.txt"))
    using (JsonWriter writer = new JsonTextWriter(sw))
    {
        serializer.Serialize(writer,obj);
    }
}

以下是各种属性：

DateFormatHandling

控制日期如何序列化。

IsoDateFormat：【默认值】用ISO 8601格式写日期，如："2012-03-21T05:40Z"

MicrosoftDateFormat：用Microsoft JSON格式写日期，如："\/Date(1198908717056)\/".

MissingMemberHandling

设置当JSON中包含类中没有的属性时，使用何种处理方式。

Ignore：【默认值】忽略掉该属性。

Error：出现此情况时报错。

ReferenceLoopHandling

设置循环引用的对象，如何进行序列化。

进行判断时，使用的是对象的Object.Equals(Object)方法，你也可以自行重写改对象的Object.Equals(Object) 方法，适应自己的需求。

Error：【默认值】报错。

Ignore：忽略，跳过循环引用对象。

Serialize：强制进行转换。当有循环引用，但并非无限循环时，可以使用。

ReferenceLoopHandling可以作为使用Serializer的一个参数，也可以在对象的属性或集合上使用ItemReferenceLoopHandling来设置。

NullValueHandling

控制空值在序列化和反序列化时如何处理。

NullValueHandling controls how null values on .NET objects are handled during serialization and how null values in JSON are handled during deserialization.

Include：【默认值】写JSON时写空值；赋值对象字段/属性时也给空值。

Ignore：写JSON时，将这个属性跳过；赋值对象字段/属性时也跳过赋值。

可以使用JsonPropertyAttribute特性注解，为单独的字段设置NullValueHandling 

DefaultValueHandling

控制序列化和反序列时如何使用默认值。

Include：【默认值】序列化时，如果对象字段/属性的值等于默认值，会写进JSON；反序列化时，如果JSON值等于默认值，仍会赋值字段/属性的值；

Ignore：在值和默认值相等时，写JSON会跳过该字段/属性；赋值对象，也会跳过该属性。

可以使用JsonPropertyAttribute特性注解，为单独的字段设置DefaultValueHandling。

ObjectCreationHandling

控制反序列化时，如何创建对象和反序列化

Auto：【默认值】给已创建的对象的字段/属性，或集合直接赋值。

Reuse：同Auto。

Replace：赋值前会重新创建对象，再进行赋值和反序列化。

可以使用JsonPropertyAttribute特性注解，为单独的字段设置ObjectCreationHandling。

TypeNameHandling

控制序列化时，在JSON中包含$type属性，表示.NET的类型名；反序列化时，通过$type属性，决定使用什么.NET数据类型。

元数据属性如$type必须在JSON对象的开头。如果无法决定这个顺序，可以通过MetadataPropertyHandling属性移除这个限制。

可以自己实现ISerializationBinder来自定义$type属性和验证

注意：当使用一个来源外部的JSON进行反序列化时，应该小心使用使用TypeNameHandling。当使用非TypeNameHandling.None进行反序列化时时，带入的类型必须使用自定义的ISerializationBinder进行验证。

None：【默认值】不会读或写类型名称。

Objects：除了集合类型，会读和写其它对象类型的名称。

Arrays：会读写集合类型的名称，但其它对象类型不会进行读写。

Auto：Json.NET会自动检测对象/集合是否匹配他定义的类型，如果不匹配，就写类型名称。比如哺乳类动物的类，派生了一个类是狗，当检测到这个类序列化或反序列化时能对应狗这个类，则不需要写类型名；否则才加上这个类型名。

All：所有对象和集合的类型名都写上。

TypeNameHandling可以作为serializer调用是的参数，也可以在对象属性或集合上使用ItemTypeNameHandling。

属性上使用TypeNameHandling，对象或集合使用ItemTypeNameHandling。

TypeNameAssemblyFormat

控制序列化时如何书写类型名

Simple：【默认值】使用类型的部分程序集名称，如System.Data.DataSet。Silverlight and Windows Phone不能使用这种格式。

Full：使用类型的程序集全名，包括version number,culture and public key token。

了解关于FormatterAssemblyStyle的更多信息：https://msdn.microsoft.com/en-us/library/tt9xha1h

SerializationBinder

用于解决序列化和反序列化时，.NET类型和类型名称之间的转换问题。

如果启用TypeNameHandling ，那么必须创建一个自定义ISerializationBinder，来验证带入的类型名称是否安全有效。

MetadataPropertyHandling

设置元数据如$type和id在反序列化时如何读取

为了性能原因，JsonSerializer反序列化时假定元数据都在JSON的开头。如果你无法修改JSON的顺序，可以使用下面属性解除这个限制。

Default：【默认值】仅读取JSON开头的元数据。

ReadAhead：读取JSON任意地方的元数据。

Ignore：忽略元数据。

ConstructorHandling

控制反序列化的时候，初始化对象时，如何使用类的构造器。

Default：【默认值】查找使用的构造器的顺序如下

1、先查找被特性JsonConstructorAttribute标注的构造函数；

2、找public的无参构造函数

3、唯一的public带参构造函数

4、非public无参构造函数

如果到第3步，发现有多个public带参构造函数，则会报错；此时应使用JsonConstructorAttribute标注其中一个构造函数

AllowNonPublicDefaultConstructor：将3，4顺序反转

Converters

序列化和反序列化时，所使用到的JsonConverters的集合

JsonConverter允许手动实现读写，用于特别复杂的JSON或者改变读写方式。

当一个JsonConverter加入后，每一个值序列化或反序列化，都会调用其CanConvert，判断是否需要调用这个JsonConverter。

注意：JsonConverter给予了赋值的完全控制，有些特性像type name and reference handling可能就失效了。

使用方式：

1、JsonConverters可以作为调用serializer的参数；

2、可以在一个对象或属性上使用JsonConverterAttribute；

3、在一个对象的属性或一个集合的子项上使用ItemConverterType

4、a property‘s object properties or collection items using ItemConverterType【再试搞不懂这句】。

ContractResolver

对每一个.NET类型，JsonSerializer都创建了一个约束如何进行序列化和反序列化，这个约束可以进行自定义。

和上面的区别？暂时未了解。

TraceWriter

Json.NET使用ITraceWriter接口，支持写日志和调试。注册一个TraceWriter在序列化和序列化时进行调试和写日志。

Error

错误，错误时间可以捕获序列化时出现的错误，或者处理该错误后继续序列化，或者让错误抛出到程序中。