c#Newtonsoft六个值得使用的特性（下）

本文将介绍c#中使用Newtonsoft.Json的六个值得使用的特性，并提供示例来帮助您更好地理解这些特性。

1. JsonConverter

JsonConverter 允许我们创建一个自定义的序列化器（serializer）来处理我们的 JSON 对象。我们可以在实现JsonConverter类时覆盖带有特定标记的方法，比如 （ WriteJson， ReadJson，CanConvert）。 而一旦遇到要处理的特定类型，它将引用自定义的序列化器，而无需进一步的配置。

示例

我们先定义一个自定义类型，然后实现JsonConverter来序列化和反序列化该类型。

定义我们的 Person 类型：

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
}

然后实现JsonConverter类：

public class PersonConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        Person person = value as Person;
        if (person == null)
        {
            writer.WriteNull();
            return;
        }
        writer.WriteStartObject();
        writer.WritePropertyName("FullName");
        writer.WriteValue($"{person.FirstName} {person.LastName}");
        writer.WritePropertyName("Age");
        writer.WriteValue(person.Age);
        writer.WriteEndObject();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JObject obj = serializer.Deserialize<JObject>(reader);
        var person = new Person();
        person.FirstName = obj["FullName"].ToString().Split(" ")[0];
        person.LastName = obj["FullName"].ToString().Split(" ")[1];
        person.Age = Convert.ToInt32(obj["Age"]);
        return person;
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(Person);
    }
}

现在我们可以使用这个序列化器来序列化人员类，而无需其他的配置。

Person person = new Person()
{
    FirstName = "Tom",
    LastName = "Smith",
    Age = 30
};

var settings = new JsonSerializerSettings();
settings.Converters.Add(new PersonConverter());

var json = JsonConvert.SerializeObject(person, settings);

Console.WriteLine(json);

输出：

{
   "FullName": "Tom Smith",
   "Age": 30
}

2. JsonProperty

JsonProperty 可以让我们针对某一个属性指定序列化和反序列化时的JSON名称和顺序。例如， 如果我们想要保持某个属性的名称不变，而改变另一个属性的JSON名称，那么就可以使用这个属性。

示例

我们修改一下 Person 类型，给其中一些属性加上Json属性映射：

public class Person
{
    [JsonProperty("FirstName")]
    public string FName { get; set; }

    [JsonProperty("LastName")]
    public string LName { get; set; }

    [JsonProperty(Order = 2)]
    public int Age { get; set; }

    [JsonProperty(Order = 1)]
    public string Country { get; set; }
}

现在我们试试将 Person 类型序列化为JSON字符串：

Person person = new Person()
{
    FName = "Tom",
    LName = "Smith",
    Age = 30,
    Country = "USA"
};
var json = JsonConvert.SerializeObject(person);

Console.WriteLine(json);

输出：

{
   "Country": "USA",
   "Age": 30,
   "FirstName": "Tom",
   "LastName": "Smith"
}

可以看到，Country属性先于Age输出，Age和Country的顺序在Person中定义好了。

结论

使用 JsonConverter 和 JsonProperty 这两个特性能够让我们更灵活地控制我们的JSON数据的序列化和反序列化。我们可以在 JsonConverter 中自定义序列化器来处理自定义类型，而 JsonProperty 可以控制属性的JSON名称和顺序。