c# Newtonsoft 六个值得使用的特性（下）-C#/.NET开发

这篇文章主要介绍了c# 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);

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 序列化中也会遇到这种情况，在 JsonConvert 中使用 _additionalData 就可以帮你搞定，在 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}";
   }
  }