Skip to content

Support Nullable Types #3

@stellarpower

Description

@stellarpower

Ths is a nice extension for solving the problem, where missing values are silently ignored by default. However, I have some cases where I know beforehand that a value might be missing from the JSON. I represent these in the class I deserialise to as nullable fields.

When I try to deserialise like this:

public class Weather{
    public string description { get; set; }
    public double windSpeed    { get; set; }
    public int? temperature {get;set;}
}

 var deserializeOptions = new JsonSerializerOptions()
          .SetMissingMemberHandling(DevBetter.JsonExtensions.MissingMemberHandling.Error);
        
Weather? result = System.Text.Json.JsonSerializer.Deserialize<Weather>(text, deserializeOptions);

with this JSON:

{
    "temperature": 32,
    "description": "windy. So very windy",
    "windSpeed": 60.05
}

I get

{System.Text.Json.JsonException: The JSON value could not be converted to System.Nullable`1[System.Int32]. Path: $ | .....
 ---> System.InvalidOperationException: The requested operation requires an element of type 'Object', but the target element has type 'Number'.
   at System.Text.Json.JsonElement.EnumerateObject()
   at DevBetter.JsonExtensions.Converters.MissingMemberErrorConverter.Read(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options)
   at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)
   at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, JsonSerializerOptions options, ReadStack& state)
   --- End of inner exception stack trace ---

Looking at the sources, it seems that you're converting types manually, and that the Nullable generic isn't eexplicitly handled yet, so this would be expected, the exception is because it can't construct a system.Nullable from a numeric value yet.

Suggested implementation:

  • If not added to the general Error handler, add a new handler, that behaves like error, except that values that are explicitly nullable in the class do not cause an exception to be thrown if they are missing from the JSON.
  • Add support for nullable types to all handlers, with a policy on how these should be deserialised for that handler.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions