JSON-UDF

**AspirinJunkie** · 21. August 2017

Aufgrund einer Shoutbox-Diskussion und meiner Unzufriedenheit mit bisherigen JSON-UDFs habe ich mich mal rangesetzt und meine Vorstellungen wie eine solche auszusehen hat umgesetzt.
Die bisherigen UDFs sind meiner Meinung nach entweder unnötig umständlich, haben externe Abhängigkeiten oder kommen nicht mit Dictionaries klar.
Daher folgt die UDF folgenden Prämissen:

Ein JSON-String wird mit einer einzigen Funktion komplett in eine native (+ Scripting.Dictionary) AutoIt-Datenstruktur zur Weiterverarbeitung konvertiert. (Funktion _JSON_Parse)
Andersherum kann aus beliebigen AutoIt-Datenstrukturen ein JSON-String erzeugt werden. (Funktion _JSON_Generate)
Abfragen können entweder direkt in den AutoIt-Variablen stattfinden oder etwas sicherer in einer sehr simplen Abfragesprache (Funktion _JSON_Get)

Wer also ähnlich tickt wie ich findet eventuell hiermit eher seine Vorstellungen umgesetzt.

Wie verwendet man es nun? - na dann siehe hier:

AutoIt

#include <JSON.au3>
Global $s_String = '[{"id":"4434156","url":"https://legacy.sky.com/v2/schedules/4434156","title":"468_CORE_1_R.4 Schedule","time_zone":"London","start_at":"2017/08/10 19:00:00 +0100","end_at":null,"notify_user":false,"delete_at_end":false,"executions":[],"recurring_days":[],"actions":[{"type":"run","offset":0}],"next_action_name":"run","next_action_time":"2017/08/10 14:00:00 -0400","user":{"id":"9604","url":"https://legacy.sky.com/v2/users/9604","login_name":"robin@ltree.com","first_name":"Robin","last_name":"John","email":"robin@ltree.com","role":"admin","deleted":false},"region":"EMEA","can_edit":true,"vm_ids":null,"configuration_id":"19019196","configuration_url":"https://legacy.sky.com/v2/configurations/19019196","configuration_name":"468_CORE_1_R.4"},{"id":"4444568","url":"https://legacy.sky.com/v2/schedules/4444568","title":"468_CORE_1_R.4 Schedule","time_zone":"London","start_at":"2017/08/11 12:00:00 +0100","end_at":null,"notify_user":false,"delete_at_end":false,"executions":[],"recurring_days":[],"actions":[{"type":"suspend","offset":0}],"next_action_name":"suspend","next_action_time":"2017/08/11 07:00:00 -0400","user":{"id":"9604","url":"https://legacy.sky.com/v2/users/9604","login_name":"robin@ltree.com","first_name":"Robin","last_name":"John","email":"robin@ltree.com","role":"admin","deleted":false},"region":"EMEA","can_edit":true,"vm_ids":null,"configuration_id":"19019196","configuration_url":"https://legacy.sky.com/v2/configurations/19019196","configuration_name":"468_CORE_1_R.4"}]'
; ================= JSON-String in AutoIt-Datenstrukturen parsen ==============
$o_Object = _JSON_Parse($s_String)
; ================= Abfragen direkt per AutoIt ================================
$s_Type = $o_Object[1].Item("actions")[0].Item("type")
ConsoleWrite("type: " & $s_Type & @CRLF)
; ================= Abfragen per JSON_Get (sicherer) ================================
$s_Type = _JSON_Get($o_Object, "[1].actions[0].type")
ConsoleWrite("type: " & $s_Type & @CRLF)
; ================= AutoIt-Datenstrukturen in JSON-String konvertieren ==============
ConsoleWrite(_JSON_Generate($o_Object) & @CRLF & @CRLF)
; kompaktes JSON:
ConsoleWrite(_JSON_Generate($o_Object, "", "", "", "", "", "") & @CRLF & @CRLF)

Alles anzeigen

Meine Versuche waren alle zufriedenstellend.
Bugs sind aber logischerweise nicht auszuschließen und können gerne hier gemeldet werden.

Changelog:

2017/08/21	_JSON_Generate: Bug bei 2D-Arrays behoben
2017/08/22	Ausgabe von _JSON_Generate individualisierbar
2017/08/27	stabilere Stringdefinition _JSON_Generate: Static string wird aufgeräumt offizielle Whitespace-Definition statt \s
2017/09/04	_JSON_Generate: Zahlenausgabe nun so kompakt wie möglich
2017/10/10	Große Arrays werden nun schneller geparst (selbes Prinzip wie in der DynArray-UDF verwendet)
2017/10/11	Bug in _JSON_Generate behoben (Escapen von Backslashes fügte ein " hinzu) deutlich stabilerer Umgang mit Escape-Zeichen in Strings Performance-Verbesserungen (ohne Umweg über Hilfsfunktion direkter Zugriff per StringRegExp)
2017/10/16	_JSON_Generate: Rundungsfehler bei großen Zahlen behoben
2017/10/31	_JSON_Parse: Unicode-Escapes werden nun konvertiert.
2018/01/11	_JSON_Parse: Performanceverbesserung durch optimierte RegEx-Pattern. _JSON_ParseString: bessere Performance
2019/03/03	_JSON_Get: Keys mit "+" am Ende werden nun auch geparst

**autoiter** · 21. August 2017

Hallo @AspirinJunkie,
vielen Dank für deine UDF und das Beispiel

Ich kann nicht behaupten, dass ich den Code auf den ersten Blick verstehe und ich habe nur dein Beispiel getestet. Allerdings sehen die Beispiele super aus und ich will das noch testen. Eine JSON UDF kann ich definitiv gebrauchen.

Wäre es Quatsch auch direkt eine Umwandung von xDArray zu JSON und umgekehrt einzubauen?

**AspirinJunkie** · 21. August 2017

Zitat von autoiter

Wäre es Quatsch auch direkt eine Umwandung von xDArray zu JSON und umgekehrt einzubauen?

Wenn du damit mehrdimensionale Arrays meinst: 2D Arrays sollte die UDF bereits konvertieren (wird dann im Grunde ein Array in Array):

AutoIt

#include <Array.au3>
#include "JSON.au3"


Global $a_Test[][3] = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
_ArrayDisplay($a_Test)
$s_JSON = _JSON_Generate($a_Test)
MsgBox(0, "2D Array", $s_JSON)


; Rückwandlung aus JSON in 2D-Array
$o_JSON = _JSON_Parse($s_JSON)
$a_Test2 = __ArrayAinATo2d($o_JSON)
_ArrayDisplay($a_Test2, "2D Array nach Rückkonvertierung")

Alles anzeigen

Umgekehrt (Also JSON in ein 2D-Array) würde so direkt nicht gehen, da man in JSON-Syntax nicht sehen kann ob es sich um ein 2D-Array handelt oder um ein Array-In-Array.
Es ist daher dem User überlassen die Struktur entsprechend zu interpretieren. Im Beispiel hier findest du einen Ansatz wie man dies bewerkstelligen kann.
3D und mehr halte ich persönlich für ziemlich exotisch und würde es daher dem User überlassen diese vorher in Array-In-Array Strukturen aufzubrechen.

Edit: Aber danke für deinen Hinweis - hab es gleich mal getestet und gleich den ersten Bug hierzu gefunden.
Hab es oben aktualisiert - nun sollten auch 2D-Arrays gehen.

**BugFix** · 21. August 2017

Gefällt mir gut
Seitdem ich angefangen hatte mich intensiver mit dem Editor Sublime Text zu beschäftigen, hatte ich auch mit JSON-Dateien zu tun, die die Basis für viele Einstellungen und PlugIns dieses Editors darstellen. Und das ist wirklich eine feine Sache. Ich hatte schon damit geliebäugelt, verstärkt JSON für meine AutoIt-Skripte zu verwenden, aber eine vernünftige Schnittstelle fehlte.
Soweit ich das bisher sehe, könnte diese UDF die Lücke bestens ausfüllen.
Danke @AspirinJunkie

NO1 :-) · 12. Januar 2018

Wow... finde deine UDF echt super! Die erste sinvolle JSON UDF die ich gefunden hab

Jetz hätt ich nur eine Frage zur Benutzung. Folgenden String liegt mir vor:

{ "image": { "url": "https://*********", "isDefault": false } }

wie kann ich jetzt den Wert des Parameters "url" abfragen?

EDIT: Wie kann ich generell die Objekthierarchie händeln, heißt JSON-Objekte in JSON-Objekte und dann erst die Attribute.

Danke schonmal, NO1

**AspirinJunkie** · 12. Januar 2018

Zitat von NO1 :-)

wie kann ich jetzt den Wert des Parameters "url" abfragen?

