Formater du JSON en C#

Le formatage JSON consiste à analyser un document JSON valide puis à le sérialiser avec des espaces et une indentation plus lisibles. L’analyse permet aussi de détecter une syntaxe invalide.

Démarrage rapide#

L’exemple suivant utilise l’API standard de C# ou une bibliothèque couramment utilisée pour cette tâche.

Exemple#

1using System.Text.Json;23using JsonDocument doc = JsonDocument.Parse(input);4string formatted = JsonSerializer.Serialize(5    doc.RootElement,6    new JsonSerializerOptions { WriteIndented = true }7);8Console.WriteLine(formatted);

Opérations courantes#

Ce second exemple couvre une opération fréquente en production ou une manière plus sûre de traiter des entrées réelles.

Variante courante#

1try2{3    using JsonDocument doc = JsonDocument.Parse(input);4    string pretty = JsonSerializer.Serialize(doc.RootElement, new JsonSerializerOptions5    {6        WriteIndented = true7    });8}9catch (JsonException ex)10{11    Console.WriteLine($"Invalid JSON near line {ex.LineNumber}, byte {ex.BytePositionInLine}");12}

Points importants#

Le formatage doit passer par un parseur JSON. Évitez les transformations par expressions régulières et faites attention aux très grands nombres selon le runtime.

Bonnes pratiques#

1. Considérez toute entrée externe comme non fiable et gérez explicitement les erreurs d’analyse ou de validation.
2. Rendez explicites l’encodage, les unités, les formats et les conventions propres aux bibliothèques aux frontières du système.
3. Ajoutez des tests couvrant l’entrée vide, le texte Unicode, les entrées invalides et des données représentatives de la production.

Références#

• RFC 8259: The JSON Data Interchange Format
• .NET API Browser