JSON序列化和反序列化最好的C#库——Newtonsoft.Json

一、什么是JSON？

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，可以将数据进行简单地描述和传输。它以键值对的方式组织数据，常用于前后端数据传输、数据存储和配置文件等场合。JSON的语法和JavaScript中的对象字面量非常类似，但是它是一种独立于编程语言的格式。C#提供了丰富的JSON序列化和反序列化库，其中最著名的是Newtonsoft.Json。

二、Newtonsoft.Json的优点

Newtonsoft.Json是一个功能强大的JSON序列化和反序列化库，它支持.NET Framework、.NET Core和Mono等多个平台，拥有广泛的应用。相较于C#自带的System.Text.Json库，它具有更好的兼容性和灵活性，可以满足各种复杂的JSON数据需求。

Newtonsoft.Json的主要优点包括：

1. 处理复杂数据结构更方便。

与System.Text.Json相比，Newtonsoft.Json更容易处理嵌套复杂的JSON数据结构，例如嵌套数组、嵌套对象等，而且提供了更多的自定义选项，便于根据需求调整序列化和反序列化的行为。

2. 支持自定义序列化规则。

Newtonsoft.Json提供了丰富的自定义序列化和反序列化选项，可以通过自定义JsonConverter来支持不规则的数据结构，如xml、csv等格式的数据。

3. 具有良好的性能和兼容性。

Newtonsoft.Json拥有良好的性能和兼容性，可以处理大量的JSON数据，且在各种平台和框架中都能够正常运行。它在github上的关注度和贡献者数量也很高，社区支持比较完善。

三、Newtonsoft.Json的基本用法

下面演示Newtonsoft.Json的基本用法，包括：对象序列化、对象反序列化、匿名类型序列化、匿名类型反序列化和JSON字符串转换。我们可以通过Nuget安装Newtonsoft.Json包，然后引入Newtonsoft.Json命名空间。

1. 对象序列化

对象序列化指将C#对象转换为JSON字符串，常用于网络传输或文件保存等。Newtonsoft.Json提供了JsonConvert.SerializeObject()方法来进行对象序列化，可以将对象转换为JSON字符串。

using Newtonsoft.Json;

public class Person {
    public string Name;
    public int Age;
}

Person person = new Person { Name = "张三", Age = 20 };
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json); // 输出：{"Name":"张三","Age":20}

2. 对象反序列化

对象反序列化指将JSON字符串转换为C#对象，常用于接收网络请求或读取文件等。Newtonsoft.Json提供了JsonConvert.DeserializeObject()方法来进行对象反序列化，可以将JSON字符串转换为对象。

string json = '{"Name":"张三","Age":20}';
Person person = JsonConvert.DeserializeObject<Person>(json);
Console.WriteLine(person.Name); // 输出：张三
Console.WriteLine(person.Age); // 输出：20

3. 匿名类型序列化

匿名类型指在声明时不指定类型名称的对象，常用于简单的数据快速传递。Newtonsoft.Json可以直接对匿名类型进行序列化，不需要声明额外的类型。

var person = new { Name = "张三", Age = 20 };
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json); // 输出：{"Name":"张三","Age":20}

4. 匿名类型反序列化

同样地，Newtonsoft.Json也可以对匿名类型进行反序列化。

string json = '{"Name":"张三","Age":20}';
var person = JsonConvert.DeserializeObject<dynamic>(json);
Console.WriteLine(person.Name); // 输出：张三
Console.WriteLine(person.Age); // 输出：20

5. JSON字符串转换

Newtonsoft.Json提供了JObject和JArray两种类型来方便地处理JSON字符串。

string json = '{"Name":"张三","Age":20}';
JObject obj = JObject.Parse(json);
string name = obj["Name"].ToString();
int age = (int)obj["Age"];
Console.WriteLine(name); // 输出：张三
Console.WriteLine(age); // 输出：20

四、Newtonsoft.Json高级用法

1. 序列化属性过滤

有时候，需要有选择地对对象进行序列化，只序列化其中的一些属性，跳过其他属性。可以使用JsonPropertyAttribute和JsonIgnoreAttribute属性来指定属性的序列化和忽略选项。

public class Person {
    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonIgnore]
    public int Age { get; set; }
}

Person person = new Person { Name = "张三", Age = 20 };
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json); // 输出：{"name":"张三"}

2. 自定义序列化方式

如果需要对特定类型进行自定义的序列化和反序列化操作，可以继承JsonConverter，并重写它的ReadJson和WriteJson方法。下面是一个将枚举值序列化成小写字符串的例子。

class LowercaseEnumConverter : JsonConverter {
    public override bool CanConvert(Type objectType) {
        return objectType.IsEnum;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) {
        writer.WriteValue(value.ToString().ToLowerInvariant());
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) {
        return Enum.Parse(objectType, (string)reader.Value, true);
    }
}

enum Gender { Male, Female };

public class Person {
    public string Name;
    [JsonConverter(typeof(LowercaseEnumConverter))]
    public Gender Gender;
}

Person person = new Person { Name = "张三", Gender = Gender.Male };
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json); // 输出：{"Name":"张三","Gender":"male"}

Person person2 = JsonConvert.DeserializeObject<Person>(json);
Console.WriteLine(person2.Gender); // 输出：Gender.Male

3. 非标准JSON序列化

有些特殊的JSON格式不符合标准的JSON规范。例如，如果在属性名中包含了非字母和数字字符，或者在数组中包含了不同类型的元素，标准的JSON库会报错。Newtonsoft.Json提供了一些选项，可以用于处理这些非标准的JSON格式。

string json = '{"field-a": 1, "field-b": "value-b", "field-c": true}';
JObject obj = JObject.Parse(json);
int fieldA = (int)obj["field-a"];
string fieldB = (string)obj["field-b"];
bool fieldC = (bool)obj["field-c"];
Console.WriteLine(fieldA); // 输出：1
Console.WriteLine(fieldB); // 输出：value-b
Console.WriteLine(fieldC); // 输出：True

string json2 = '[1, "value-b", True]';
JArray arr = JArray.Parse(json2);
int elem1 = (int)arr[0];
string elem2 = (string)arr[1];
bool elem3 = (bool)arr[2];
Console.WriteLine(elem1); // 输出：1
Console.WriteLine(elem2); // 输出：value-b
Console.WriteLine(elem3); // 输出：True

小结

Newtonsoft.Json是C#中最好的JSON序列化和反序列化库之一，具有灵活性、兼容性和性能优势。通过本文的介绍，我们了解了Newtonsoft.Json的基本用法和高级用法，可以满足各种复杂的JSON数据需求。在进行C#开发时，选择Newtonsoft.Json可以方便地处理JSON数据，提高效率。