Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C#

JsonException — erreurs de données JSON

JsonException de System.Text.Json signale un JSON invalide, une limite d’imbrication dépassée ou une valeur incompatible avec le type cible. Elle expose aussi des informations de diagnostic qui aident à localiser le problème dans les données d’entrée.

Version : .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Syntaxe

catch (JsonException ex) { /* handle invalid JSON data */ }
throw new JsonException("Invalid JSON value.");

JsonException est une classe d’exception de l’espace de noms System.Text.Json, qui hérite de Exception. Elle est disponible dans .NET 10 ; ce n’est pas une nouvelle fonctionnalité du langage C#. Elle signale une syntaxe JSON invalide, une profondeur maximale dépassée ou des données incompatibles avec le type cible. Une syntaxe JSON valide ne garantit donc pas une désérialisation réussie.

Path indique l’emplacement du problème dans la structure JSON. LineNumber et BytePositionInLine sont indexés à partir de zéro et sont de type long? ; ils peuvent donc ne contenir aucune valeur. BytePositionInLine compte les octets UTF-8, et non les caractères. Message décrit l’erreur ; évitez de comparer dans les tests le message complet généré par la bibliothèque.

Dans un convertisseur personnalisé, utilisez throw new JsonException("Invalid JSON value."); pour rejeter une valeur inacceptable. Lors de la désérialisation, le sérialiseur peut renseigner Path, LineNumber et BytePositionInLine, même si vous fournissez votre propre message. Si le convertisseur lève l’exception pendant l’écriture du JSON, le sérialiseur peut renseigner Path sans renseigner LineNumber ni BytePositionInLine. Le constructeur qui accepte un message et une exception interne permet de préserver la cause sous-jacente.

Interceptez JsonException autour d’une opération de lecture dont vous pouvez gérer l’échec ; ne l’ignorez pas silencieusement. Dans l’exemple, "oops" est une chaîne JSON valide, mais elle est incompatible avec la propriété Age de type int. Le programme affiche un message fixe et le chemin $.Age, plutôt qu’une description d’erreur dépendante de l’environnement.

Exemples

using System;
using System.Text.Json;

internal static class Program
{
    private static void Main()
    {
        const string json = "{\"Age\":\"oops\"}";

        try
        {
            JsonSerializer.Deserialize<Person>(json);
            Console.WriteLine("Accepted");
        }
        catch (JsonException ex)
        {
            Console.WriteLine("Rejected JSON value");
            Console.WriteLine($"Path: {ex.Path}");
        }
    }
}

public sealed class Person
{
    public int Age { get; set; }
}

Résultat

Rejected JSON value
Path: $.Age

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources