Json.NET（反）序列化邮件地址

Question

在查看了许多 Google 搜索和 StackOverflow 帖子后，我得出结论，我可能需要创建自己的转换器。然而，这对我来说是非常非常新的，我不确定我在这些帖子中看到的哪些示例（如果有的话）我应该使用。

我有这个课（实际课比这个更复杂）

public class Person {
    [JsonProperty(PropertyName = "id")]
    public string PersonId { get; set; }

    [JsonProperty(PropertyName = "firstName")]
    public string PersonFirstName { get; set; }

    [JsonProperty(PropertyName = "email")]
    public MailAddress PersonEmail { get; set; }
}

我需要对下面的json进行序列化和反序列化

{
    "id" : "abc123"
    , "firstName" : "John"
    , "email" : "john@doe.com"
}

如何将 MailAddress 反序列化为包含 MailAddress.Address 的 string，反之亦然。

我得到的错误是：

无法从 System.String 转换或转换为 System.Net.Mail.MailAddress

Answer 1

Json.NET 不适用于某些 .Net 类型，例如 System.Net.IPAddress 或 System.Net.Mail.MailAddress。除非您愿意修改您的 JSON，否则您必须编写一个自定义转换器才能使用它们（代码取自 here）：

public class MailAddressConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var mailAddress = value as MailAddress;
        writer.WriteValue(mailAddress == null? string.Empty : mailAddress.ToString());
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var text = reader.Value as string;
        MailAddress mailAddress;

        return IsValidMailAddress(text, out mailAddress) ? mailAddress : null;
    }

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

    private static bool IsValidMailAddress(string text, out MailAddress value)
    {
        try
        {
            value = new MailAddress(text);
            return true;
        }
        catch
        {
            value = null;
            return false;
        }
    }
}

然后，您可以按照该帖子的作者的建议修改您的课程：

public class Person 
{
    [JsonProperty(PropertyName = "id")]
    public string PersonId { get; set; }

    [JsonProperty(PropertyName = "firstName")]
    public string PersonFirstName { get; set; }

    [JsonConverter(typeof(MailAddressConverter))]
    [JsonProperty(PropertyName = "email")]
    public MailAddress PersonEmail { get; set; }
}

..或者，你可以使用我的首选方式，也就是使用Json.NET的JsonSerializerSettings：

public sealed class SerializerSettings : JsonSerializerSettings
{
    public SerializerSettings() : base()
    {
        this.Converters.Add(new MailAddressConverter());
    }
}

然后在你的Main():

JsonConvert.DefaultSettings = () => new SerializerSettings();

Answer 2

你的 json 结构需要是这样的，因为MailAddress 是一个对象：

{
    "id": "1",
    "firstName": "George",
    "email": {
        "DisplayName": "",
        "User": "test",
        "Host": "test.com",
        "Address": "test@test.com"
    }
}

您可以进行这样的快速测试以查看生成的 JSON：

var person = new Person
{
    PersonEmail = new System.Net.Mail.MailAddress("test@test.com"),
    PersonFirstName = "George",
    PersonId = "1"
};

var serialized = JsonConvert.SerializeObject(person);