AutoIt

#include <JSON.au3>

Global $s_String = '{ "image": { "url": "https://*********", "isDefault": false } }'
Global $o_Object = _JSON_Parse($s_String)

Global $s_URL = _JSON_Get($o_Object, "image.url")

MsgBox(0,"URL", $s_URL)

Zitat von NO1 :-)

EDIT: Wie kann ich generell die Objekthierarchie händeln, heißt JSON-Objekte in JSON-Objekte und dann erst die Attribute.

Wie bitte? - das habe ich nicht verstanden.

NO1 :-) · 12. Januar 2018

Vielen Dank für deine schnelle Hilfe! Funktioniert ja super !

Zitat von AspirinJunkie

Wie bitte? - das habe ich nicht verstanden.

Ja hast meine Frage dadurch schon beantwortet. Ein JSON-Objekt ist immer der Inhalt zwischen den geschweiften Klammern...

Wenn ich hier jetzt zum Beispiel "location" auslesen will, wie mach ich das dann? Beginnen die Indicies auch bei 0?

{ "error": { "errors": [ { "locationType": "header", "location": "Authorization" } ], "code": 401, "message": "Invalid Credentials" } }

Tut mir leid, dass ich soviel nachfrag, aber die UDF begeistert mich grad voll...

**AspirinJunkie** · 12. Januar 2018

Zitat von NO1 :-)

Wenn ich hier jetzt zum Beispiel "location" auslesen will, wie mach ich das dann?

AutoIt

#include <JSON.au3>

Global $s_String = '{ "error": { "errors": [ { "locationType": "header", "location": "Authorization" } ], "code": 401, "message": "Invalid Credentials" } }'

Global $o_Object = _JSON_Parse($s_String)
Global $s_location = _JSON_Get($o_Object, "error.errors[0].location")

MsgBox(0,"Location", $s_location)

Zitat von NO1 :-)

Ein JSON-Objekt ist immer der Inhalt zwischen den geschweiften Klammern...

Wenn ich hier jetzt zum Beispiel "location" auslesen will, wie mach ich das dann? Beginnen die Indicies auch bei 0?

Deine Frage drehte sich halt nicht um Objekte sondern um Arrays und deren Indizierung.
Daher war mir nicht klar was du meintest.

NO1 :-) · 14. Januar 2018

Also vielen Dank, funktionier wunderbar.

Zitat von AspirinJunkie

Deine Frage drehte sich halt nicht um Objekte sondern um Arrays und deren Indizierung.
Daher war mir nicht klar was du meintest.

Zu dem Zeitpunkt gings mir noch nicht um die Arrays, aber danke, dass du mir die Frage auch gleich beantwortet hast .

Letzte Frage: Kann ich hier zum Beispiel überprüfen, ob "error" überhaupt existiert?

'{ "error": { "errors": [ { "locationType": "header", "location": "Authorization" } ], "code": 401, "message": "Invalid Credentials" } }'

**alpines** · 14. Januar 2018

Versuch doch mit Get die Daten zu lesen und schau dann inden Rückgabewert + @error.

Zitat

; Return values .: Success - Return the queried object out of the nested datastructure

; Failure - Return "" and set @error to:

; @error = 1 - pattern is not correct

; = 2 - keyname query to none dictionary object

; = 3 - keyname queried not exists in dictionary

; = 4 - index query on none array object

; = 5 - index out of array range

Alles anzeigen

**AspirinJunkie** · 14. Januar 2018

Zitat von NO1 :-)

Letzte Frage: Kann ich hier zum Beispiel überprüfen, ob "error" überhaupt existiert?

Ja - indem du @error der Funktion entsprechend auswertest:

AutoIt

#include <JSON.au3>

Global $s_String = '{ "error": { "errors": [ { "locationType": "header", "location": "Authorization" } ], "code": 401, "message": "Invalid Credentials" } }'

Global $o_Object = _JSON_Parse($s_String)

Global $s_Error = _JSON_Get($o_Object, "error")
Switch @error
    Case 1
        MsgBox(0,"Fehler", "Pattern ist irgendwie inkorrekt.")
    Case 2
        MsgBox(0,"Fehler", "Schlüsselname angegeben obwohl aktuelle Ebene gar kein Objekt ist.")
    Case 3
        MsgBox(0,"Fehler", "Dictionary existiert, aber angegebener Schlüssel nicht.")
    Case 4
        MsgBox(0,"Fehler", "Index angegeben obwohl aktuelle Ebene gar kein Array ist.")
    Case 5
        MsgBox(0,"Fehler", "Index ist außerhalb des derzeitigen Arrays")
    Case Else
        MsgBox(0,"", "Alles i. O. - error existiert")
EndSwitch

Alles anzeigen

Edit: tja - alpines war schneller

NO1 :-) · 24. Januar 2018

Okay vielen Dank ihr Beiden... Ihr seit echt ne super Hilfe

Lutz Ifer · 19. April 2018

Moin zusammen

Ich habe eine Frage bezüglich der Lizenzsierung der UDF

Ich bin gerade dabei mir ein Programm zu schreiben welches nach einer Windowsinstallation weitere Programme installiert und habe dafür deine JSON UDF verwendet um die Konfiguration zu laden

Jetzt überlege ich meinen Quellcode ggf freizugeben für den Privaten Gebrauch und einen selbstverfassten Lizenztext hinzuzufügen und weiss nicht wie ich das wegen der Benutzung der Fremdbibliothek machen soll

Desshalb die frage unter welche Lizenz die UDF selber steht

MFG: Lutz

**AspirinJunkie** · 19. April 2018

Zitat von Lutz Ifer

Desshalb die frage unter welche Lizenz die UDF selber steht

Na gut da das noch nicht geschehen ist stell ich die UDF hiermit mal unter die WTFPL.

Viel Spaß damit

Lutz Ifer · 19. April 2018

Wow diese kannte ich sogar noch garnicht

Danke ersteinmal das die UDF so freizügig gehandelt wird

Dann werde ich mal schauen das ich mein Script fertig mache um es online zu stellen

**Musashi** · 19. April 2018

Hallo AspirinJunkie !

Die WTFPL-Lizenz (= Do What The Fuck You Want To Public License) klingt natürlich schon allein vom Namen her verlockend . Sie bringt genau das 'rüber, was die meisten zum Thema 'Lizenzen' denken. Allerdings hat sie kleine Schwächen.

siehe : https://de.wikipedia.org/wiki/WTFPL

Auszug :

... Um ein Werk ohne Einschränkungen als Public Domain freizugeben, wird die CC0 empfohlen da diese speziell für Kompatibilität mit den verschiedenen internationalen Rechtssystem geschrieben wurde (im Gegensatz zur WTFPL, deren Rechtsverbindlichkeit im Klagefall unklar ist).

Ich würde daher auch für eine Creative Commons Lizenz plädieren, z.B. die CC0 !

siehe : https://de.wikipedia.org/wiki/Creative_Commons

Auszug :

CC0 (gesprochen cc zero) vereinigt in sich zwei rechtliche Werkzeuge, eine Verzichtserklärung und eine bedingungslose Lizenz. Die bedingungslose Lizenz fungiert als Rückfallposition (englisch „fallback license“) für den Fall, dass die vorrangige Verzichtserklärung nach dem jeweils geltenden Recht nicht voll wirksam ist. Mit der Verzichtserklärung wird der Verzicht auf sämtliche Schutzrechte erklärt. Dadurch soll das jeweilige Werk durch den Urheber bzw. Rechteinhaber aktiv in die Gemeinfreiheit überführt werden (englisch „voluntary public domain“).[36] Wenn diese Überführung rechtlich nicht möglich ist – wie beispielsweise in Deutschland oder Österreich – stellt die in CC0 enthaltene „Fallback License“ gewissermaßen eine Creative-Commons-Lizenz ohne die sonst üblichen Lizenzbedingungen (BY, SA, ND, NC, siehe oben) dar.
Falls Du eine CC-Lizenz mit Namensnennung bevorzugst, dann ->

CC-BY 3.0 DE

Falls Dich das Ganze nicht interessiert, kannst Du selbstverständlich bei der WTFPL-Lizenz bleiben. Große Rechtstreite sind im vorliegenden Fall ja eher nicht zu erwarten .

Gruß Musashi

**AspirinJunkie** · 19. April 2018

Zitat von Musashi

Falls Dich das Ganze nicht interessiert, kannst Du selbstverständlich bei der WTFPL-Lizenz bleiben. Große Rechtstreite sind im vorliegenden Fall ja eher nicht zu erwarten .

Passend zusammengefasst.

