Gestire il polimorfismo nella serializzazione usando un converter con System.Text.Json

di Stefano Mostarda, in .NET,

Negli script #563 e #565 abbiamo visto alcune tecniche per gestire il polimorfismo durante la fase di serializzazione di un oggetto utilizzando la libreria System.Text.Json. Tutti questi approcci prevedevano l'uso delle funzionalità integrate della libreria. In questo script analizziamo invece una funzionalità che ci permette di alterare il modo in cui la libreria serializza un oggetto e quind grazie alla quale possiamo gestire manualmente il processo di serializzazione: i converter.
Per creare un converter dobbiamo creare una classe che eredita da JsonConverter<T> dove T è la classe base della gerarchia per cui creiamo il converter. Una volta creata la classe, dobbiamo eseguire l'override della proprietà CanConvert e dei metodi Read (usato per deserializzare l'oggetto) e Write (usato per serializzare l'oggetto).

public class Vehicle
{
  public string Name { get; set; }
}

public class Car : Vehicle
{
  public int Doors { get; set; }
}

public class Train : Vehicle
{
  public int Coaches { get; set; }
}
    
public class VehicleConverter : JsonConverter<Vehicle>
{
  public override bool CanConvert(Type typeToConvert) =>
    typeof(Vehicle).IsAssignableFrom(typeToConvert);

  public override Vehicle Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
  {
    throw new NotImplementedException();
  }

  public override void Write(Utf8JsonWriter writer, Vehicle vehicle, JsonSerializerOptions options)
  {
    writer.WriteStartObject();

    if (vehicle is Car c)
    {
      writer.WriteNumber(nameof(c.Doors), c.Doors);
    }
    else if (vehicle is Train t)
    {
      writer.WriteNumber(nameof(t.Coaches), t.Coaches);
    }

    writer.WriteString(nameof(vehicle.Name), vehicle.Name);

    writer.WriteEndObject();
  }
}

La proprietà CanConvert torna true se l'oggetto passato in input eredita da Vehicle, mentre il metodo Read è commentato perché ne parleremo in un prossimo script. Il metodo su cui ci concentriamo è Write il quale prende in input l'oggetto Vehicle e il writer in cui scrivere i dati. All'interno del metodo verifichiamo il tipo dell'oggetto in input e scriviamo nel writer le relative proprietà.

Per utilizzare il converter durante la serializzazione, dobbiamo creare un oggetto JsonSerializerOptions, aggiungerci il converter e passare l'oggetto al metodo Serialize.

var c = new Car { Doors = 2, Name = "mycar" };
var serializeOptions = new JsonSerializerOptions();
serializeOptions.Converters.Add(new VehicleConverter());
Console.WriteLine(JsonSerializer.Serialize(c, serializeOptions));

Commenti

Visualizza/aggiungi commenti

| Condividi su: Twitter, Facebook, LinkedIn

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi