JSONPath-Syntax erklärt: Was $, [*] und .. auswählen
![Screenshot: Im JSON-Eingabefeld stehen die Beispieldaten mit book und bicycle, im Feld für den Pfadausdruck $.store.book[*].title. Der Ergebnisbereich zeigt 2 Treffer, die beiden Buchtitel als Array.](/images/blog/de/jsonpath-syntax-explained/01-result.webp)
Inhalt
Ob ein JSONPath-Ausdruck tatsächlich auf den gewünschten Wert zeigt, lässt sich mit bloßem Auge kaum sicher beurteilen. Symbole wie $, ., [ ], [*] und .. werden nach festen Regeln ausgewertet.
Wenn Sie diese Regeln kennen, können Sie auch von Hand nachvollziehen, welchen Wert ein Pfadausdruck auswählt. In diesem Beitrag prüfen wir an einem Beispiel-JSON Schritt für Schritt, was jedes Symbol tatsächlich auswählt.
Kurzfassung ①
$steht für das gesamte JSON-Dokument,.eigenschaftoder['eigenschaft']für genau einen bestimmten Schlüssel eines Objekts. ②[Zahl]wählt den n-ten Wert eines Arrays (negative Zahlen zählen vom Ende),[*]oder.*wählt alle Werte an dieser Stelle. ③..durchsucht rekursiv alle Ebenen, und das Ergebnis ist unabhängig von der Trefferzahl immer ein Array.
Das Problem: Nur bestimmte Werte aus einer API-Antwort extrahieren
Wer mit JSON-Daten arbeitet, begegnet in Dokumentationen und Beispielcode oft Pfadausdrücken wie $.data.items[0].name. Der Kern von JSONPath: Ein einziger Ausdruck kann einen Wert ansprechen, der irgendwo in einer verschachtelten JSON-Struktur liegt.
Die Frage ist, ob derselbe Pfadausdruck auch in Ihrer eigenen JSON-Struktur genauso funktioniert. Wenn Schlüsselnamen oder die Reihenfolge im Array abweichen, zeigt ein scheinbar ähnlicher Ausdruck auf einen ganz anderen Wert oder findet gar nichts.
Ob in den eckigen Klammern eine Zahl oder * steht, was sich ändert, wenn hinter dem Punkt ein * folgt, und wie weit .. genau sucht: Ein einziges Zeichen verändert das Ergebnis, und diesen Unterschied vorherzusagen, ist allein durch Hinsehen nicht leicht.
Ohne Tool: Das Ergebnis allein mit den Symbolregeln berechnen
Der unterstützte Syntaxumfang unterscheidet sich je nach JSONPath-Implementierung etwas. Die fünf Regeln hier beziehen sich auf das folgende Beispiel-JSON. Wenn Sie sie Zeichen für Zeichen anwenden, lässt sich das Ergebnis auch von Hand nachvollziehen.
{
"store": {
"book": [
{ "title": "Almanach des armen Charlie", "price": 22000 },
{ "title": "Der intelligente Investor", "price": 18500 }
],
"bicycle": { "color": "red", "price": 129000 }
}
}
Es gibt fünf Regeln:
$— steht für das gesamte Dokument. Besteht der Pfadausdruck nur aus$, ist das Ergebnis ein Array mit genau einem Element: dem gesamten JSON..eigenschaftoder['eigenschaft']— wählt in einem Objekt den Schlüssel mit diesem Namen aus.$.store.bicycle.colorzeigt auf den einen String "red".[Zahl]— wählt im Array den Wert an dieser Position (Zählung beginnt bei 0). Negative Zahlen zählen vom Ende des Arrays.$.store.book[0]ist das erste Buch,$.store.book[-1]das letzte.[*]oder.*— wählt alle Werte an dieser Stelle aus.$.store.book[*]wählt beide Buchobjekte aus, also alle Elemente des Arrays book...— sucht den folgenden Namen auf allen Ebenen des Dokuments.$..pricefindet insgesamt drei Werte: die beiden price-Einträge in book und den price von bicycle.
So wird $.store.book[*].title Schritt für Schritt ausgewertet:
- Schritt 1
$→ Das gesamte Dokument (1 Element) ist die Ausgangsmenge. - Schritt 2
.store→ Die Menge verengt sich auf das eine Objekt store. - Schritt 3
.book→ Die Menge verengt sich auf das eine Array book (das Array selbst ist der Wert). - Schritt 4
[*]→ Die Menge wächst auf jedes Element des Arrays book, also auf 2 Buchobjekte. - Schritt 5
.title→ Aus jedem verbliebenen Buchobjekt wird der Schlüssel title gelesen, es ergeben sich 2 Strings.
Das Endergebnis ist ["Almanach des armen Charlie", "Der intelligente Investor"] mit 2 Treffern. Wenn Sie diese fünf Schritte konsequent anwenden, können Sie das Ergebnis jedes Pfadausdrucks von Hand vorhersagen.
Prüfen Sie mit unserem JSONPath-Abfrage-Tester, ob diese fünf Schritte auch bei Ihrem eigenen JSON und Ihrem Pfadausdruck zum selben Ergebnis führen.
Geben Sie JSON und einen Pfadausdruck ein, und der JSONPath-Abfrage-Tester zeigt sofort die übereinstimmenden Werte und deren Anzahl. Die Daten werden nur im Browser verarbeitet und nicht an einen Server gesendet.
![Screenshot: Im JSON-Eingabefeld stehen die Beispieldaten mit book und bicycle, im Feld für den Pfadausdruck $.store.book[*].title. Der Ergebnisbereich zeigt 2 Treffer, die beiden Buchtitel als Array.](/images/blog/de/jsonpath-syntax-explained/01-result.webp)
Typische Stolpersteine
Wer JSONPath zum ersten Mal verwendet, erlebt an einigen Stellen Ergebnisse, die von der Erwartung abweichen. Die folgende Tabelle zeigt, was tatsächlich passiert, wenn Sie diese Pfadausdrücke eingeben.
| Eingegebener Pfadausdruck | Was tatsächlich passiert |
|---|---|
$.store.book[1:3] (Slice) | Ohne Fehlermeldung erscheint „Keine übereinstimmenden Werte“. Der Text in den Klammern wird nicht als Slice interpretiert, sondern unverändert als Eigenschaftsname behandelt. Da book ein Array ist, lässt sich dort über einen Namen nichts finden. |
$.store.book[?(@.price>20000)] (Filterausdruck) | Aus demselben Grund gibt es 0 Treffer. Die Filtersyntax ?() wird nicht interpretiert, der gesamte Inhalt der Klammern gilt als Eigenschaftsname. |
$.store.book[10] (Index außerhalb des Bereichs) | Ohne Fehlermeldung gibt es 0 Treffer. Ein Index jenseits der Array-Länge fällt stillschweigend aus dem Ergebnis. |
$.store.book (das Array selbst auswählen) | Das gesamte Array book wird als ein einziger Treffer verpackt ausgegeben. Das Ergebnis ist also ein Array, das ein Array enthält. |
$ allein | Das Ergebnis ist ein Array mit einem Element, das das gesamte Dokument enthält. |
Filterausdrücke und Slices scheitern stillschweigend, weil der Inhalt der eckigen Klammern nur in drei Formen interpretiert wird: als Indexzahl, als Platzhalter (*) oder als Name in Anführungszeichen.
Alles, was zu keiner dieser drei Formen passt, wird als Anweisung verstanden, einen Schlüssel mit genau diesem Namen zu suchen. Da es einen solchen Schlüssel nicht gibt, bleibt das Ergebnis leer.
Zusammenfassung
$steht für das gesamte Dokument,.eigenschaftoder['eigenschaft']für einen einzelnen Schlüssel eines Objekts.[Zahl]ist ein Array-Index (negative Zahlen zählen vom Ende),[*]oder.*wählt alle Werte an dieser Stelle aus...durchsucht rekursiv alle Ebenen und sammelt sämtliche passenden Werte.- Das Ergebnis ist unabhängig von der Trefferzahl immer ein Array. Gibt es keinen Treffer, erscheint statt eines Fehlers „Keine übereinstimmenden Werte“.
- Der Filterausdruck
?()und der Slice[1:3]werden nicht unterstützt. Syntax außerhalb des unterstützten Umfangs führt nicht zu einem Fehler, sondern stillschweigend zu 0 Treffern.
Geben Sie JSON und einen Pfadausdruck ein, und der JSONPath-Abfrage-Tester zeigt sofort die übereinstimmenden Werte und deren Anzahl. Die Daten werden nur im Browser verarbeitet und nicht an einen Server gesendet.
Häufige Fragen
Warum ist das Ergebnis immer ein Array?
Mit [*] oder .. lassen sich mehrere Werte auf einmal finden. Deshalb wird das Ergebnis unabhängig von der Trefferzahl einheitlich als Array dargestellt. Auch wenn Sie nur $ eingeben und damit das gesamte Dokument ansprechen, erhalten Sie ein Array mit einem Element.
Warum werden der Filterausdruck ?() und der Slice [1:3] nicht unterstützt?
Der JSONPath-Abfrage-Tester interpretiert nur sechs Syntaxformen: $, .eigenschaft, ['eigenschaft'], [Zahl], [*]/.* und ...
Geben Sie Syntax außerhalb dieses Umfangs ein, etwa ?() oder [1:3], gibt es keinen Fehler. Stattdessen wird der Inhalt der Klammern unverändert als Eigenschaftsname behandelt, und das Ergebnis sind 0 Treffer.
Wird das eingegebene JSON an einen Server gesendet?
Nein. Das Parsen des JSON und die Auswertung des Pfads laufen ausschließlich im Browser. Die eingegebenen Daten werden weder an einen Server gesendet noch gespeichert.
Wie wird ein negativer Index genau berechnet?
Die tatsächliche Position ergibt sich aus der Array-Länge plus dem negativen Index. Bei einem Array mit 2 Elementen zeigt [-1] zum Beispiel auf Position 2 + (-1) = 1, also auf das letzte Element. Liegt die berechnete Position außerhalb des Arrays, gibt es 0 Treffer.
Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen