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

时间:2016-03-31 15:01:29

标签: c# json.net json-deserialization

我为一个项目构建了一个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令牌并尝试执行JsonConvert.Deserialize<JwtPayload>("my JSON"),其中&#34; nbf&#34;价值缺失,我的反序列化在试图解析&#34; iat&#34;作为一个Unix时间戳,它不会过得那么好。

显然我的JsonConverter课程有问题,但我在网上看到的几乎所有例子都谈到将类转换为字符串,而不是字符串转换为类,所以很难理解我做错了什么。有人能帮助我吗?

我尝试了NullValueHandlingDefaultValueHandling的不同组合,因此我认为问题出在JsonConverter课程中,但我可能错了。

1 个答案:

答案 0 :(得分: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);
    }
}