Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

JsonException — błędy danych JSON

JsonException z System.Text.Json sygnalizuje nieprawidłowy JSON, przekroczenie limitu zagnieżdżenia lub niezgodność wartości z typem docelowym. Udostępnia także informacje pomagające znaleźć problem w danych.

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

Składnia

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

JsonException to klasa wyjątku z przestrzeni nazw System.Text.Json, dziedzicząca po Exception. Jest dostępna w .NET 10; nie jest nową funkcją języka C#. Sygnalizuje nieprawidłową składnię JSON, przekroczenie maksymalnej głębokości lub niezgodność danych z typem docelowym. Poprawna składnia JSON nie gwarantuje więc udanej deserializacji.

Path wskazuje miejsce problemu w strukturze JSON. LineNumber i BytePositionInLine są indeksowane od zera i mają typ long?, więc mogą nie zawierać wartości. BytePositionInLine liczy bajty UTF-8, nie znaki. Message opisuje błąd; w testach lepiej nie porównywać całego komunikatu generowanego przez bibliotekę.

We własnym konwerterze można użyć throw new JsonException("Invalid JSON value.");, aby odrzucić nieakceptowaną wartość. Podczas deserializacji serializator może uzupełnić Path, LineNumber i BytePositionInLine, także gdy podano własny komunikat. Jeśli konwerter zgłosi wyjątek podczas zapisu JSON, serializator może uzupełnić Path, pozostawiając LineNumber i BytePositionInLine bez wartości. Konstruktor przyjmujący komunikat i wyjątek wewnętrzny pozwala zachować przyczynę błędu.

Przechwytuj JsonException wokół operacji odczytu, której niepowodzenie potrafisz obsłużyć; nie ukrywaj błędu bez reakcji. W przykładzie "oops" jest poprawnym łańcuchem JSON, ale nie pasuje do właściwości Age typu int. Program wypisuje stały komunikat i ścieżkę $.Age, zamiast zależnego od środowiska opisu błędu.

Przykłady

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

Wynik

Rejected JSON value
Path: $.Age

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła