How to use class fields with System.Text.Json.JsonSerializer?

Question

I recently upgraded a solution to be all .NET Core 3 and I have a class that requires the class variables to be fields. This is a problem since the new System.Text.Json.JsonSerializer doesn't support serializing nor deserializing fields but only handles properties instead.

Is there any way to ensure that the two final classes in the example below have the same exact values?

using System.Text.Json;

public class Car
{
    public int Year { get; set; } // does serialize correctly
    public string Model; // doesn't serialize correctly
}

static void Problem() {
    Car car = new Car()
    {
        Model = "Fit",
        Year = 2008,
    };
    string json = JsonSerializer.Serialize(car); // {"Year":2008}
    Car carDeserialized = JsonSerializer.Deserialize<Car>(json);

    Console.WriteLine(carDeserialized.Model); // null!
}

dbc · Accepted Answer · 2021-08-03 02:41:53Z

61

In .NET Core 3.x, System.Text.Json does not serialize fields. From the docs:

Fields are not supported in System.Text.Json in .NET Core 3.1. Custom converters can provide this functionality.

In .NET 5 and later, public fields can be serialized by setting JsonSerializerOptions.IncludeFields to true or by marking the field to serialize with [JsonInclude]:

using System.Text.Json;

static void Main()
{
    var car = new Car { Model = "Fit", Year = 2008 };

    // Enable support
    var options = new JsonSerializerOptions { IncludeFields = true };

    // Pass "options"
    var json = JsonSerializer.Serialize(car, options);

    // Pass "options"
    var carDeserialized = JsonSerializer.Deserialize<Car>(json, options);

    Console.WriteLine(carDeserialized.Model); // Writes "Fit"
}

public class Car
{
    public int Year { get; set; }
    public string Model;
}

For details see:

edited Aug 3, 2021 at 2:41

dbc

120k27 gold badges273 silver badges404 bronze badges

answered Sep 27, 2019 at 18:41

pavinan

1,3811 gold badge12 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

dbc Over a year ago

Also documented in How to serialize and deserialize JSON in .NET: Serialization behavior: By default, all public properties are serialized. You can specify properties to exclude... Currently, fields are excluded.

Vimes Over a year ago

I edited the answer now that it's possible (in pre-release version).

tmaj Over a year ago

You can use Sytem.Text.Json >=5.0.2 package in .net core 3.1

NiKiZe · Accepted Answer · 2023-01-24 19:59:59Z

6

If you want this for all MvcControllers in API project you can do similar to this in setup:

builder.Services.AddControllers().AddJsonOptions(options =>
{
    options.JsonSerializerOptions.IncludeFields = true;
});

answered Jan 24, 2023 at 19:59

NiKiZe

1,45316 silver badges28 bronze badges

Comments

Michaël Catanzariti · Accepted Answer · 2019-12-17 21:37:45Z

Please try this library I wrote as an extension to System.Text.Json to offer missing features: https://github.com/dahomey-technologies/Dahomey.Json.

You will find support for fields.

using System.Text.Json;
using Dahomey.Json

public class Car
{
    public int Year { get; set; } // does serialize correctly
    public string Model; // will serialize correctly
}

static void Problem() {
    JsonSerializerOptions options = new JsonSerializerOptions();
    options.SetupExtensions(); // extension method to setup Dahomey.Json extensions

    Car car = new Car()
    {
        Model = "Fit",
        Year = 2008,
    };
    string json = JsonSerializer.Serialize(car, options); // {"Year":2008,"Model":"Fit"}
    Car carDeserialized = JsonSerializer.Deserialize<Car>(json);

    Console.WriteLine(carDeserialized.Model); // Fit
}

Collectives™ on Stack Overflow

How to use class fields with System.Text.Json.JsonSerializer?

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related