成员 class 未按定义的方式序列化

Question

如何确保另一个 class 中的自定义 class 按照定义进行序列化？

我有一个 class:

public class Event
{
    public string Type { get; set; }
    public DateTime Timestamp { get; set; }

    public override string ToString()
    {
        return JsonConvert.SerializeObject(this, Utils.IsoDateTimeConverter());
    }
}

IsoDateTimeConverter()定义如下：

public static class Utils
{
    private static IsoDateTimeConverter isoDateTimeConverter = null;

    public static IsoDateTimeConverter IsoDateTimeConverter()
    {
        if (isoDateTimeConverter == null)
        {
            isoDateTimeConverter = new IsoDateTimeConverter
            {
                DateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffffffZ";
            };
        }

        return isoDateTimeConverter;
    }
}

如果我在 Event 对象上调用 .ToString()，项目会正确序列化（TimeStamp 的格式正确，即我定义的格式）：

var testEvent = new Event() { Type = "Test", Timestamp = new DateTime(2021, 7, 12, 11, 6, 36, 0) };
var result = testEvent.ToString();

结果

{
   "Type":"Test",
   "Timestamp":"2021-07-12T11:06:36.0000000Z"
}

如果我围绕事件创建包装器 class UserEvent，并尝试对其进行序列化，则事件 class 的序列化方式不同：

public class UserEvent
{
    public string UserId { get; set; }
    public Event Event { get; set; }

    public override string ToString()
    {
        return JsonConvert.SerializeObject(this);
    }
}
// Example of usage:
var testEvent = new Event() { Type = "Test", Timestamp = new DateTime(2021, 7, 12, 11, 6, 36, 0);
var testUserEvent = new UserEvent(){UserId = "TestId", Event = testEvent};
var result = testUserEvent.ToString();

结果

{
   "UserId":"TestUserId",
   "Event":{
      "Type":"Test",
      "Timestamp":"2021-07-12T11:06:36"
   }
}

请注意，时间戳的格式与以前不同。

如何确保当 Event 在另一个 class 中时它被正确序列化？

编辑 1：我知道如果我将 UserEvent 序列化为 JsonConvert.SerializeObject(this, Utils.IsoDateTimeConverter())，输出将符合预期，但我不想这样做，因为我不想这样做' 希望包装器 class 知道内部 class 的样子以及应该如何对其进行序列化。内部 class 应该按照它在其中定义的方式进行序列化。

Answer 1

我建议创建一个自定义的 IsoDateTimeConverter class，您可以在其中覆盖 DateTimeFormat:

public class CustomIsoDateTimeConverter: IsoDateTimeConverter 
{
    public CustomIsoDateTimeConverter()
    {
       DateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffffffZ";
    }
}

您可以在没有工厂方法的情况下使用此 class（例如 IsoDateTimeConverter()）

您可以使用JsonConverterAttribute装饰您的Timestamp 属性:

public class Event
{
    public string Type { get; set; }
    [JsonConverter(typeof(CustomIsoDateTimeConverter))]
    public DateTime Timestamp { get; set; }
}

我建议从两个 class 中删除 ToString 覆盖。您可能需要以不同的格式序列化相同的数据，然后您就会遇到麻烦。

var testEvent = new Event() { Type = "Test", Timestamp = new DateTime(2021, 7, 12, 11, 6, 36, 0) };
var testUserEvent = new UserEvent(){UserId = "TestId", Event = testEvent};
var result = JsonConvert.SerializeObject(testUserEvent);

结果

{
   "UserId":"TestId",
   "Event":{
      "Type":"Test",
      "Timestamp":"2021-07-12T11:06:36.0000000Z"
   }
}

成员 class 未按定义的方式序列化

Member class not serializing the defined way

c#

serialization

json.net

jsonconvert