Maple.Json.ObjectAsPrimitiveConverter 2.1.10

Maple.Json.ObjectAsPrimitiveConverter

Provides the ObjectAsPrimitiveConverter for System.Text.Json that allows to serialize and deserialize objects properties using primitive types.

It is based on the implementation from: https://stackoverflow.com/a/65974452

Give it a star ⭐

Do you like it? Show your support by giving this project a star!

How it works

Consider the following JSON as an example:

{
  "NullProperty": null,
  "StringProperty": "Hello, World!",
  "IntProperty": -234,
  "DecimalProperty": 123.456,
  "ArrayProperty": [1, null, "abc", true]
}

When using System.Text.Json to deserialize this JSON to an object, the result value will look like this:

When using System.Text.Json to deserialize this JSON to an IDictionary<string, object>, the result value will look like this:

When using System.Text.Json to deserialize this JSON to an object with the ObjectAsPrimitiveConverter, the result value will look like this:

Quick Start

Adding the NuGet package

Add the Maple.Json.ObjectAsPrimitiveConverter package to your project using the NuGet Package Manager in your IDE or the dotnet tool in the console:

dotnet add package Maple.Json.ObjectAsPrimitiveConverter

Using the ObjectAsPrimitiveConverter

In a method to deserialize JSON to an object:

var result = JsonSerializer.Deserialize<object>(json, new JsonSerializerOptions
{
    Converters = { new ObjectAsPrimitiveConverter() }
});

Global settings

ASP.NET Core controller-based application

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new ObjectAsPrimitiveConverter());
    });

ASP.NET Core minimal API application

builder.Services.ConfigureHttpJsonOptions(options =>
{
    options.SerializerOptions.Converters.Add(new ObjectAsPrimitiveConverter());
});

Azure Functions (isolated worker model) application

builder.Services.Configure<WorkerOptions>(options =>
{
    options.SerializerOptions.Converters.Add(new ObjectAsPrimitiveConverter());
});

Azure Functions (isolated worker model) application with ASP.NET Core integration

builder.Services.Configure<Microsoft.AspNetCore.Http.Json.JsonOptions>(options =>
{
    options.SerializerOptions.Converters.Add(new ObjectAsPrimitiveConverter());
});

Configuration

new ObjectAsPrimitiveConverter(floatFormat, unknownNumberFormat, detectDateTime, objectFormat);

Detect date-time

Float format

Object format

Unknown number format

Type mapping

When deserializing with the ObjectAsPrimitiveConverter, each JSON value is converted to a CLR type as follows:

Integer numbers are widened only as needed: values that fit in int become int, larger values that fit in long become long, and values beyond long become BigInteger.

A number is treated as floating-point when it contains a decimal point or an exponent, so values written in exponent notation without a decimal point (for example 1e5 or 5e-1) are converted using the Float format.

Comments

The converter honours the ReadCommentHandling setting of the JsonSerializerOptions:

• JsonCommentHandling.Disallow (the default) — a comment causes a JsonException.
• JsonCommentHandling.Skip — comments are ignored, including comments between array elements, between object members, and immediately before a closing ] or }.

Comments never appear in the deserialized result.

var result = JsonSerializer.Deserialize<object>(json, new JsonSerializerOptions
{
    ReadCommentHandling = JsonCommentHandling.Skip,
    Converters = { new ObjectAsPrimitiveConverter() }
});

Learn More

Documentation

• Maple.Json.ObjectAsPrimitiveConverter
• Maple.Json.ObjectAsPrimitiveConverter.Configuration

See also

• JSON serialization and deserialization in .NET - overview
• System.Text.Json
• System.Text.Json NuGet package