WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

JsonException — Fehler in JSON-Daten

JsonException aus System.Text.Json signalisiert ungültiges JSON, eine überschrittene Verschachtelungsgrenze oder einen Wert, der nicht zum Zieltyp passt. Die Ausnahme stellt außerdem Diagnoseinformationen bereit, mit denen sich das Problem in den Eingabedaten lokalisieren lässt.

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

Syntax

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

JsonException ist eine Ausnahmeklasse im Namespace System.Text.Json, die von Exception abgeleitet ist. Sie ist in .NET 10 verfügbar und keine neue C#-Sprachfunktion. Sie signalisiert ungültige JSON-Syntax, eine überschrittene maximale Tiefe oder Daten, die nicht zum Zieltyp passen. Gültige JSON-Syntax garantiert daher keine erfolgreiche Deserialisierung.

Path gibt die Stelle des Problems in der JSON-Struktur an. LineNumber und BytePositionInLine sind nullbasiert und haben den Typ long?; sie können daher ohne Wert sein. BytePositionInLine zählt UTF-8-Bytes, keine Zeichen. Message beschreibt den Fehler; vergleichen Sie in Tests besser nicht die vollständige, von der Bibliothek erzeugte Meldung.

Verwenden Sie in einem benutzerdefinierten Konverter throw new JsonException("Invalid JSON value.");, um einen nicht akzeptablen Wert zurückzuweisen. Bei der Deserialisierung kann der Serialisierer Path, LineNumber und BytePositionInLine setzen, auch wenn Sie eine eigene Meldung angeben. Löst der Konverter die Ausnahme beim Schreiben von JSON aus, kann der Serialisierer Path setzen, ohne LineNumber und BytePositionInLine zu setzen. Mit dem Konstruktor, der eine Meldung und eine innere Ausnahme akzeptiert, können Sie die zugrunde liegende Ursache erhalten.

Fangen Sie JsonException rund um einen Lesevorgang ab, dessen Fehlschlag Sie behandeln können; verschlucken Sie die Ausnahme nicht stillschweigend. Im Beispiel ist "oops" eine gültige JSON-Zeichenfolge, passt aber nicht zur int-Eigenschaft Age. Das Programm gibt eine feste Meldung und den Pfad $.Age aus, statt eine umgebungsabhängige Fehlerbeschreibung.

Beispiele

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

Ergebnis

Rejected JSON value
Path: $.Age

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen