Newtonsoft 六个超简单又实用的特性【上下篇】

【上篇】

一：讲故事

看完官方文档，阅读了一些 Newtonsoft 源码，对它有了新的认识，先总结 六个超经典又实用的特性，同大家一起分享，废话不多说，快来一起看看吧~~~

二：特性分析

1. 代码格式化

如果你直接使用 JsonConvert.SerializeObject的话，默认情况下所有的json是挤压在一块的，特别不方便阅读，如下所示：

        static void Main(string[] args)
        {
            var reportModel = new ReportModel()
            {
                ProductName = "法式小众设计感长裙气质显瘦纯白色仙女连衣裙",
                TotalPayment = 100,
                TotalCustomerCount = 2,
                TotalProductCount = 333
            };

            var json = JsonConvert.SerializeObject(reportModel);

            System.Console.WriteLine(json);
        }
    }

    public class ReportModel
    {
        public string ProductName { get; set; }
        public int TotalCustomerCount { get; set; }
        public decimal TotalPayment { get; set; }
        public int TotalProductCount { get; set; }
    }

那怎么办呢？ JsonConvert中提供了一个 Formatting.Indented 用来格式化json，这样在 debug 的过程中就非常友好，改造如下：

2. 踢掉没有被赋值的字段

如果你写过给 App 提供数据的后端服务，我相信你对手机流量这个词特别敏感，往往一个 Model 上有十几个字段，但需要传给 App 可能就 三四个字段，这就造成了巨大的流量浪费，如下图：

        static void Main(string[] args)
        {
            var reportModel = new ReportModel()
            {
                ProductName = "法式小众设计感长裙气质显瘦纯白色仙女连衣裙",
                TotalPayment = 100
            };

            var json = JsonConvert.SerializeObject(reportModel, Formatting.Indented);

            System.Console.WriteLine(json);
        }

从图中可以看到，TotalCustomerCount 和 TotalProductCount 这两个字段就没必要了，Netnewsoft 中提供了 DefaultValueHandling.Ignore 剔除默认值的枚举，太实用了，改造如下：

            var json = JsonConvert.SerializeObject(reportModel, Formatting.Indented,
                                                   new JsonSerializerSettings
                                                   {
                                                       DefaultValueHandling = DefaultValueHandling.Ignore
                                                   });

3. 兼容其他语言的 驼峰,蛇形命名法

每一套编程语言都有各自偏好的命名法，比如 js 中都喜欢采用 驼峰命名法，在 mysql 中我见过最多的 蛇形命名法，而我们在 C# 中序列化的属性一般都是大写字母开头，比如你看到的 特性二 中的字段，那这里就存在问题了，有没有办法兼容一下，给 js 就用 驼峰，给 mysql 就用 蛇形，这样显得对别人友好一些，不是嘛😄😄😄，接下来看看怎么改造。

• 驼峰命名 CamelCasePropertyNamesContractResolver

            var json = JsonConvert.SerializeObject(reportModel, Formatting.Indented,
                                                   new JsonSerializerSettings
                                                   {
                                                       ContractResolver = new CamelCasePropertyNamesContractResolver()
                                                   });

• 蛇形命名 SnakeCaseNamingStrategy

            var json = JsonConvert.SerializeObject(reportModel, Formatting.Indented,
                                                   new JsonSerializerSettings
                                                   {
                                                       ContractResolver = new DefaultContractResolver()
                                                       {
                                                           NamingStrategy = new SnakeCaseNamingStrategy()
                                                       }
                                                   });

4. 自定义属性的名字

如果你和第三方系统进行过对接开发，通常都会遇到这个问题，就拿 OpenTaobao 来说，我的Model总不能按照它文档这样定义吧，而且字段名称也不可能做到完全一致，如下图：

所以这里面必然要存在一个 Mapping 的过程，这就可以用 JsonProperty -> propertyName 帮你搞定，为了方便演示，我还是用 reportModel 吧。

    static void Main(string[] args)
    {
        var json = "{'title':'法式小众设计感长裙气质显瘦纯白色仙女连衣裙','customercount':1000,'totalpayment':100.0,'productcount':10000}";

        var reportModel = JsonConvert.DeserializeObject<ReportModel>(json);
    }

    public class ReportModel
    {
        [JsonProperty("title")] public string ProductName { get; set; }
        [JsonProperty("customercount")] public int TotalCustomerCount { get; set; }
        [JsonProperty("totalpayment")] public decimal TotalPayment { get; set; }
        [JsonProperty("productcount")] public int TotalProductCount { get; set; }
    }

5. 对字段的 正向剔除 和 反向剔除

可能有些朋友对这两个概念不是特别了解，这里我仅显示 Model 中的 ProductName 为例讲解一下：

• 正向剔除： 默认所有都显示，手工踢掉不显示的，使用 MemberSerialization.OptOut 配合 JsonIgnore

 		static void Main(string[] args)
        {
            var reportModel = new ReportModel()
            {
                ProductName = "法式小众设计感长裙气质显瘦纯白色仙女连衣裙",
                TotalPayment = 100
            };

            var json = JsonConvert.SerializeObject(reportModel, Formatting.Indented);

            System.Console.WriteLine(json);
        }

    [JsonObject(MemberSerialization.OptOut)]
    public class ReportModel
    {
        public string ProductName { get; set; }
        [JsonIgnore] public int TotalCustomerCount { get; set; }
        [JsonIgnore] public decimal TotalPayment { get; set; }
        [JsonIgnore] public int TotalProductCount { get; set; }
    }

• 反向剔除： 默认都不显示，手工指定要显示的，使用 MemberSerialization.OptIn 配合 JsonProperty

       
    [JsonObject(MemberSerialization.OptIn)]
    public class ReportModel
    {
        [JsonProperty] public string ProductName { get; set; }
        public int TotalCustomerCount { get; set; }
        public decimal TotalPayment { get; set; }
        public int TotalProductCount { get; set; }
    }

6. 多个json 合并到 一个Model

这个特性当初打破了我对 Newtonsoft 的认知观，不知道您呢？ 通常我们都会认为 一个 json 对应一个 model，一个 model 对应一个 json，居然还可以多个 json 对应一个 model 的情况，这就有意思了，场景大家可以自己想一想哈，这里使用 PopulateObject 方法就可以轻松帮你搞定，接下来看看怎么写这个代码：

        static void Main(string[] args)
        {
            var json1 = "{'ProductName':'法式小众设计感长裙气质显瘦纯白色仙女连衣裙'}";
            var json2 = "{'TotalCustomerCount':1000,'TotalPayment':100.0,'TotalProductCount':10000}";

            var reportModel = new ReportModel();

            JsonConvert.PopulateObject(json1, reportModel);
            JsonConvert.PopulateObject(json2, reportModel);
        }

是不是有点意思😄😄😄

三：总结

为了怕影响阅读体验，这一篇就先总结六个供大家欣赏，Newtonsoft 这玩意确实非常强大，太多的东西需要去挖掘，希望本篇对你有帮助，谢谢。

出处：Newtonsoft 六个超简单又实用的特性，值得一试 【下篇】 - 一线码农 - 博客园

==================================================================

Newtonsoft 六个超简单又实用的特性，值得一试 【下篇】

一：讲故事

上一篇介绍的 6 个特性从园子里的反馈来看效果不错，那这一篇就再带来 6 个特性同大家一起欣赏。

二：特性分析

1. 像弱类型语言一样解析 json

大家都知道弱类型的语言有很多，如: nodejs，python，php，它们有一个🐮👃的地方就是处理json，不需要像 强类型语言 那样还要给它配一个类，什么意思呢？ 就拿下面的 json 说事。

{
  "DisplayName": "新一代算法模型",
  "CustomerType": 1,
  "Report": {
    "TotalCustomerCount": 1000,
    "TotalTradeCount": 50
  },
  "CustomerIDHash": [1,2,3,4,5]
}

这个 json 如果想灌到 C# 中处理，你就得给它定义一个适配的类，就如 初篇 的客户算法模型类，所以这里就有了一个需求，能不能不定义类也可以自由解析上面这串 json 呢？？？ 哈哈，当然是可以的， 反序列化成 Dictionary 即可，就拿提取 Report.TotalCustomerCount 和 CustomerIDHash 这两个字段演示一下。

        static void Main(string[] args)
        {
            var json = @"{
                           'DisplayName': '新一代算法模型',
                           'CustomerType': 1,
                           'Report': {
                             'TotalCustomerCount': 1000,
                             'TotalTradeCount': 50
                           },
                           'CustomerIDHash': [1,2,3,4,5]
                         }";

            var dict = JsonConvert.DeserializeObject<Dictionary<object, object>>(json);

            var report = dict["Report"] as JObject;
            var totalCustomerCount = report["TotalCustomerCount"];

            Console.WriteLine($"totalCustomerCount={totalCustomerCount}");

            var arr = dict["CustomerIDHash"] as JArray;
            var list = arr.Select(m => m.Value<int>()).ToList();

            Console.WriteLine($"list={string.Join(",", list)}");
        }

2. 如何让json中的枚举保持更易读的字符串型

这句话是什么意思呢？ 默认情况下， SerializeObject 会将 Model 中的 Enum 变成数值型，大家都知道数值型语义性是非常差的，如下代码所示：

    static void Main(string[] args)
    {
        var model = new ThreadModel() { ThreadStateEnum = System.Threading.ThreadState.Running };

        var json = JsonConvert.SerializeObject(model);

        Console.WriteLine(json);
    }

    class ThreadModel
    {
        public System.Threading.ThreadState ThreadStateEnum { get; set; }
    }

对吧，确实语义特别差，那能不能直接生成 Running 这种字符串形式呢？ 当然可以了。。。改造如下：

  var json = JsonConvert.SerializeObject(model, new StringEnumConverter());

这里可能就有人钻牛角尖了，能不能部分指定让枚举生成 string，其他的生成 int ，没关系，这也难不倒我，哪里使用就用 JsonConverter 标记哪里。。。

        static void Main(string[] args)
        {
            var model = new ThreadModel()
            {
                ThreadStateEnum = System.Threading.ThreadState.Running,
                TaskStatusEnum = TaskStatus.RanToCompletion
            };

            var json = JsonConvert.SerializeObject(model);

            Console.WriteLine(json);
        }

        class ThreadModel
        {
            public System.Threading.ThreadState ThreadStateEnum { get; set; }

            [JsonConverter(typeof(StringEnumConverter))]
            public TaskStatus TaskStatusEnum { get; set; }
        }        

3. 格式化 json 中的时间类型

在 model 转化成 json 的过程中，总少不了 时间类型，为了让时间类型 可读性更高，通常会 格式化为 YYYY年/MM月/dd日 ，那如何实现呢？ 很简单撒，在 JsonConvert 中也是一个 枚举 帮你搞定。。。

        static void Main(string[] args)
        {
            var json = JsonConvert.SerializeObject(new Order()
            {
                OrderTitle = "女装大佬",
                Created = DateTime.Now
            }, new JsonSerializerSettings
            {
                DateFormatString = "yyyy年/MM月/dd日",
            });

            Console.WriteLine(json);
        }
        public class Order
        {
            public string OrderTitle { get; set; }
            public DateTime Created { get; set; }
        }   

对了，我记得很早的时候，C# 自带了一个 JavaScriptSerializer, 也是用来进行 model 转 json的，但是它会将 datetime 转成 时间戳，而不是时间字符串形式，如果你因为特殊原因想通过 JsonConvert 将时间生成时间戳的话，也是可以的, 用 DateFormatHandling.MicrosoftDateFormat 枚举指定一下即可，如下：

4. 对一些常用设置进行全局化

在之前所有演示的特性技巧中都是在 JsonConvert 上指定的，也就是说 100 个 JsonConvert 我就要指定 100 次，那有没有类似一次指定，整个进程通用呢？ 这么强大的 Newtonsoft 早就支持啦, 就拿上面的 Order 举例：

        JsonConvert.DefaultSettings = () =>
        {
            var settings = new JsonSerializerSettings
            {
                Formatting = Formatting.Indented
            };
            return settings;
        };

        var order = new Order() { OrderTitle = "女装大佬", Created = DateTime.Now };

        var json1 = JsonConvert.SerializeObject(order);
        var json2 = JsonConvert.SerializeObject(order);

        Console.WriteLine(json1);
        Console.WriteLine(json2);

可以看到，Formatting.Indented 对两串 json 都生效了。

5. 如何保证 json 到 model 的严谨性 及提取 json 未知字段

有时候我们有这样的需求，一旦 json 中出现 model 未知的字段，有两种选择： 要么报错，要么提取出未知字段，在 Newtonsoft 中默认的情况是忽略，场景大家可以自己找哈。

• 未知字段报错

        static void Main(string[] args)
        {
            var json = "{'OrderTitle':'女装大佬', 'Created':'2020/6/23','Memo':'订单备注'}";

            var order = JsonConvert.DeserializeObject<Order>(json, new JsonSerializerSettings
            {
                MissingMemberHandling = MissingMemberHandling.Error
            });

            Console.WriteLine(order);
        }

        public class Order
        {
            public string OrderTitle { get; set; }
            public DateTime Created { get; set; }
            public override string ToString()
            {
                return $"OrderTitle={OrderTitle}, Created={Created}";
            }
        }        

• 提取未知字段

我依稀的记得 WCF 在这种场景下也是使用一个 ExtenstionDataObject 来存储客户端传过来的未知字段，有可能是客户端的 model 已更新，server端还是旧版本，通常在 json 序列化中也会遇到这种情况，这里只要使用 JsonExtensionData 特性就可以帮你搞定，在 OnDeserialized 这种AOP方法中进行拦截，如下代码：

    static void Main(string[] args)
    {
        var json = "{'OrderTitle':'女装大佬', 'Created':'2020/6/23','Memo':'订单备注'}";

        var order = JsonConvert.DeserializeObject<Order>(json);

        Console.WriteLine(order);
    }

    public class Order
    {
        public string OrderTitle { get; set; }

        public DateTime Created { get; set; }

        [JsonExtensionData]
        private IDictionary<string, JToken> _additionalData;

        public Order()
        {
            _additionalData = new Dictionary<string, JToken>();
        }

        [OnDeserialized]
        private void OnDeserialized(StreamingContext context)
        {
            var dict = _additionalData;
        }

        public override string ToString()
        {
            return $"OrderTitle={OrderTitle}, Created={Created}";
        }
    }        

6. 开启 JsonConvert 详细日志功能

有时候在查阅源码的时候开启日志功能更加有利于理解源码的内部运作，所以这也是一个非常实用的功能，看看如何配置吧。

        static void Main(string[] args)
        {
            var json = "{'OrderTitle':'女装大佬', 'Created':'2020/6/23','Memo':'订单备注'}";

            MemoryTraceWriter traceWriter = new MemoryTraceWriter();

            var account = JsonConvert.DeserializeObject<Order>(json, new JsonSerializerSettings
            {
                TraceWriter = traceWriter
            });

            Console.WriteLine(traceWriter.ToString());
        }

        public class Order
        {
            public string OrderTitle { get; set; }

            public DateTime Created { get; set; }

            public override string ToString()
            {
                return $"OrderTitle={OrderTitle}, Created={Created}";
            }
        }

三：总结

嘿嘿，这篇 6 个特性就算说完了， 结合上一篇一共 12 个特性，是不是非常简单且实用，后面准备给大家带来一些源码解读吧! 希望本篇对您有帮助，谢谢！