C# Newtonsoft.Json JsonSerializerSettings配置序列化操作

落日映苍穹つ 2022-06-15 08:46 903阅读 0赞

**JsonSerializerSettings常用配置整理**

1.忽略某些属性

2.默认值的处理

3.空值的处理

4.支持非公共成员

5.日期处理（DateFormatHandling）

6.自定义序列化的字段名称

7.动态决定属性是否序列化

8.枚举值的自定义格式化问题

9.自定义类型转换

10.全局序列化设置

11.指定序列化时Key的处理方式：驼峰样式，默认样式（ContractResolver）

12.序列化循环 引用及处理层数

特别 说明：Newtonsoft.Json不依赖.Net Framework,是基于 .Net Standard封装的，仅支持.Net Framework也支持.Net Core

官网地址：[http://www.newtonsoft.com/json][http_www.newtonsoft.com_json]，Nuget 地址：[https://www.nuget.org/packages/Newtonsoft.Json][https_www.nuget.org_packages_Newtonsoft.Json]

![Center][]

**一 、忽略某些属性**

类似本问开头介绍的接口优化，实体中有些属性不需要序列化返回，可以使用该特性。首先介绍Json.Net序列化的模式:OptOut 和 OptIn

<table style="border:1px solid silver; border-collapse:collapse; word-break:break-word; color:rgb(0,0,0); font-family:&quot;black Verdana&quot;,Arial,Helvetica,sans-serif; font-size:14px"> 
 <tbody> 
  <tr> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">OptOut &nbsp; &nbsp; &nbsp;</span></td> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">默认值,类中所有公有成员会被序列化,如果不想被序列化,可以用特性<span style="color:rgb(128,128,128)">JsonIgnore</span></span></td> 
  </tr> 
  <tr> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">OptIn</span></td> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">默认情况下,所有的成员不会被序列化,类中的成员只有标有特性<span style="color:rgb(128,128,128)">JsonProperty的才会被序列化,当类的成员很多,但客户端仅仅需要一部分数据时,很有用</span></span></td> 
  </tr> 
 </tbody> 
</table>

不指定的情况下，类都可以序列化，所有的公共属性都会处理。

忽略指定属性实例：

[JsonObject(MemberSerialization.OptIn)]
        public class Person
        {
            public int Age { get; set; }
    
            [JsonProperty]
            public string Name { get; set; }
    
            public string Sex { get; set; }
    
            public bool IsMarry { get; set; }
    
            public DateTime Birthday { get; set; }
        }

**二、默认值处理**

序列化时想忽略默认值属性可以通过JsonSerializerSettings.DefaultValueHandling来确定，该值为枚举值

<table style="border:1px solid silver; border-collapse:collapse; word-break:break-word; color:rgb(0,0,0); font-family:&quot;black Verdana&quot;,Arial,Helvetica,sans-serif; font-size:14px"> 
 <tbody> 
  <tr> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"> <pre style="margin-top:0px; margin-bottom:0px; white-space:pre-wrap; word-wrap:break-word"><span style="font-size:15px"><span style="color:rgb(43,145,175)">DefaultValueHandling.Ignore </span></span></pre> </td> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">序列化和反序列化时,忽略默认值</span></td> 
  </tr> 
  <tr> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"> <pre style="margin-top:0px; margin-bottom:0px; white-space:pre-wrap; word-wrap:break-word"><span style="font-size:15px"><span style="color:rgb(43,145,175)">DefaultValueHandling.Include </span></span></pre> </td> 
   <td style="border:1px solid silver; border-collapse:collapse; padding:3px"><span style="font-size:15px">序列化和反序列化时,包含默认值</span></td> 
  </tr> 
 </tbody> 
</table>

不指定的情况下，序列化时包含 默认值。

**三、空值处理**

序列化时需要忽略值为NULL的属性，可以通过JsonSerializerSettings.NullValueHandling来确定，另外通过JsonSerializerSettings设置属性是对序列化过程中所有属性生效的，想单独对某一个属性生效可以使用JsonProperty，下面将分别展示两个方式

四 、支持 非公共成员

序列化时默认都是处理公共成员，如果需要处理非公共成员，就要在该成员上加特性"JsonProperty"

[JsonProperty]
     private int Height { get; set; }

## ** 五、日期格式处理** ##

对于Dateime类型日期的格式化就比较麻烦了，系统自带的会格式化成iso日期标准![290743047903040.png][]，但是实际使用过程中大多数使用的可能是yyyy-MM-dd 或者yyyy-MM-dd HH:mm:ss两种格式的日期，解决办法是可以将DateTime类型改成string类型自己格式化好，然后在序列化。如果不想修改代码，可以采用下面方案实现。

Json.Net提供了IsoDateTimeConverter日期转换这个类，可以通过JsnConverter实现相应的日期转换

[JsonConverter(typeof(IsoDateTimeConverter))]
        public DateTime Birthday { get; set; }

处理方式1.JsonSerializerSettings.DateFormatHandling 指定时间处理格式

处理方式2.DateTimeConverterBase 扩展重写时间处理

示例如下：

using Newtonsoft.Json;
    using Newtonsoft.Json.Converters;
    namespace System
    {
        public class LongDateTimeConvert : IsoDateTimeConverter
        {
            public LongDateTimeConvert() : base()
            {
                base.DateTimeFormat = "yyyy/MM/dd HH:mm";
            }
        }
    }

使用：

[Newtonsoft.Json.JsonConverter(typeof(LongDateTimeConvert))]
    public DateTime CreateTime { get; set; }

**六、自定义序列化的 字段名称**

** **实体中定义的属性名可能不是自己想要的名称，但是又不能更改实体定义，这个时候可以自定义序列化字段名称。

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

七、动态决定属性是否序列化

承默认的DefaultContractResolver类，传入需要输出的属性，扩展操作，指定JsonSerializerSettings.ContractResolver的实例

八、枚举值的 自定义格式化处理

默认枚举输出的是枚举的 值

public enum NotifyType
        {
            /// <summary>
            /// Emil发送
            /// </summary>
            Mail=0,
    
            /// <summary>
            /// 短信发送
            /// </summary>
            SMS=1
        }
    
        public class TestEnmu
        {
            /// <summary>
            /// 消息发送类型
            /// </summary>
            public NotifyType Type { get; set; }
        }
        JsonConvert.SerializeObject(new TestEnmu());

输出结果：![336693-20150910171743028-388882267.png][]  现在改造一下，输出"Type":"Mail"

public class TestEnmu
        {
            /// <summary>
            /// 消息发送类型
            /// </summary>
            [JsonConverter(typeof(StringEnumConverter))]
            public NotifyType Type { get; set; }
        }

其它的都不变，在Type属性上加上了JsonConverter(typeof(StringEnumConverter))表示将枚举值转换成对应的字符串,而StringEnumConverter是Newtonsoft.Json内置的转换类型,最终输出结果

![336693-20150910172109044-1714459886.png][]

九、自定义 类型转换。

需要扩展类JsonConverter类 。

**十、全局序列化设置**

文章开头提出了Null值字段怎么不返回的问题，相应的在高级用法也给出了相应的解决方案使用jsetting.NullValueHandling = NullValueHandling.Ignore; 来设置不返回空值。这样有个麻烦的地方，每个不想返回空值的序列化都需设置一下。

Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();
       JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
       {
    　　　　//日期类型默认格式化处理
       　　setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
          setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
    
    　　　 //空值处理
          setting.NullValueHandling = NullValueHandling.Ignore;
    
          //高级用法九中的Bool类型转换 设置
          setting.Converters.Add(new BoolConvert("是,否"));
    
          return setting;
       });

