HOWTO · PHP
JSON-Objekt von URL in PHP abrufen
In diesem Tutorial wird erläutert, wie Sie in PHP ein JSON-Objekt von einer URL abrufen
Auf dieser Seite
Diese Anleitung zeigt, wie Sie in PHP eine JSON-Antwort abrufen, in nutzbare Daten umwandeln und zwischen file_get_contents() und cURL wählen. Das Stream-Beispiel verwendet eine eigenständige Data-URL; das cURL-Beispiel greift auf einen JSONPlaceholder-Endpunkt für einen Beitrag zu.
JSON mit file_get_contents() abrufen
Die Funktion file_get_contents() kann eine entfernte URL lesen, wenn die PHP-Einstellung allow_url_fopen aktiviert ist. Diese Einstellung ist häufig standardmäßig aktiviert, kann jedoch vom Hosting-Anbieter festgelegt werden. Prüfen Sie die aktive PHP-Konfiguration, wenn das Lesen einer URL verweigert wird. Wenn Sie die PHP-Installation selbst verwalten, können Sie die Einstellung in der Konfigurationsdatei php.ini ändern. Ein Aufruf wie ini_set('allow_url_fopen', '1') kann sie zur Laufzeit nicht zuverlässig aktivieren, da es sich um eine Systemdirektive handelt.
Die Anfrage gibt den Antworttext als Zeichenfolge zurück. Übergeben Sie diese Zeichenfolge an json_decode(), um gültiges JSON in PHP-Daten umzuwandeln. Dieses eigenständige Beispiel ruft JSON über den PHP-URL-Wrapper data:// ab. So lässt sich ein erfolgreicher Lesevorgang ohne externen Dienst zeigen. Ersetzen Sie für eine HTTP-API $url durch einen Endpunkt wie https://jsonplaceholder.typicode.com/posts/1:
Führen Sie dieses Beispiel aus:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
<?php
$url = 'data://text/plain,%7B%22title%22%3A%22PHP%20JSON%20fetch%20works.%22%7D';
$json = file_get_contents($url);
$post = json_decode($json);
echo $post->title, PHP_EOL;
PHP JSON fetch works.
Bei einem HTTP-Endpunkt bleiben die Schritte gleich: Antworttext abrufen, JSON dekodieren und auf die Eigenschaft title zugreifen. Wenn das Lesen der entfernten URL fehlschlägt, wird false zurückgegeben. Prüfen Sie dieses Ergebnis, bevor Sie die Antwort dekodieren, wie im Abschnitt zur Fehlerbehandlung gezeigt.
JSON mit PHP cURL abrufen
Verwenden Sie die PHP-Erweiterung cURL, wenn sie verfügbar ist und Sie mehr Kontrolle über Anfrageoptionen, Header, Zeitlimits oder die Behandlung des HTTP-Status benötigen. Die Erweiterung muss installiert und aktiviert sein. Mit CURLOPT_RETURNTRANSFER gibt curl_exec() den Antworttext als Zeichenfolge zurück, anstatt ihn in die Ausgabe zu schreiben. Schließen Sie den Handle nach der Anfrage immer.
Dieses Beispiel sendet eine Anfrage an JSONPlaceholder und dekodiert die Antwort als Objekt. Der Titel wird nur ausgegeben, wenn die Anfrage erfolgreich ist und die Antwort dieses Feld enthält. Ist cURL nicht verfügbar, meldet das Beispiel die fehlende Voraussetzung, statt diesen Ablauf als erfolgreichen Abruf darzustellen:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
<?php
$url = 'https://jsonplaceholder.typicode.com/posts/1';
if (!function_exists('curl_init')) {
echo "Enable the PHP cURL extension first.", PHP_EOL;
} else {
$curl = curl_init($url);
if ($curl === false) {
echo "Could not initialize cURL.", PHP_EOL;
} else {
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
if ($response === false) {
$error = curl_error($curl);
curl_close($curl);
echo "Request failed: ", $error, PHP_EOL;
} else {
curl_close($curl);
$post = json_decode($response);
if (is_object($post) && isset($post->title)) {
echo $post->title, PHP_EOL;
} else {
echo "The response did not contain a title.", PHP_EOL;
}
}
}
}
Die URL wird an curl_init() übergeben, das den Handle für diese Adresse initialisiert. curl_exec() führt die Anfrage aus; anschließend lässt sich die Antwort wie die des Stream-Wrappers dekodieren. Für dieses Beispiel sind ein erreichbarer Endpunkt und die PHP-Erweiterung cURL erforderlich. Die Meldung zur Voraussetzung bedeutet nicht, dass ein Abruf erfolgreich war.
JSON-Antwort dekodieren
Standardmäßig gibt json_decode() JSON-Objekte als PHP-Objekte zurück. Auf ein Feld wie title greifen Sie daher mit $post->title zu. Wenn Sie assoziative Arrays bevorzugen, übergeben Sie als zweites Argument true: json_decode($response, true). Greifen Sie dann mit $post['title'] auf dasselbe Feld zu. Verwenden Sie den gewählten Dekodiermodus konsequent zusammen mit der passenden Zugriffssyntax. Bei verschachteltem JSON folgen Sie auf jeder Ebene der jeweiligen Objekteigenschaft oder dem Array-Schlüssel.
Ein erfolgreicher HTTP-Abruf garantiert nicht, dass die Antwort gültiges JSON enthält. Der Server könnte eine HTML-Fehlerseite oder einen anderen nicht dekodierbaren Inhalt zurückgeben. Außerdem wird gültiges JSON null zu PHP null dekodiert. Prüfen Sie daher json_last_error(), wenn Sie diesen Wert von einem Dekodierfehler unterscheiden müssen.
Fehler beim Abruf und beim Dekodieren behandeln
Wenn file_get_contents() das Lesen nicht gelingt, gibt die Funktion false zurück und kann eine PHP-Warnung ausgeben. Unterdrücken Sie die Warnung nur, wenn Sie den Fehler selbst behandeln, und prüfen Sie vor dem Aufruf von json_decode(), ob das Ergebnis false ist. Prüfen Sie nach dem Dekodieren json_last_error(), damit ein Transportfehler nicht mit einer Antwort verwechselt wird, die ungültiges JSON enthält. Dieses eigenständige Beispiel liest fehlerhaftes JSON aus einer lokalen Data-URL. Ersetzen Sie $url durch Ihren Endpunkt, um dessen Antwort zu behandeln:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
<?php
$url = 'data://text/plain,%7Binvalid';
$json = @file_get_contents($url);
if ($json === false) {
echo "Request failed: could not read the URL.", PHP_EOL;
} else {
$data = json_decode($json);
if (json_last_error() !== JSON_ERROR_NONE) {
echo "JSON decoding failed: ", json_last_error_msg(), PHP_EOL;
} else {
echo "JSON decoded successfully.", PHP_EOL;
}
}
Die beiden Zweige melden unterschiedliche Fehler: Im ersten Fall konnte PHP die URL nicht lesen; im zweiten Fall hat PHP einen Inhalt erhalten, der kein gültiges JSON ist. Prüfen Sie bei einem echten Endpunkt außerdem das PHP-Fehlerprotokoll, wenn der Lesevorgang fehlschlägt, und stellen Sie sicher, dass allow_url_fopen aktiviert und der Endpunkt erreichbar ist.
Bei cURL prüfen Sie, ob curl_exec() false zurückgegeben hat, bevor Sie versuchen, den Antworttext zu dekodieren. Rufen Sie in diesem Fall curl_error($curl) auf, bevor Sie den Handle schließen, um den Transportfehler abzurufen. Auch eine abgeschlossene cURL-Anfrage kann einen HTTP-Fehlerstatus zurückgeben. Wenn der Status wichtig ist, prüfen Sie curl_getinfo($curl, CURLINFO_HTTP_CODE). Schließen Sie den Handle immer, nachdem Sie die Antwort und Diagnosedaten erfasst haben.
Prüfen Sie nach beiden Anfragearten json_last_error() nach dem Aufruf von json_decode(), wenn der Antworttext möglicherweise kein JSON enthält. Ein Wert ungleich null weist auf einen Dekodierfehler hin; json_last_error_msg() liefert eine Beschreibung. Halten Sie Transport- und Dekodierfehler auseinander, damit die Diagnose auf den tatsächlich fehlgeschlagenen Schritt verweist.
Methode auswählen
Wählen Sie file_get_contents() für einen einfachen Abruf, wenn allow_url_fopen aktiviert ist und das Standardverhalten des Streams ausreicht. Wählen Sie cURL, wenn die Anfrage eigene Header, Zeitlimits, eine Statusprüfung oder andere Übertragungsoptionen benötigt. Stellen Sie dabei sicher, dass die PHP-Erweiterung cURL verfügbar ist. Prüfen Sie in beiden Fällen das Anfrageergebnis, bevor Sie die Antwort dekodieren, und behandeln Sie Dekodierfehler anschließend gesondert.