JSON反序列化:使用自定义JsonConverter处理缺少的属性

Question

我为正在构建的项目创建了一个JSON Web Token类：

[JsonObject]
public class JwtPayload
{
    [JsonProperty("iss", NullValueHandling = NullValueHandling.Ignore)]
    public string Issuer { get; set; } = "https://mycompany.com/myIdentityServices";
    [JsonProperty("sub", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
    public string Subject { get; set; }
. . .
    [JsonProperty("nbf", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
    [JsonConverter(typeof(JsonUnixTimestampConverter))]
    public DateTime? NotBefore { get; set; } = null;
    [JsonProperty("iat", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
    [JsonConverter(typeof (JsonUnixTimestampConverter))]
    public DateTime? IssuedAt { get; set; }
. . .
}

我有一个用于Unix时间戳转换的JsonConverter，它看起来像这样：

public class JsonUnixTimestampConverter : JsonConverter
{
    public override bool CanRead => true;
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var dt = value as DateTime?;
        if (dt.HasValue)
        {
            writer.WriteRawValue(dt.Value.ToUnixTimestamp().ToString());
        }
        else
        {
            writer.WriteNull();
        }
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue,
        JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return GetDefault(objectType);
        }
        var text = reader.ReadAsString();
        return text.FromUnixTimestamp();
    }
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof (DateTime)  || objectType == typeof(DateTime?);
    }
    private object GetDefault(Type type)
    {
        if (type.IsValueType)
        {
            return Activator.CreateInstance(type);
        }
        return null;
    }
}

序列化令牌运行得很顺利。。。我得到的正是我所期望的JSON。问题是，如果我使用JSON令牌，并尝试在缺少"nbf"值的情况下执行JsonConvert.Deserialize<JwtPayload>("my JSON")，那么当它试图将"iat"解析为Unix时间戳时，我的反序列化就会失败，这不会很好地进行。

很明显，我在JsonConverter类中遇到了一个问题，但我在网上看到的几乎所有例子都谈到了将类转换为字符串，而不是将字符串转换为类，所以很难理解我做错了什么。有人能帮我吗？

我尝试过NullValueHandling和DefaultValueHandling的不同组合，所以我认为问题出在JsonConverter类中，但我可能错了。

Answer 1

问题是JsonReader.ReadAsString()以字符串的形式从流中读取下一个JSON令牌您希望将当前JSON令牌解析为字符串。因此：

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue,
        JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return GetDefault(objectType);
        }
        var text = (string)JToken.Load(reader);
        return text.FromUnixTimestamp();
    }

使用(string)JToken.Load(reader)而不是JsonReader.Value可以确保读取器位于当前值的末尾，以防它是您所期望的更复杂的对象。

顺便说一句，如果手动将UNIX时间戳解析和格式化为字符串，则应确保在不变区域性中而不是在当前区域性中进行解析和格式化。或者最好让Json.NET为您做这件事，将您的时间戳读写为long而不是string:

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var dt = value as DateTime?;
        if (dt.HasValue)
        {
            writer.WriteValue(dt.Value.ToUnixTimestamp());
        }
        else
        {
            writer.WriteNull();
        }
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue,
        JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return GetDefault(objectType);
        }
        var stamp = (long)JToken.Load(reader);
        return stamp.FromUnixTimestamp();
    }

使用

public static class UnixTimeExtensions
{
    const long SecondsToMilliseconds = 1000L;
    const long MillisecondsToTicks = 10000L;
    static readonly DateTime utcEpochStart = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
    public static DateTime FromUnixTimestamp(this long stamp)
    {
        return utcEpochStart.AddSeconds(stamp);
    }
    public static long ToUnixTimestamp(this DateTime dateTime)
    {
        var span = dateTime.ToUniversalTime() - utcEpochStart;
        return span.Ticks / (SecondsToMilliseconds * MillisecondsToTicks);
    }
}