New in .NET 8.0 (27): Configurable naming conventions in System.Text.Json 8.0

JSON Serializer System.Text.Json ,NuGet Packages) received some enhancements in version 8.0.

Advertisement

Unlike other parts of .NET 8.0 such as Entity Framework Core 8.0 System.Text.Json Not only on .NET 8.0, but on older .NET versions as well. System.Text.Json Works with classic .NET Framework from version 4.6.2 and modern .NET from version 2.0.

Oppo’s new Reno12 series popularizes generative AI

Version 8.0 uses naming conventions to serialize object properties to JSON and to deserialize from JSON KebabCaseLower, KebabCaseUpper, SnakeCaseLower And SnakeCaseUpper In the calculation JsonNamingPolicy as an alternative to what was previously prescribed CamelCasing,

Examples of these naming conventions include:

• PascalCase: Full Name
• CamelCase: Full Name
• KebabCaseLower: Full Name
• KebabCaseUpper: Full Name
• SnakeCaseLower: Full Name
• SnakeCaseUpper: Full Name

comes in the following list KebabCaseUpper When serializing and deserializing an instance of a class Consultant for use:

var options = new JsonSerializerOptions
{
 // NEU: Enumeration JsonNamingPolicy mit Namenskonventionen KebabCaseLower, KebabCaseUpper, SnakeCaseLower und SnakeCaseUppter als Alternative zum bisher fest gesetzten CamelCase
 PropertyNamingPolicy = JsonNamingPolicy.KebabCaseUpper, // Standard ist CamelCase
};
…
var consultant = new Consultant() { ID = 42, FullName = "Holger Schwichtenberg", Salutation = "Dr.", PersonalWebsite = "www.dotnet-doktor.de" };
consultant.Languages.AddRange(("C#", "JavaScript", "TypeScript"));
consultant.Address = new Address() { City = "Essen", Country = "Germany" };
Console.WriteLine("Objekt im RAM:");
Console.WriteLine(consultant);
Console.WriteLine();
 
CUI.H3("Serialisierung (KebabCaseUpper):");
string json1 = JsonSerializer.Serialize(consultant, options);
Console.WriteLine(json1); // {"ID":42,"FULL-NAME":"Holger Schwichtenberg","SALUTATION":"Dr.","PERSONAL-WEBSITE":"www.dotnet-doktor.de"}
…
CUI.H3("\nDeserialisierung: (vollständig)");
try
 {
  var jsonString = """
  {"ID":42,"FULL-NAME":"Holger Schwichtenberg","SALUTATION":"Dr.",
   "PERSONAL-WEBSITE":"www.dotnet-doktor.de",
   "ADDRESS":{"COUNTRY":"Germany","CITY":"Essen"}}
  """;
  Console.WriteLine(jsonString);
  var obj = JsonSerializer.Deserialize(jsonString, options);
  if (obj != null) CUI.Success(obj.ToString());
 }
catch (Exception ex)
 {
  CUI.PrintError(ex.Message); 
 }

Listing 2 below shows data objects Person And Consultant And their interface:

using System.Text.Json.Serialization;
 
namespace FCL_JSON;
 
public interface IBusinessObject
{
 UInt128 ID { get; init; } 
}
 
public interface IPerson : IBusinessObject
{
 string? Salutation { get; set; }
 string? FullName { get; set; }
 public Address Address { get; set; }
}
 
public interface IConsultant : IPerson
{
 string? PersonalWebsite { get; set; }
 public List Languages { get; }
}
 
public class Address
{
 public string Country { get; set; }
 public string City { get; set; }
}
 
public class Person : IPerson
{
 public Person() { }
 public required UInt128 ID { get; init; }
 public required string FullName { get; set; }
 public string? Salutation { get; set; }
 public Address Address { get; set; }
 
 public override string ToString()
 {
  return $"Person {ID}: {(!String.IsNullOrEmpty(Salutation) ? Salutation + " " : "")}{FullName} wohnt in {Address?.City ?? "UNBEKANNT"} ";
 }
}
 
public class Consultant : Person, IConsultant
{
 public Consultant() { }
 
 public List Languages { get; } = new();
 
 public string? PersonalWebsite { get; set; }
 
 public override string ToString()
 {
  return $"Consultant {ID}: {(!String.IsNullOrEmpty(Salutation) ? Salutation + " " : "")}{FullName} wohnt in {Address.City} -> {PersonalWebsite} Sprachen: {String.Join('+', Languages)}";
 }
}

(RME)