Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / C#

JsonException — errori nei dati JSON

JsonException di System.Text.Json segnala JSON non valido, il superamento del limite di annidamento o un valore incompatibile con il tipo di destinazione. Espone inoltre informazioni diagnostiche che aiutano a individuare il problema nei dati in ingresso.

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

Sintassi

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

JsonException è una classe di eccezione dello spazio dei nomi System.Text.Json che eredita da Exception. È disponibile in .NET 10; non è una nuova funzionalità del linguaggio C#. Segnala una sintassi JSON non valida, il superamento della profondità massima o dati incompatibili con il tipo di destinazione. Una sintassi JSON valida, quindi, non garantisce una deserializzazione riuscita.

Path indica la posizione del problema nella struttura JSON. LineNumber e BytePositionInLine sono indicizzati da zero e hanno tipo long?, perciò potrebbero non avere un valore. BytePositionInLine conta i byte UTF-8, non i caratteri. Message descrive l’errore; nei test è meglio evitare di confrontare l’intero messaggio generato dalla libreria.

In un convertitore personalizzato, usare throw new JsonException("Invalid JSON value."); permette di rifiutare un valore non accettabile. Durante la deserializzazione, il serializzatore può valorizzare Path, LineNumber e BytePositionInLine, anche se viene fornito un messaggio personalizzato. Se il convertitore genera l’eccezione durante la scrittura del JSON, il serializzatore può valorizzare Path lasciando LineNumber e BytePositionInLine senza valore. Il costruttore che accetta un messaggio e un’eccezione interna consente di conservare la causa sottostante.

Gestire JsonException attorno a un’operazione di lettura il cui errore si è in grado di gestire; non ignorarla senza intervenire. Nell’esempio, "oops" è una stringa JSON valida, ma è incompatibile con la proprietà Age di tipo int. Il programma stampa un messaggio fisso e il percorso $.Age, invece di una descrizione dell’errore dipendente dall’ambiente.

Esempi

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; }
}

Risultato

Rejected JSON value
Path: $.Age

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti