Der Umgang mit JSON-Dokumenten wir immer wichtiger, da immer mehr Rest-APIs dieses Format nutzen, um Daten auszutauschen. In einem weiteren Artikel namens Mit JSON arbeiten (www.vbentwickler.de\/361) haben wir bereits gezeigt, wie wir JSON-Dokumente möglichst einfach per VBA lesen können. Das ist schon die halbe Miete, aber die Kommunikation mit Rest-APIs ist keine Einbahnstraße: Wir müssen auch immer wieder mal Daten im JSON-Format an eine Rest-API senden. Wir nutzen dazu wiederum die Bibliothek von Tim Hall, die uns eine Funktion namens ConvertToJSON zur Verfügung stellt. Dieser müssen wir nun nur noch die Daten in einem entsprechenden Format übergeben. Wie das gelingt, zeigen wir im vorliegenden Artikel.<\/b><\/p>\n
Im Artikel Google Calendar per Rest-API programmieren <\/b>(www.vbentwickler.de\/410<\/b>) hatten wir die Aufgabe, ein JSON-Dokument mit den Daten eines in Google Calendar anzulegenden Ereignisses zu erstellen. Das kann man auf die klassische Art machen, indem man dieses einfach zeilenweise als String in einer Variablen erfasst.<\/p>\n
Dafür brauchen wir, wie in Listing 1 zu sehen, keine weiteren Hilfsmittel – der JSON-Ausdruck wird anschließend beispielsweise per Debug.Print <\/b>wie folgt ausgegeben und kann so auch an die Rest-API geschickt werden:<\/p>\n Listing 1: Beispiel für das Erfassen eines JSON-Dokuments per String-Variable<\/span><\/b><\/p>\n Das Problem ist nur: Wenn wir diese Zeilen zusammenstellen wollen, ist das ein erheblicher Aufwand. <\/p>\n Schauen wir uns die folgende Zeile des zu erzeugenden JSON-Dokuments an und gehen wir davon aus, dass wir das Dokument in VBA basierend auf einer Vorlage zusammenstellen wollen:<\/p>\n Dann müssen wir zuerst am Anfang der Zeile strJSON = strJSON & ” <\/b>voranstellen, hinten ein ” & vbCrLf <\/b>anfügen und schließlich noch alle enthaltenen Anführungszeichen verdoppeln, damit diese auch als Anführungszeichen innerhalb des Variableninhalts interpretiert werden und nicht als das Ende der Zeichenkette:<\/p>\n Das ist nicht nur sehr aufwendig, wenn man es von Hand macht, sondern auch noch extrem fehleranfällig.<\/p>\n Stellen wir uns dann vor, wir wollten zwischendrin eine Zeile entfernen – beispielsweise die Zeile mit dem Wert für das Feld description<\/b>:<\/p>\n Dann müssen wir hier nicht nur die Zeile entfernen, sondern auch in der vorherigen Zeile das Komma, denn sonst wäre das JSON-Dokument fehlerhaft.<\/p>\n Hier kommt die Bibliothek beziehungsweise das Modul von Tim Hall ins Spiel, die wir zum Beispiel hier herunterladen können:<\/p>\n Diese bietet einige nützliche Funktionen. Eine davon, ParseJSON<\/b>, haben wir bereits in dem oben genannten Artikel verwendet, um aus einem JSON-Dokument ein Objekt zu generieren, das alle Elemente des JSON-Dokuments in strukturierter Form als Dictionaries und Collections enthält.<\/p>\n In diesem Artikel zeigen wir auch unsere eigene Erweiterung, mit der wir noch den Code ausgeben, den wir für den Zugriff auf die Elemente verwenden können. Auf die Elemente des obigen, zugegebenermaßen einfach aufgebauten JSON-Dokuments, greifen wir damit wie folgt zu:<\/p>\n Wie aber können wir nun den umgekehrten Weg gehen – also den, ein JSON-Dokument über Dictionary<\/b>– und Collection<\/b>-Elemente zusammenzustellen und daraus dann mit der Funktion ConvertToJSON <\/b>ein JSON-Dokument im String<\/b>-Format abzuleiten? Dies schauen wir uns anhand einiger Beispiele an.<\/p>\n Die wichtigste Information vorab: <\/p>\n Im ersten Beispiel wollen wir dieses Dokument erzeugen:<\/p>\n Dazu brauchen wir noch verhältnismäßig viel Code:<\/p>\n Nun wollen wir wie folgt ein oder mehrere Name-Wert-Paare hinzufügen:<\/p>\n Dazu brauchen wir je Name-Wert-Paare nur die Add<\/b>-Methode des Dictionary<\/b>-Objekts erneut aufzurufen:<\/p>\n Wir sehen: Die Hauptarbeit ist bereits getan, alle weiteren Elemente auf diese Ebene sind Einzeiler.<\/p>\n Nun wollen wir wie folgt die Adresse hinzufügen, welche die Adressdaten im Element Adresse <\/b>aufführt:<\/p>\n Dazu legen wir einfach ein neues Dictionary<\/b>-Element namens dicAdresse <\/b>an. Dieses fügen wir zuerst als Unterelement mit dem Namen Adresse <\/b>zum Hauptelement dicJSON <\/b>hinzu.<\/p>\n Erst danach füllen wir dicAdresse <\/b>mit den drei Name-Wert-Paaren:<\/p>\n Dies können wir endlos so weiterbetreiben. Interessant ist aber nun noch, wie wir mit mehreren gleichartigen Elementen umgehen, die in eckige Klammern eingefasst werden sollen.<\/p>\n Nun stellen wir uns vor, wir wollten mehrere Adressen für den Kontakt speichern – beispielsweise zwei:<\/p>\n Dafür benötigen wir nun auch zwei Dictionary<\/b>-Elemente namens dicAdresse1<\/b> und dicAdresse2<\/b>. Diese fügen wir einem Collection<\/b>-Element namens colAdressen<\/b> hinzu, das wir wiederum dem Element Adressen <\/b>untergeordnet haben:<\/p>\n Möchten Sie weiterlesen? Dann lösen Sie Ihr Ticket!<\/span>Public Sub <\/span>JSONPerString()\r\n Dim <\/span>strJSON As String<\/span>\r\n strJSON = \"{\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"start\"\": {\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"dateTime\"\": \"\"2023-11-22T17:00:00\"\",\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"timeZone\"\": \"\"Europe\/Berlin\"\"\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" },\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"end\"\": {\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"dateTime\"\": \"\"2023-11-22T18:30:00\"\",\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"timeZone\"\": \"\"Europe\/Berlin\"\"\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" },\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"summary\"\":\"\"Summary\"\",\" & vbCrLf<\/span>\r\n strJSON = strJSON & \" \"\"description\"\":\"\"description\"\"\" & vbCrLf<\/span>\r\n strJSON = strJSON & \"}\" & vbCrLf<\/span>\r\n Debug.Print<\/span> strJSON\r\nEnd Sub<\/span><\/pre>\n{\r\n \"start\": {\r\n \"dateTime\": \"2023-11-22T17:00:00\",\r\n \"timeZone\": \"Europe\/Berlin\"\r\n },\r\n \"end\": {\r\n \"dateTime\": \"2023-11-22T18:30:00\",\r\n \"timeZone\": \"Europe\/Berlin\"\r\n },\r\n \"summary\":\"Summary\",\r\n \"description\":\"description\"\r\n}<\/pre>\n \"dateTime\": \"2023-11-22T17:00:00\",<\/pre>\n
strJSON = strJSON & \" \"\"dateTime\"\": \"\"2023-11-22T17:00:00\"\",\" & vbCrLf<\/span><\/pre>\nstrJSON = strJSON & \" \"\"summary\"\":\"\"Summary\"\",\" & vbCrLf<\/span>\r\nstrJSON = strJSON & \" \"\"description\"\":\"\"description\"\"\" & vbCrLf<\/span>\r\nstrJSON = strJSON & \"}\" & vbCrLf<\/span><\/pre>\nVereinfachung dank JSON-Bibliothek<\/h2>\n
https:\/\/github.com\/VBA-tools\/VBA-JSON\/blob\/master\/JsonConverter.bas<\/pre>\n
objJSON.Item(\"start\").Item(\"dateTime\")\r\nobjJSON.Item(\"start\").Item(\"timeZone\")\r\nobjJSON.Item(\"end\").Item(\"dateTime\")\r\nobjJSON.Item(\"end\").Item(\"timeZone\")\r\nobjJSON.Item(\"summary\")\r\nobjJSON.Item(\"description\")<\/pre>\n
Objekte erstellen<\/h2>\n
\n
Einfachstes Beispiel: Ein Name-Wert-Paar<\/h2>\n
{\r\n \"Vorname\":\"Andre\"\r\n}<\/pre>\nPublic Sub <\/span>NameWertPaar()\r\n Dim <\/span>dicJSON As <\/span>New<\/span> Dictionary\r\n Dim <\/span>strJSON As String<\/span>\r\n dicJSON.Add \"Vorname\", \"Andre\"\r\n strJSON = ConvertToJson(dicJSON)\r\n Debug.Print<\/span> strJSON\r\nEnd Sub<\/span><\/pre>\nMehrere Name-Wert-Paare<\/h2>\n
{\r\n \"Vorname\":\"Andre\",\r\n \"Nachname\":\"Minhorst\"\r\n}<\/pre>\nPublic Sub <\/span>ZweiNameWertPaare()\r\n Dim <\/span>dicJSON As <\/span>New<\/span> Dictionary\r\n Dim <\/span>strJSON As String<\/span>\r\n dicJSON.Add \"Vorname\", \"Andre\"\r\n dicJSON.Add \"Nachname\", \"Minhorst\"\r\n strJSON = ConvertToJson(dicJSON)\r\n Debug.Print<\/span> strJSON\r\nEnd Sub<\/span><\/pre>\nName-Wert-Paare mit untergeordneten Elementen<\/h2>\n
{\r\n \"Vorname\":\"Andre\",\r\n \"Nachname\":\"Minhorst\",\r\n \"Adresse\":{\r\n \"Strasse\":\"Borkhofer Str. 17\",\r\n \"PLZ\":\"47137\",\r\n \"Ort\":\"Duisburg\"\r\n }\r\n}<\/pre>\nPublic Sub <\/span>NameWertMitUnterelementen()\r\n Dim <\/span>dicJSON As <\/span>New<\/span> Dictionary\r\n Dim <\/span>dicAdresse As <\/span>New<\/span> Dictionary\r\n Dim <\/span>strJSON As String<\/span>\r\n dicJSON.Add \"Vorname\", \"Andre\"\r\n dicJSON.Add \"Nachname\", \"Minhorst\"\r\n dicJSON.Add \"Adresse\", dicAdresse\r\n dicAdresse.Add \"Strasse\", \"Borkhofer Str. 17\"\r\n dicAdresse.Add \"PLZ\", \"47137\"\r\n dicAdresse.Add \"Ort\", \"Duisburg\"\r\n strJSON = ConvertToJson(dicJSON)\r\n Debug.Print<\/span> strJSON\r\nEnd Sub<\/span><\/pre>\nMehrere gleiche Objekte<\/h2>\n
{\r\n \"Vorname\":\"Andre\",\r\n \"Nachname\":\"Minhorst\",\r\n \"Adressen\":[\r\n {\r\n \"Strasse\":\"Borkhofer Str. 17\",\r\n \"PLZ\":\"47137\",\r\n \"Ort\":\"Duisburg\"\r\n },\r\n {\r\n \"Strasse\":\"Gerichtsstr. 2a\",\r\n \"PLZ\":\"12344\",\r\n \"Ort\":\"Testhausen\"\r\n }\r\n ]\r\n}<\/pre>\nPublic Sub <\/span>NameWertMitMehrerenGleichenUnterelementen()\r\n Dim <\/span>dicJSON As <\/span>New<\/span> Dictionary\r\n Dim <\/span>colAdressen As <\/span>New<\/span> Collection\r\n Dim <\/span>dicAdresse1 As <\/span>New<\/span> Dictionary\r\n Dim <\/span>dicAdresse2 As <\/span>New<\/span> Dictionary\r\n Dim <\/span>strJSON As String<\/span>\r\n dicJSON.Add \"Vorname\", \"Andre\"\r\n dicJSON.Add \"Nachname\", \"Minhorst\"\r\n dicJSON.Add \"Adressen\", colAdressen\r\n colAdressen.Add dicAdresse1\r\n dicAdresse1.Add \"Strasse\", \"Borkhofer Str. 17\"\r\n dicAdresse1.Add \"PLZ\", \"47137\"\r\n dicAdresse1.Add \"Ort\", \"Duisburg\"\r\n colAdressen.Add dicAdresse2\r\n dicAdresse2.Add \"Strasse\", \"Gerichtsstr. 2a\"\r\n dicAdresse2.Add \"PLZ\", \"12344\"\r\n dicAdresse2.Add \"Ort\", \"Testhausen\"\r\n strJSON = ConvertToJson(dicJSON)\r\n Debug.Print<\/span> strJSON\r\nEnd Sub<\/span><\/pre>\n
\nHier geht es zur Bestellung des Jahresabonnements des Magazins Visual Basic Entwickler<\/strong>:<\/span>
\nZur Bestellung ...<\/a><\/span>
\nDanach greifen Sie sofort auf alle rund 200 Artikel<\/strong> unseres Angebots zu - auch auf diesen hier!<\/span>
\nOder haben Sie bereits Zugangsdaten? Dann loggen Sie sich gleich hier ein:<\/span><\/p>\n<\/div>\n\n\t\n\t