**十一、序列化时 指定Key的处理方式，为驼峰式**

**CamelCasePropertyNamesContractResolver**

//设置序列化时key为驼峰样式
    JsonSerializerSettings settings = new JsonSerializerSettings();
    settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    settings.Formatting = Formatting.Indented;
    
    string str = JsonConvert.SerializeObject(menus, settings);
    Console.WriteLine(str);

![Center 1][]  
输出 字符串格式化处理指定如下，默认没有换行处理。

//Formatting.Indented 格式化json字符串数据,锯齿状的
    string str = JsonConvert.SerializeObject(menus,Formatting.Indented);

**十二、对于Newtonsoft.Json默认 已经处理过循环引用，**

也就是对于关联表的 对象或列表都不会序列化出来。

//设置循环引用，及引用类型序列化的层数。
    //注：目前在 EF core中目前不支持延迟加载，无所谓循环引用了
    JsonSerializerSettings settings = new JsonSerializerSettings();
    settings.Formatting = Formatting.Indented;
    settings.MaxDepth = 10; //设置序列化的最大层数
    settings.ReferenceLoopHandling = ReferenceLoopHandling.Serialize;//指定如何处理循环引用，None--不序列化，Error-抛出异常，Serialize--仍要序列化

[C\# Newtonsoft.Json之LINQ To Json实例(二)][C_ Newtonsoft.Json_LINQ To Json]

[C\# Newtonsoft.Json之LINQ To Json实例(一)][C_ Newtonsoft.Json_LINQ To Json 1]

[C\# Json序列化工具--Newtonsoft.Json简介和使用][C_ Json_--Newtonsoft.Json]

[http://www.cnblogs.com/yanweidie/p/4605212.html][http_www.cnblogs.com_yanweidie_p_4605212.html]

[http_www.newtonsoft.com_json]: http://www.newtonsoft.com/json
[https_www.nuget.org_packages_Newtonsoft.Json]: https://www.nuget.org/packages/Newtonsoft.Json
[Center]: /images/20220615/fb66c8ddc2114e6ebe0afe42e308ed14.png
[290743047903040.png]: /images/20220615/379051f9e998438eb0ee818c6af4ed29.png
[336693-20150910171743028-388882267.png]: /images/20220615/ecce1a8be5fb48ad98af6ab64318247a.png
[336693-20150910172109044-1714459886.png]: /images/20220615/c21740e51b164dd493e40d6c026e86d9.png
[Center 1]: /images/20220615/df485c17f37e4b8390b6df30124ae68e.png
[C_ Newtonsoft.Json_LINQ To Json]: http://blog.csdn.net/u011127019/article/details/52487130
[C_ Newtonsoft.Json_LINQ To Json 1]: http://blog.csdn.net/u011127019/article/details/52486867
[C_ Json_--Newtonsoft.Json]: http://blog.csdn.net/u011127019/article/details/51706619
[http_www.cnblogs.com_yanweidie_p_4605212.html]: http://www.cnblogs.com/yanweidie/p/4605212.html