Die wtfpl ist für mich gerade so vertretbar für eine Thematik mit der ich mich in meinem Hobbybereich eigentlich überhaupt gar nicht beschäftigen will. Die CC scheidet daher für mich auch schon aus da ich dort ja meine wünsche erst zusammenklicken muss. Jeder klick für diese Thematik ist für mich hierzu verschwendet wenn es wie hier mein hobby betrifft.

Lutz Ifer · 19. April 2018

Ich sehe schon das ich ein heikles Thema angesprochen habe

Meine Überlegung war auch eigentlich nur das wenn ich etwas kostenlos Veröffentliche nicht der nächste hingeht und es weiterverkauft

Das ist der Grund warum ich mich damit auseinandersetzen wollte n Lizenztext beizugeben

**Musashi** · 19. April 2018

Zitat von AspirinJunkie

Passend zusammengefasst.

Der Beitrag war auch nur als Anregung für Dich gedacht.

Als Urheber musst Du im Grunde überhaupt keine Lizenz etc. angeben. Das Problem läge bei den Nutzern deiner UDF, da sie dann nicht wissen was sie machen dürfen. Eine Lizenzierung unter CC0 wäre auch nicht aufwändig - es reicht die entsprechende Angabe. Diese Entscheidung hast Du aber bereits getroffen und da will ich nicht weiter nerven .

Zitat von Lutz Ifer

Ich sehe schon, dass ich ein heikles Thema angesprochen habe.

Meine Überlegung war auch eigentlich nur das wenn ich etwas kostenlos veröffentliche nicht der nächste hingeht und es weiterverkauft.

Das ist der Grund warum ich mich damit auseinandersetzen wollte einen Lizenztext beizugeben

Hallo Lutz Ifer !

Heikel ist das Thema eigentlich nicht, nur wenig erbaulich .

Bei Dir liegt die Sache anders, da Du ja gewisse Einschränkungen machen willst. Für Dich wäre die WTFPL-Lizenz nicht geeignet. Zudem sind die CC-Lizenzen allgemein etabliert.

Schaue Dir mal den Link für die CC Lizenztypen an : https://de.wikipedia.org/wiki/Creative_Commons

Beispiel : CC-BY-NC-SA 3.0 DE

Falls Du noch weitere Fragen hast, nur zu !

Gruß Musashi

borsTiHD · 10. Juni 2018

Hi zusammen,

mir gefällt deine JSON UDF verdammt gut und nutze die sehr gern.

Soweit komme ich auch mit klar und es funktioniert, bei einzelnen bzw. geziehlten Abfragen.

Ich wollte dich/euch mal fragen wie ich folgendes dynamischer machen könnte:

AutoIt

Example()

Func Example()
    Local $sJSONTest = '{"_curlState": "200","_mtstatus": "ok","stuff": {"link": "x1","state": "ok"},"card": {"202": {"admin": "a5","state": "ok"}, "208": {"admin": "a5","state": "ok"}}}'

    Local $o_Object = _JSON_Parse($sJSONTest)

    Local $s_Type =     _JSON_Get($o_Object, ".card.202.state") & "|" & _
                        _JSON_Get($o_Object, ".card.202.admin") & "|" & _
                        _JSON_Get($o_Object, ".card.208.state") & "|" & _
                        _JSON_Get($o_Object, ".card.208.admin") & "|" & _
                        _JSON_Get($o_Object, ".stuff.state") & "|" & _
                        _JSON_Get($o_Object, ".stuff.link")

    ;Rückgabe
    ConsoleWrite("$s_Type: " & $s_Type & @CRLF)
    ConsoleWrite("$o_Object: " & $o_Object & @CRLF)

EndFunc

Alles anzeigen

Bei meiner echten JSON Abfrage bekomme ich bei "card" ein oder mehrere Rückgaben, mit einer jeweils nicht vorhersehbaren Nummer (zb. card.202, card.208).

Gibt es eine Möglichkeit das ich beispielsweise nur ein _JSON_Get($o_Object, ".card") mache und dann alle Objekte ausgelesen bekomme?

Bzw, kann ich, auch zu debug zwecken, mir den Inhalt dieser Objekte ($o_Object) in der Console, oder in ein Label ausgeben lassen?

Eine weitere Frage wäre, kennt einer eine Möglichkeit die Objekte zu zählen?

Ich würde gerne im obigen Beispiel wissen "wie viele" Objekte ich in "card" habe.

Hier wären es dann die Anzahl "2" (card 202 und 208).

Vielen Dank schon mal.

Teilen