System.Text.JSON - ASPNET Core 3.1

11 minuto(s) de leitura - December 03, 2019

01

Fala pessoal, tudo bem?! ūüíö

Porque estamos aqui?

Eu acredito que você já sabe, e se não sabe, ficará agora, que a Microsoft escreveu seu proprio Serializador JSON que está no namespace System.Text.Json .

Como sempre a Microsoft vem trabalhando duro para entregar features sempre focadas em performance, sendo assim System.Text.Json foi escrito exatamente com esse objetivo, alocar menos memória e ser mais rápido, podendo ter um ganho de desempenho de 1.3x até 5x sobre o JSON.NET(Newtonsoft).

FYI: Se seu projeto é em .NET Core, você já vai ter acesso ao namespace/pacote que informei acima, caso você esteja usando .NETStandard ou .NET Framework, você irá precisar instalar o pacote System.Text.Json.

E a d√ļvida?

Sei que assim como eu, muitos de voc√™s ficaram se perguntando sobre usar ou n√£o usar o System.Text.Json no lugar do Newtonsoft, pois bem, tivemos algumas limita√ß√Ķes, e quero tratar nesse artigo sobre uma delas especialmente que √© sobre a serializa√ß√£o dos objetos aplicando a nomenclatura snake-case, isso era simplesmente f√°cil usando o Newtonsoft, pois ele fornecia uma implementa√ß√£o para usarmos essa estrat√©gia.

public IServiceProvider ConfigureServices(IServiceCollection services)
{
  services
    .AddJsonOptions(options => options
      .SerializerSettings.ContractResolver = new DefaultContractResolver
    {
      NamingStrategy = new SnakeCaseNamingStrategy()
    })
}


A Microsoft lan√ßou hoje(03/12/2019) a vers√£o do ASPNET Core 3.1 ent√£o resolvi unir o √ļtil ao agradavel, escrevendo este artigo e testando j√° a nova vers√£o, olha que legal, isso pra mim ser√° uma divers√£o!

Alterando o comportamento da serialização

Então dado um cenário onde a empresa ou você, deseja padronizar a entrega de seus dados usando a nomenclatura snake-case ou qualquer outro padrão, como podemos alterar esse comportamento já que só existe a implementação para CamelCase.

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers().AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
        options.JsonSerializerOptions.IgnoreNullValues = true;
        options.JsonSerializerOptions.WriteIndented = false;
        options.JsonSerializerOptions.AllowTrailingCommas = false;
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
    });
}
Observe que agora temos uma propriedade PropertyNamingPolicy que substitui o antigo NamingStrategy do Newtonsoft, aqui é onde iremos começar a brincadeira, lembrando que esse assunto pode ir muito mais além, porém o foco é como resolver o cénario onde quero entregar os dados aplicando a nomenclatura SnakeCase.
JsonNamingPolicy é uma classe abstrata onde podemos sobreescrever o comportamente do método responsável por devolver os nomes das propriedades do objeto, então, irei criar uma classe onde iremos sobrescrever 1(um) método da classe JsonNamingPolicy o ConvertName.
public class CustomPropertyNamingPolicy : JsonNamingPolicy
{
    public override string ConvertName(string name) => ToSnakeCase(name);

    private static string ToSnakeCase(string name)
    {
        return string.IsNullOrWhiteSpace(name)
            ? name
            : Regex.Replace(
                name,
                @"([a-z0-9])([A-Z])",
                "$1_$2",
                RegexOptions.Compiled,
                TimeSpan.FromSeconds(0.2)).ToLower();
    }
}

Configure Services

Agora é só informar qual politca de serialização será usada, neste caso o CustomPropertyNamingPolicy, veja como ficou nossa configuração agora.

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers().AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.PropertyNamingPolicy = new CustomPropertyNamingPolicy();
        options.JsonSerializerOptions.IgnoreNullValues = true;
        options.JsonSerializerOptions.WriteIndented = false;
        options.JsonSerializerOptions.AllowTrailingCommas = false;
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
    });
}

Exemplo

Para o exemplo deste artigo, utilizamos a seguinte classe:

public class Person
{
    public DateTime BirtdayDate { get; set; }
    public string FullName { get; set; }
    public string Email { get; set; }
}

Output

[
  {
    "birtday_date": "2019-12-05T00:21:37.7799448-03:00",
    "full_name": "Heloysa",
    "email": "ralms@ralms.net"
  },
  {
    "birtday_date": "2019-12-06T00:21:37.7817476-03:00",
    "full_name": "Thysbe",
    "email": "ralms@ralms.net"
  },
  {
    "birtday_date": "2019-12-07T00:21:37.781753-03:00",
    "full_name": "Rafael",
    "email": "ralms@ralms.net"
  },
  {
    "birtday_date": "2019-12-08T00:21:37.7817534-03:00",
    "full_name": "Eduarda",
    "email": "ralms@ralms.net"
  },
  {
    "birtday_date": "2019-12-09T00:21:37.7817536-03:00",
    "full_name": "Heloysa",
    "email": "ralms@ralms.net"
  }
]


Os fontes do exemplo usado est√° aqui:
https://github.com/ralmsdeveloper/AspNet31JsonNamePolicy

Pessoal fico por aqui e um forte abra√ßo! ūüėĄ

#mvpbuzz #mvpbr #mvp #developerssergipe #share #vscode #postgresql #efcore31 #netcore31 #aspnetcore

Categorias:

Atualizado em:

Deixe um coment√°rio