如何从 JsonConvert.DeserializeObject 返回 NULL答案

【问题标题】：How to return NULL from JsonConvert.DeserializeObject如何从 JsonConvert.DeserializeObject 返回 NULL
【发布时间】：2017-07-05 14:48:48
【问题描述】：

我有一堂课：

public class CustomResponse
{
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public string Message {get; set; }
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public string Details {get; set; }
}

然后我尝试将 JSON 字符串反序列化为此类：

var settings = new JsonSerializerSettings
    {
        NullValueHandling.Ignore,
        MissingMemberHandling.Ignore,
    };
var customResponse = JsonConvert.Deserialize<CustomResponse>(jsonString, settings);

例如我的 JSON 字符串：

{"DocumentId":"123321", "DocumentNumber":"ABC123"}

结果我有一个对象，它的所有属性都是 NULL，但customResponse 不是 NULL。如何在结果中得到 NULL？

【问题讨论】：

你需要一个custom JsonConverter。
可以添加你使用的json字符串吗？
为什么你认为customResponse 是null？
也许CustomResponse 可能有一个计算/只读属性，如IsEmpty 或IsValid，用于检测其是否有效。
@DanielA.White 如果 CustomResponse 为 NULL，则服务返回正确的响应，我尝试反序列化到 OtherCustomResponse

标签： c# json json.net

【解决方案1】：

如果您想避免创建自定义JsonConverter，可以使用以下扩展方法：

public static class Exts
{
    public static T OrDefaultWhen<T>(this T obj, Func<T, bool> predicate)
    {
        return predicate(obj) ? default(T) : obj;
    }
}

用法：

var jsonString = @"{
    Message: null,
    Details: null
}";

var res = JsonConvert.DeserializeObject<CustomResponse>(jsonString)
                     .OrDefaultWhen(x => x.Details == null && x.Message == null);

【讨论】：

谢谢它也有效，但我更喜欢另一个选择

【解决方案2】：

您可以创建一个custom JsonConverter 来分配和填充您的对象，然后使用JsonProperty.ValueProvider 返回的值检查所有属性是否为空：

public class ReturnNullConverter<T> : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return typeof(T).IsAssignableFrom(objectType);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
            return null;

        // Get the contract.
        var contract = (JsonObjectContract)serializer.ContractResolver.ResolveContract(objectType);

        // Allocate the object (it must have a parameterless constructor)
        existingValue = existingValue ?? contract.DefaultCreator();

        // Populate the values.
        serializer.Populate(reader, existingValue);

        // This checks for all properties being null.  Value types are never null, however the question
        // doesn't specify a requirement in such a case.  An alternative would be to check equality
        // with p.DefaultValue
        // http://www.newtonsoft.com/json/help/html/P_Newtonsoft_Json_Serialization_JsonProperty_DefaultValue.htm
        if (contract.Properties
            .Where(p => p.Readable)
            .All(p => object.ReferenceEquals(p.ValueProvider.GetValue(existingValue), null)))
            return null;

        return existingValue;
    }

    public override bool CanWrite { get { return false; } }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

然后像这样使用它：

var settings = new JsonSerializerSettings
{
    NullValueHandling = NullValueHandling.Ignore,
    MissingMemberHandling = MissingMemberHandling.Ignore,
    Converters = { new ReturnNullConverter<CustomResponse>() },
};
var customResponse = JsonConvert.DeserializeObject<CustomResponse>(jsonString, settings);

示例fiddle。

但是，在您编写的 cmets 中，如果 CustomResponse 为 NULL，则服务返回正确的响应，我尝试反序列化为 OtherCustomResponse。在这种情况下，请考虑使用多态转换器，例如来自 How to implement custom JsonConverter in JSON.NET to deserialize a List of base class objects? 或 Deserializing polymorphic json classes without type information using json.net 的转换器

【讨论】：