Jorge Serrano
  • Home

Creando una JsonNamingPolicy para hacer compatible System.Text.Json con SnakeCase y KebabCase

  • By jorge
  • Ene-4-2020
  • .NET Core 3.0, .NET Core 3.1, C#
  • 0 Comments.

Nota: El código fuente de las políticas que en esta entrada se describen, han sido actualizadas después de publicar la entrada y el mismo día de la publicación para mejorar su rendimiento. La mejora ha sido considerable. Encontrarás el código actualizado en este artículo y en GitHub (enlace al repositorio de código al final de la entrada).

Introducción

Dentro del ecosistema de los diferentes lenguajes de programación, tenemos la posibilidad de encontrar diferentes convenciones de codificación.
Sobre ello escribí una entrada el año pasado por si quieres leer algo al respecto (La importancia de las convenciones de codificación: PascalCase, camelCase, snake_case y kebab-case).

SnakeCase por ejemplo es utilizado por las APIs de Facebook y Twitter, o en AWS.
En lenguajes de programación como Ruby, se utiliza snake_case, motivo por el cual Twitter lo tiene así implementado en su API.
En el caso de PHP, se utiliza igualmente snake_case.

Google y Microsoft por su parte suelen utilizar camelCase usado así en Java y .NET.
Igualmente pasa con Pascal en el uso de camelCase.

Es decir, no existe ninguna estandarización clara respecto a este uso, por lo que si no se cubre en la librería que utilizamos (por ejemplo en System.Text.Json en el caso de .NET Core 3.x), somos nosotros los programadores los que debemos cubrir esta necesidad.

Lo mismo sucede para KebabCase.

El siguiente código es para SnakeCase, pero es idéntico a KebabCase, con la salvedad de que en luar del carácter _ tenemos el carácter -.

No obstante, el código de ambas políticas las encontrarás en mi repositorio de código en GitHub que indico al final del artículo.

System.Text.Json y .NET Core 3.x

Cuando trabajamos con System.Text.Json, tenemos que tener en consideración que en un principio sólo hay soporte para camelCase y PascalCase, si bien se está haciendo esfuerzos por agregar soporte para SnakeCase (actualmente en fase de desarrollo y resolución).

Hasta que llegue ese soporte y de momento, podemos crear nuestra propia JsonNamingPolicy.

Eso es justamente lo que voy a hacer.

Creando la JsonNamingPolicy

Lo primero que debemos hacer es crear una JsonNamingPolicy, por lo que tendremos que crear una clase que la implemente.

Después sobreescribiremos el método ConvertName dentro del cual llevaremos a cabo la conversión del nombre de una propiedad a su correspondiente nombre en SnakeCase.

El código de nuestra clase quedará de la siguiente forma:

public class JsonSnakeCaseNamingPolicy : JsonNamingPolicy
{
  private readonly string _separator = "_";
    
  public override string ConvertName(string name)
  {
    if (String.IsNullOrEmpty(name) || String.IsNullOrWhiteSpace(name)) 
      return String.Empty;

    ReadOnlySpan spanName = name.Trim();

    var stringBuilder = new StringBuilder();
    var addCharacter = true;

    var isPreviousSpace = false;
    var isPreviousSeparator = false;
    var isCurrentSpace = false;
    var isNextLower = false;
    var isNextUpper = false;
    var isNextSpace = false;

    for (int position = 0; position < spanName.Length; position++) 
    { 
      if (position != 0) 
      { 
        isCurrentSpace = spanName[position] == 32; 
        isPreviousSpace = spanName[position - 1] == 32; 
        isPreviousSeparator = spanName[position - 1] == 95; 

        if (position + 1 != spanName.Length) 
        { 
          isNextLower = spanName[position + 1] > 96 && spanName[position + 1] < 123; 
          isNextUpper = spanName[position + 1] > 64 && spanName[position + 1] < 91; 
          isNextSpace = spanName[position + 1] == 32; 
        } 

        if ((isCurrentSpace) && 
           ((isPreviousSpace) || 
           (isPreviousSeparator) || 
           (isNextUpper) || 
           (isNextSpace)))
           addCharacter = false; 
        else 
        { 
          var isCurrentUpper = spanName[position] > 64 && spanName[position] < 91; 
          var isPreviousLower = spanName[position - 1] > 96 && spanName[position - 1] < 123; 
          var isPreviousNumber = spanName[position - 1] > 47 && spanName[position - 1] < 58;

          if ((isCurrentUpper) &&
             ((isPreviousLower) || 
             (isPreviousNumber) || 
             (isNextLower) || 
             (isNextSpace) || 
             (isNextLower && !isPreviousSpace)))
             stringBuilder.Append(_separator);
          else
          {
            if ((isCurrentSpace && 
               !isPreviousSpace && 
               !isNextSpace))
            {
              stringBuilder.Append(_separator);
              addCharacter = false;
            }
          }
        }
      }

      if (addCharacter)
        stringBuilder.Append(spanName[position]);
      else
        addCharacter = true;
    }

    return stringBuilder.ToString().ToLower();
  }
}

Utilizando nuestra clase

Para utilizar nuestra clase, bastará con utilizarla a la hora de serializar nuestro objeto en JSON por ejemplo.

Ejemplo de uso:

var options = new JsonSerializerOptions() { PropertyNamingPolicy = new JsonSnakeCaseNamingPolicy() };
var person = new Person() { FirstName = "Jorge", Birthday = DateTime.UtcNow, MyJobCity = "Madrid" };
var json = JsonSerializer.Serialize(person, options);

Si ejecutamos nuestro ejemplo, deberíamos obtener un resultado similar al siguiente:

{"first_name":"Jorge","birthday":"2020-01-03T20:00:59.6991482Z","my_job_city":"Madrid"}

Espero que este ejemplo facilite tareas de migración y uso de System.Text.Json hasta que esté lista nativamente la conversión que se supone agregarán en la librería en breve.

Podrás acceder al código de JsonSnakeCaseNamingPolicy y JsonKebabCaseNamingPolicy en mi repositorio de GitHub aquí.

Happy Coding!

Comments

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.