News

JSON-Syntax optimieren: Erfassung und Lesbarkeit mit Kommentaren vereinfachen

JSON noch einfacher mit Hjson erstellen (Grafik: Shutterstock)

JSON ist überall – egal ob wir mit PHP, JavaScript oder einer anderen Programmiersprache arbeiten. Was früher einmal XML war, wurde jetzt fast vollständig durch JSON ersetzt. Wie wir die JSON-Syntax noch optimieren können und die Leserlichkeit steigern, zeigen wir im Artikel.

JSON ist nicht ohne Grund so erfolgreich. Es dient in vielen Fällen als Austauschformat und wird fast von jeder API ausgeliefert. Auch Daten in einem Cookie mit JSON speichern funktioniert einwandfrei. Es ist nicht nur leicht und verständlich, sondern kann einfache und komplexe Strukturen gut abbilden. Es ist schnell in der Interpretation und wird vor allem von vielen Programmiersprachen unterstützt. Trotzdem kann man JSON in einigen Punkten noch optimieren und für den Nutzer noch einfacher gestalten – zum Beispiel mit Kommentaren oder weniger Syntax-Fehlern.

JSON-Syntax mit Hjson verbessern

Das Human-JSON. So einfach war die Bearbeitung noch nie! (GIF: Hjson)

Das Human-JSON. So einfach war die Bearbeitung noch nie! (GIF: Hjson)

Obwohl JSON schon ein super Format ist, ist es sehr anfällig für Syntax-Fehler. Schon ein vergessenes Komma führt zu einer Fehlermeldung. Da Fehler aber menschlich sind und es sehr nervig sein kann, ein vergessenes Komma zu suchen, gibt es eine neue Adaption namens Hjson. Das „H“ steht für Human und soll die Erstellung und Lesbarkeit nochmals verbessern. Dateien in diesem Format können als .hjson erstellt werden und mit verschiedenen Compilern wieder in die spezifizierte JSON-Syntax exportiert werden.

Hjson liefert aber nicht nur eine tolerantere Kommasetzung, sondern noch weitere Funktionen. Beispielsweise können Strings auch ohne Anführungszeichen erstellt werden.


{
text: look ma, no quotes!
}

Die interessanteste Funktion von Hjson ist aber sicherlich die Möglichkeit, auch Kommentare direkt hinterlegen zu können. Ein Beispiel für die Kommentare können wir uns hier ansehen:


{
# specify rate in requests/second
// prefer c-style comments?
/* feeling old fashioned? */
}

Somit sind nicht nur Kommentare erlaubt, sondern wir können auch unsere bevorzugte Syntax für Kommentare auswählen. Super praktisch für eine Config-Datei oder Ressourcen, die wir direkt im Code dokumentieren möchten. Hjson ist ausschließlich für die Bearbeitung von Menschen gedacht. Natürlich könnte auch eine API direkt HJson ausliefern, dies würde aber eher den Response verlangsamen und die übertragende Datenmenge erhöhen. Die weniger strikte Syntax hilft uns, schnell eine JSON-Datei aufzusetzen und das ganze ohne Frust.

Wenn ihr Hjson einmal ausprobieren möchtet, könnt ihr das direkt in der Sandbox tun. Auch die vollständige Syntax findet ihr auf der offiziellen Webseite. Aktuell gibt es einen JavaScript-, Java-, Python-, C#- oder PHP-Compiler, um aus eine Hjson wieder eine echte JSON zu generieren.

Arbeitet ihr auch regelmäßig mit dem JSON-Format oder ist XML weiterhin für euch die bessere Option?

Zur Startseite
Bitte beachte unsere Community-Richtlinien

Wir freuen uns über kontroverse Diskussionen, die gerne auch mal hitzig geführt werden dürfen. Beleidigende, grob anstößige, rassistische und strafrechtlich relevante Äußerungen und Beiträge tolerieren wir nicht. Bitte achte darauf, dass du keine Texte veröffentlichst, für die du keine ausdrückliche Erlaubnis des Urhebers hast. Ebenfalls nicht erlaubt ist der Missbrauch der Webangebote unter t3n.de als Werbeplattform. Die Nennung von Produktnamen, Herstellern, Dienstleistern und Websites ist nur dann zulässig, wenn damit nicht vorrangig der Zweck der Werbung verfolgt wird. Wir behalten uns vor, Beiträge, die diese Regeln verletzen, zu löschen und Accounts zeitweilig oder auf Dauer zu sperren.

Trotz all dieser notwendigen Regeln: Diskutiere kontrovers, sage anderen deine Meinung, trage mit weiterführenden Informationen zum Wissensaustausch bei, aber bleibe dabei fair und respektiere die Meinung anderer. Wir wünschen Dir viel Spaß mit den Webangeboten von t3n und freuen uns auf spannende Beiträge.

Dein t3n-Team

Ein Kommentar
Tim
Tim

andere alternative: JSON5 — ebenfalls mit kommentaren und syntax-erleichterungen, aber im gegensatz zu HJSON weiterhin ein striktes subset von javascript.

http://json5.org

Antworten

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.

Bitte schalte deinen Adblocker für t3n.de aus!

Hey du! Schön, dass du hier bist. 😊

Bitte schalte deinen Adblocker für t3n.de aus, um diesen Artikel zu lesen.

Wir sind ein unabhängiger Publisher mit einem Team bestehend aus 65 fantastischen Menschen, aber ohne riesigen Konzern im Rücken. Banner und ähnliche Werbemittel sind für unsere Finanzierung sehr wichtig.

Danke für deine Unterstützung.

Digitales High Five,
Stephan Dörner (Chefredakteur t3n.de) & das gesamte t3n-Team

Anleitung zur Deaktivierung