c# Newtonsoft.Json 常用方法总结

简介

Newtonsoft.Json 是一个高性能的 JSON 框架，为 JSON 互转提供了一系列便捷易用的 API，是 .NET 应用开发不可缺少的一部分。本文将介绍 Newtonsoft.Json 常用方法的总结，并且通过具体的示例进行说明，帮助读者更好的理解和应用。

安装

Newtonsoft.Json 可以通过 Nuget 进行安装。在 Visual Studio 中选择需要安装的项目，右键单击项目，选择“管理 Nuget 程序包”，然后在“浏览”选项卡中搜索“Newtonsoft.Json”，选择需要安装的版本进行安装即可。

序列化与反序列化

序列化

序列化就是将对象的状态信息转换为可存储或可传输的格式的过程，通常序列化的结果可以被反序列化还原成原始对象。序列化后的数据比较容易在网络中传输或者写入到文件等数据存储介质中。

        public static string Serialize(object obj)
        {
            if (obj == null)
            {
                return null;
            }
            return JsonConvert.SerializeObject(obj, Formatting.None, new JsonSerializerSettings
            {
                NullValueHandling = NullValueHandling.Ignore
            });
        }

在上面的示例代码中，我们定义了一个 Serialize 方法，该方法基于 Newtonsoft.Json 提供的 JsonConvert 类将一个对象序列化成一个 JSON 字符串。为了避免将 null 值信息也序列化进 JSON 字符串中，我们在这里使用了 JsonSerializerSettings 对象，并将在对象中设置 NullValueHandling 为 NullValueHandling.Ignore，以确保序列化的时候会忽略 null 值对象。

反序列化

反序列化是将序列化后的数据在还原成原始对象的过程。一般是对网络传输或者文件读取得到的数据进行反序列化操作。与序列化不同，反序列化时需要提供编译类型以保证还原的是和原始对象类型一致的信息。

        public static T Deserialize<T>(string json)
        {
            if (string.IsNullOrEmpty(json))
            {
                return default(T);
            }
            return JsonConvert.DeserializeObject<T>(json);
        }

在上面的示例代码中，我们定义了一个 Deserialize<T> 方法，该方法基于 Newtonsoft.Json 提供的 JsonConvert 类将一个 JSON 字符串反序列化成对应的对象。这个方法的定义是泛型类型的，这意味着我们需要在调用的时候显式指定类型信息。需要注意的是，在反序列化之前，我们需要确保 JSON 字符串有效，否则会抛出异常。

序列化和反序列化示例

using System;
using Newtonsoft.Json;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}
class Program
{
    static void Main()
    {
        Person person = new Person() { Name = "Tom", Age = 28 };

        //将实例对象序列化成JSON字符串
        string json = JsonConvert.SerializeObject(person);

        Console.WriteLine(json);

        //将JSON字符串反序列化成实例对象
        Person deserializedPerson = JsonConvert.DeserializeObject<Person>(json);

        Console.WriteLine(deserializedPerson.Name);
        Console.WriteLine(deserializedPerson.Age);
    }
}

在上面的示例代码中，我们定义了一个 Person 类，该类包含两个属性，Name 和 Age，分别用于保存人员姓名和年龄信息。在 Program 类的 Main 方法中，我们创建了一个 Person 对象，并将其序列化成一个 JSON 字符串。然后，我们使用反序列化的方式，将 JSON 字符串还原成一个 Person 对象，并将其输出到控制台。