Swift: Encode Struct Preserving Nil 3 Ways!
Zusammenfassung
Kurz
Der Bericht erläutert drei Swift-Ansätze, um optionale `nil`-Werte als JSON-`null` statt als fehlende Felder zu kodieren: Property Wrapper, Überschreiben von `encodeIfPresent` und eine `NilEncodable`-Konformität mit Reflection. Der Autor bevorzugt den letzten Weg, weist aber auf zusätzlichen Aufwand, begrenzte Steuerbarkeit und mögliche Leistungseinbußen hin; systematische Benchmarks enthält der Bericht nicht.
Mittel
Der Bericht zeigt drei Wege, optionale `nil`-Eigenschaften in Swift als JSON-`null` statt als ausgelassenes Feld zu kodieren. Laut Autor verwendet die Standardkodierung `encodeIfPresent`; eine eigene `encode(to:)`-Methode mit `encode` erzeugt dagegen `null`. `JSONSerialization` helfe in den gezeigten Beispielen nicht, und einen vollständigen eigenen Encoder zu schreiben sei aufwendig.
Als erste Lösung dient ein Property Wrapper, der bei `nil` `encodeNil` aufruft. Er ist pro Eigenschaft anzubringen. Zweitens kann `encodeIfPresent` für optionale Typen überschrieben werden. Das vermeidet Änderungen an den Strukturen, verlangt aber Überladungen für weitere Typen und bietet keine einfache gezielte Ausnahme.
Der Autor bevorzugt eine `NilEncodable`-Konformität, die Eigenschaften mit `Mirror` untersucht. Über `encoder.userInfo` lässt sich steuern, ob `nil` als `null` kodiert wird; eine Zuordnung kann benutzerdefinierte JSON-Schlüssel ermöglichen. Als Grenzen nennt der Bericht die langsamere Reflection, die zunächst fehlende Opt-out-Möglichkeit und ignorierte eigene Schlüssel in der einfachen Fassung. Die Aussagen beruhen auf Codebeispielen; systematische Tests oder Benchmarks werden nicht beschrieben.
Ausführlich lesen
Der Bericht behandelt drei Ansätze, mit denen optionale `nil`-Werte beim Kodieren von Swift-Strukturen als JSON-`null` erscheinen sollen. Laut Autor lässt `JSONEncoder` optionale Eigenschaften standardmäßig aus, statt sie als `null` auszugeben. Als Beispiel dient ein `User` mit optionaler E-Mail-Adresse: Gewünscht ist ein JSON-Feld `email: null`, wenn keine Adresse vorhanden ist.
Der Autor hält `JSONSerialization.jsonObject` für keine Lösung, weil es das bereits kodierte Ergebnis mit ausgelassenem Feld nicht nachträglich in ein `null`-Feld umwandle. Auch die direkte Verwendung von `JSONSerialization.data` funktioniere in seinem Beispiel nicht, da die Swift-Struktur dabei kein gültiges JSON-Objekt sei. Als Erklärung führt der Bericht an, dass die standardmäßig erzeugte Kodierung optionale Werte über `encodeIfPresent` behandle. Eine selbst implementierte `encode(to:)`-Methode könne stattdessen `encode` aufrufen und so `nil` als `null` schreiben. Diese Methode für jede Struktur einzeln zu schreiben, hält der Autor jedoch für unpraktisch. Ein vollständig eigener `Encoder` wäre laut ihm ebenfalls aufwendig, weil dafür mehrere Container und verschachtelte Kodierung behandelt werden müssten.
Der erste vorgestellte Weg ist ein Property Wrapper. Er kodiert vorhandene Werte normal und ruft bei `nil` ausdrücklich `encodeNil` auf. Damit lässt sich gezielt pro Eigenschaft festlegen, ob sie als `null` erscheint. Der Autor nennt als Nachteil, dass der Wrapper überall dort manuell angebracht werden muss, wo dieses Verhalten gewünscht ist. Für Dekodierung müsste der Wrapper zusätzlich `Decodable` unterstützen.
Der zweite Weg überschreibt `encodeIfPresent` in einer Erweiterung von `KeyedEncodingContainer`, hier beispielhaft für `String?`, und leitet den Aufruf an `encode` weiter. So müsse die Struktur nicht geändert werden und der Kodierungsschlüssel werde automatisch verwendet. Als Einschränkungen nennt der Autor, dass sich das Verhalten nicht ohne zusätzliche eigene Steuerung abschalten lasse und dass für weitere optionale Typen entsprechende Überladungen nötig wären.
Als bevorzugten Ansatz stellt der Autor eine eigene `NilEncodable`-Konformität vor. Die Implementierung untersucht Eigenschaften mit `Mirror`, erkennt optionale `nil`-Werte und kodiert diese bei entsprechender Einstellung in `encoder.userInfo` als `null`. Eine Zuordnung kann außerdem Spiegel-Eigenschaftsnamen auf benutzerdefinierte JSON-Schlüssel abbilden. Der Autor behauptet, der Ansatz funktioniere auch für Arrays und Wörterbücher. Er nennt aber drei Grenzen: eigene `CodingKey`-Definitionen würden in der einfachen Fassung ignoriert, das Verhalten lasse sich zunächst nicht gezielt ausnehmen, und Reflection sei laut seiner groben Einschätzung etwa eine Größenordnung langsamer als synthetisiertes `Codable`. Für typische Datenmengen hält er diesen Unterschied für kaum bemerkbar; dies ist seine Einschätzung, kein im Bericht dokumentierter Leistungstest. Eine überarbeitete Fassung beschränkt die Implementierung auf Typen mit `NilEncodable` und erlaubt die Steuerung über `userInfo`, damit andere Typen die Standardkodierung behalten. Der Bericht erläutert die Ansätze anhand von Swift-Code und Beispielausgaben, dokumentiert aber keine systematischen Tests oder Benchmarks.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Die Prüfung bezieht sich auf die mittlere Zusammenfassung. Die kurze Fassung ist ebenfalls weitgehend treu, weist aber den Aufwand ungenau zu: Der Bericht nennt Aufwand vor allem für den Property Wrapper und die eigene Encoder-Variante, nicht für den dritten Ansatz. Erfundene Angaben liegen in keiner der beiden Fassungen vor. Da keine Sammel- oder Teilfragen angegeben sind, bleibt die Einordnung leer.
Im Bericht, aber nicht in der Zusammenfassung
- Die Angabe, dass Reflection laut Autor etwa um eine Größenordnung langsamer ist als synthetisiertes Codable
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.