Praxisleitfaden

JSON-zu-C#-Klassengenerator — Anleitung und technische Grundlagen

Konvertiert JSON-Payloads in stark typisierte C#-Klassen mit JsonPropertyName-Attributen, Nullable-Referenzen und sauber formatiertem Code.

Tool öffnen

Überblick

REST-APIs, Cloud-Événements, Konfigurationsdateien, Telemetrie und Warteschlangen liefern JSON. Stark typisierte C#-Klassen sorgen für Typsicherheit zur Kompilierzeit, bessere IntelliSense-Unterstützung und stabile Refactorings. JsonPropertyName hält die Originalschlüssel intakt und beschleunigt den Austausch von Verträgen zwischen Teams.

Zentrale Konzepte

JSON → C# Typzuordnung

Strings werden zu string oder DateTime, Ganzzahlen zu long, Dezimalwerte zu double, Booleans zu bool, Objekte zu eigenen Klassen und Arrays zu Liste<T>. Sobald null im Beispiel auftaucht, wird die Eigenschaft als nullable markiert und – falls aktiviert – mit ? versehen. Heterogene Arrays werden zu Liste<object>, damit die Struktur vollständig erhalten bleibt.

Generierungspipeline

Der Konverter traversiert das JSON rekursiv, erkennt identische Formen und erstellt wiederverwendbare Klassensignaturen. Eigenschaftsnamen werden in PascalCase normalisiert und reservierte C#-Begriffe vermieden. Arrays nutzen den ermittelten Elementtyp erneut. Nach der Konvertierung werden Anzahl der Klassen, Eigenschaften und Arrays angezeigt, um die Komplexität einzuschätzen.

JsonPropertyName & Serialization

System.Text.Json verwendet JsonPropertyName, daher kann das Tool jedes Feld Optional mit dem ursprünglichen Schlüssel annotieren. Snake_case-Payloads lassen sich so bequem über PascalCase-Eigenschaften konsumieren. Da die Klassen als partial erzeugt werden, können Validierungen oder Converter später in separaten Dateien ergänzt werden.

Strategie für Nullable

Sind Nullable-Referenzen aktiviert, erhalten alle potenziell nullbaren Werte (bool, long, double, string, Liste<T>, verschachtelte Klassen) automatisch ein ?. Dadurch erzwingt der Compiler Null-Prüfungen und NullReferenceExceptions werden reduziert.

Highlights

Stark typisierte Ausgabe

Leitet präzise C#-Typen ab, erstellt verschachtelte Klassen und bewahrt originale JSON-Schlüssel.

JsonPropertyName

Sorgt für perfekte System.Text.Json-Kompatibilität – auch bei snake_case-Schlüsseln.

Nullable-Bewusstsein

Fügt ? automatisch hinzu, wenn Felder in der Probe null sein können.

Statistik

Klassen-, Eigenschafts- und Array-Anzahl werden sofort angezeigt.

Häufige Fragen

Was ist die C#-Klassengenerierung aus JSON und warum ist sie nützlich?

Die C#-Klassengenerierung aus JSON erstellt automatisch stark typisierte C#-Klassen aus JSON-Datenstrukturen. Dies ist unerlässlich bei der Arbeit mit APIs, Konfigurationsdateien oder Datenserialisierung in .NET-Anwendungen. Anstatt Klassen manuell zu schreiben oder dynamische Typen zu verwenden, erstellt der Generator geeignete C#-Klassen mit korrekten Typen, Nullable-Unterstützung und JsonPropertyName-Attributen, wodurch Entwicklungsstunden gespart und Fehler reduziert werden.

Wie behandelt der Generator verschiedene JSON-Datentypen?

Der Generator mappt JSON-Typen auf geeignete C#-Typen: Zeichenketten werden zu string oder DateTime (für ISO-8601-Daten), Ganzzahlen mappen auf long, Gleitkommazahlen auf double, Boolesche Werte auf bool, Objekte werden zu dedizierten Klassen und Arrays werden zu Liste<T>. Null-Werte markieren Eigenschaften als nullable (mit ?-Suffix, wenn nullable Referenzen aktiviert sind). Gemischte Arrays verwenden Liste<object>, um heterogene Daten zu erhalten.

Was sind JsonPropertyName-Attribute und wann sollte ich sie verwenden?

JsonPropertyName-Attribute ermöglichen es C#-Eigenschaften, PascalCase-Namensgebung (C#-Konvention) zu verwenden, während JSON eine andere Namensgebung verwendet (wie snake_case oder camelCase). Das Attribut behält den ursprünglichen JSON-Schlüsselnamen während der Serialisierung/Deserialisierung bei. Aktivieren Sie diese Option, wenn Ihr JSON nicht-PascalCase-Schlüssel verwendet, Sie aber idiomatische C#-Eigenschaftsnamen in Ihrem Code verwenden möchten.

Was ist Nullable-Referenz-Unterstützung und warum sollte ich sie aktivieren?

Nullable-Referenztypen (C# 8.0+) fügen ? zu Referenztypen hinzu, wenn sie null sein können, wodurch Null-Überprüfung zur Compile-Zeit aktiviert wird. Wenn aktiviert, fügt der Generator ? zu Eigenschaften hinzu, wenn die JSON-Probe null-Werte enthält. Dies hilft, NullReferenceException-Fehler zu verhindern, macht optionale Felder explizit und folgt modernen C#-Best Practices für Null-Sicherheit.

Kann ich die generierten Klassen nach der Generierung ändern?

Ja, der Generator erstellt standardmäßig partielle Klassen (oder wenn aktiviert), sodass Sie sie in separaten Dateien erweitern können, ohne den generierten Code zu ändern. Sie können benutzerdefinierte Methoden, Validierungslogik, domänenspezifische Attribute hinzufügen oder Schnittstellen implementieren. Diese Trennung hält den generierten Code sauber und ermöglicht es, Klassen sicher neu zu generieren, wenn sich die JSON-Struktur ändert.

Weiterführende Dokumentation

JSON-zu-C#-Klassengenerator

Öffnen Sie das Tool, um diese Funktionen auszuprobieren.

Tool öffnen