Newtonsoft 六個超簡單又實用的特性，值得一試【上篇】

-Advertisement-

一：講故事看完官方文檔，閱讀了一些 Newtonsoft 源碼，對它有了新的認識，先總結六個超經典又實用的特性，同大家一起分享，廢話不多說，快來一起看看吧~~~ 二：特性分析 1. 代碼格式化如果你直接使用 JsonConvert.SerializeObject的話，預設情況下所有的json是 ...

一：講故事

看完官方文檔，閱讀了一些 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 就用蛇形，這樣顯得對別人友好一些，不是嘛

您的分享是我們最大的動力!