Protocol Based Generic Networking using JSONDecoder and Decodable in Swift 4
Zusammenfassung
Kurz
Das Swift-4-Tutorial erläutert am Beispiel einer Filmdaten-API eine generische Netzwerkschicht mit `URLSession`, Protokollen und `JSONDecoder`, die JSON in `Decodable`-Modelle umwandelt und Fehler übermittelt. Der Autor zeigt zwei Film-Feeds und empfiehlt passende Modelleigenschaften sowie optionale Felder für möglicherweise fehlende JSON-Schlüssel.
Mittel
James Rochabrun zeigt in diesem Swift-4-Tutorial, wie sich mit `JSONDecoder`, `Decodable` und Protokollerweiterungen eine generische Netzwerkschicht für eine Movie-Database-API erstellen lässt. Das Beispiel unterstützt zwei Film-Feeds: laufende und bestbewertete Filme.
Ein `Endpoint`-Protokoll bündelt Basisadresse und Pfad; eine Erweiterung erzeugt daraus URL und Anfrage. `APIError` benennt mögliche Anfrage-, Antwort- und Dekodierfehler. Das `APIClient`-Protokoll stellt eine generische `fetch`-Methode bereit. Sie prüft die HTTP-Antwort, dekodiert bei Statuscode 200 die Daten in einen `Decodable`-Typ, meldet Fehler über ein `Result`-Enum und startet die URL-Aufgabe. Die Antwort wird auf der Hauptwarteschlange verarbeitet.
Ein `MovieClient` nutzt diese Bausteine, um einen ausgewählten Feed als `MovieFeedResult` abzurufen. Im Beispiel gibt ein View Controller die Filmergebnisse oder einen Fehler in der Konsole aus; laut Autor sollte dort ein Array von Filmen erscheinen. Die JSON-Schlüssel müssen nach seiner Erklärung nicht separat zugeordnet werden, wenn sie mit den Modelleigenschaften übereinstimmen. Er empfiehlt optionale Eigenschaften für den Fall fehlender Schlüssel. Das Tutorial behandelt ein begrenztes Beispiel und führt keine weitergehenden Tests oder Fehlerfälle aus.
Ausführlich lesen
Der Bericht ist ein Tutorial von James Rochabrun aus dem Jahr 2017. Er zeigt am Beispiel einer Movie-Database-API, wie sich in Swift 4 mit `JSONDecoder`, `Decodable` und Protokollerweiterungen eine wiederverwendbare Netzwerkschicht aufbauen lässt. Der Autor beschränkt das Beispiel auf das Abrufen und Dekodieren von JSON sowie die Ausgabe der Ergebnisse in der Konsole; eine passende Benutzeroberfläche mit XIBs kündigt er als möglichen zweiten Teil an.
Zunächst beschreibt das Tutorial ein generisches `Result`-Enum mit Erfolgs- und Fehlerfall. Damit soll ein Abschluss-Handler jeweils nur den Wert oder den Fehler übermitteln müssen. Ein `Endpoint`-Protokoll verlangt Basisadresse und Pfad. Eine Erweiterung ergänzt API-Schlüssel, URL-Komponenten und `URLRequest`. Das Enum `MovieFeed` stellt zwei Endpunkte bereit: „Now Playing“ und „Top Rated“. Ein weiteres Enum, `APIError`, fasst mögliche Fehler wie fehlgeschlagene Anfrage, ungültige Daten, nicht erfolgreiche Antwort und JSON-Konvertierungs- oder Parsingfehler zusammen und versieht sie mit Beschreibungen.
Das zentrale Element ist das `APIClient`-Protokoll. Es verlangt eine `URLSession` und eine generische `fetch`-Methode für Typen, die `Decodable` entsprechen. Die Protokollerweiterung implementiert eine Hilfsfunktion, die eine Datenaufgabe erstellt, die HTTP-Antwort prüft und bei Statuscode 200 die Daten mit `JSONDecoder` in den angegebenen Typ dekodiert. Bei fehlender HTTP-Antwort, fehlenden Daten, einem anderen Statuscode oder einem Dekodierfehler wird jeweils ein passender Fehler zurückgegeben. Die Hilfsfunktion startet die Aufgabe noch nicht, sondern gibt sie zurück. `fetch` verarbeitet das Ergebnis auf der Hauptwarteschlange, wendet eine übergebene Dekodierfunktion an und startet die Aufgabe mit `resume()`.
Anschließend stellt `MovieClient` eine standardmäßig konfigurierte `URLSession` bereit und bietet `getFeed` an. Diese Methode nimmt einen `MovieFeed` entgegen, ruft damit die generische Netzwerkschicht auf und wandelt das dekodierte Objekt sicher in `MovieFeedResult` um. Im Beispiel verarbeitet ein View Controller den Erfolg, greift auf die Filmergebnisse zu und gibt sie in der Konsole aus; Fehler werden ebenfalls ausgegeben. Der Autor sagt, dabei sollte ein Array von Filmen erscheinen.
Zum Schluss erklärt das Tutorial, dass die JSON-Schlüssel nicht eigens im Parsing-Code zugeordnet werden: Laut Autor entsprechen die Eigenschaften des Movie-Modells den Schlüsseln in der Antwort, und `Decodable` übernimmt das Dekodieren. Er empfiehlt, Modelle `Decodable` entsprechen zu lassen und Eigenschaften optional zu gestalten, falls ein Schlüssel fehlt. Die Darstellung bleibt ein konkretes Lehrbeispiel mit zwei Film-Feeds und einer Konsolenausgabe. Sie beschreibt keine umfassende Fehlerbehandlung jenseits der genannten Fälle und belegt keine Tests oder Ergebnisse außerhalb des beschriebenen Beispiels.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Bewertet wurde die Fassung mittel; die Fassung kurz wurde nicht separat geprüft. Die Einordnung stützt sich allein auf den Bericht, Lunas Stufe 4 und ihren Anteil von 50 Prozent habe ich nicht übernommen.
Im Bericht, aber nicht in der Zusammenfassung
- Die Begründung für das generische Result-Enum: Erfolg und Fehler werden getrennt übergeben, statt in Completion-Handlern einen der beiden Werte auf nil zu setzen.
- Der angekündigte Bonusteil, in dem Protokollerweiterungen zum Erstellen der Oberfläche mit XIBs dienen sollen.
- Das Starterprojekt mit der Gruppe Model und der leeren Gruppe Networking als Ausgangspunkt.
In der Zusammenfassung, laut Prüfung nicht im Bericht belegt
- Die Aussage, das Beispiel sei begrenzt und führe keine weitergehenden Tests oder Fehlerfälle aus, steht so nicht im Bericht.
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Modelle teilen und schützen
- SF-H3 Wie lässt sich nachverfolgen, woraus ein Modell entstanden ist und was in ihm steckt?
- clef 100 %kein Bezug
- Luna 50 %einzelne zitierbare Belege
- JEV 34 %beantwortet teilweise oder widerspricht
- amos 100 %kein Bezug
- SubQ 100 %kein Bezug
- drex 100 %kein Bezug
- d3-ultra 100 %kein Bezug
- Haiku-Prüfung nur am Rande erwähnt