Antwort.

Das Protokoll Codable wurde in Swift eingeführt, um den Prozess der Serialisierung und Deserialisierung von Daten wie JSON oder Property List zu vereinfachen. Früher erforderte dies manuelles Parsen, was zeitaufwendig, fehleranfällig und schwer lesbar war. Die Automatisierung dieses Prozesses ermöglichte es, sichereren und prägnanteren Code zu entwickeln.

Problem ist, dass bei der automatischen Anwendung von Codable alle Eigenschaften ebenfalls Codable sein müssen, und jede Verletzung dieser Kette erfordert eine explizite Implementierung der Dekodierungs- und Kodierungs-Methoden. Darüber hinaus gibt es Besonderheiten beim Arbeiten mit Strukturen, Klassen mit Vererbung sowie bei benutzerdefinierter Schlüsselzuordnung.

Lösung besteht darin, Codable für einfache Modelle zu verwenden, genau darauf zu achten, welche Eigenschaften serialisiert werden sollen, und bei komplexen Modellen die Methoden encode(to:) und init(from:) zu implementieren sowie CodingKeys zur Schlüsselzuordnung zu verwenden.

Beispielcode:

struct User: Codable {
    let id: Int
    let name: String
    let email: String?

    enum CodingKeys: String, CodingKey {
        case id
        case name = "full_name"
        case email = "contact_email"
    }
}

Schlüsselfeatures:

Bietet automatische Serialisierung, wenn alle Eigenschaften dem Protokoll Codable entsprechen.
Ermöglicht die Anpassung der Zuordnung von Eigenschaften und externen Schlüsseln mithilfe von CodingKeys.
Erfordert eine manuelle Implementierung bei Vorhandensein von berechneten Eigenschaften oder speziellen Serialisierungslogiken.

Fangfragen.

Kann eine Klasse mit Vererbung und einzigartigen Eigenschaften des Nachkommens automatisch korrekt mit Codable serialisiert werden?

Nein, für Klassen mit Vererbung verlangt Swift eine manuelle Implementierung von encode(to:) und init(from:) in den Unterklassen, andernfalls werden die Eigenschaften des Elternteils und des Nachkommen nicht korrekt serialisiert. Beispiel:

class Animal: Codable {
    let species: String
}
class Dog: Animal {
    let breed: String
    
    enum CodingKeys: String, CodingKey {
        case breed
    }
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        breed = try container.decode(String.self, forKey: .breed)
        try super.init(from: decoder)
    }
    
    override func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(breed, forKey: .breed)
        try super.encode(to: encoder)
    }
}

Was passiert, wenn eine Eigenschaft in einer Struktur als private markiert ist und automatische Codable verwendet wird?

Wenn die Eigenschaft privat ist und nicht ausdrücklich mit CodingKeys als var/let deklariert wird, wird sie nicht serialisiert oder deserialisiert. Daher müssen für private Eigenschaften unbedingt CodingKeys deklariert und bei Bedarf in die Enumeration aufgenommen werden.

Ist es möglich, Codable nur für die Dekodierung (nur Lesen) zu implementieren?

Ja, dafür reicht es aus, nur init(from:) zu implementieren und den Typ dem Protokoll Decodable anstelle von Codable zu unterordnen.

struct ReadOnlyModel: Decodable {
    let id: Int
}

Typische Fehler und Anti-Patterns

Fehler: Verwendung von Codable für Modelle mit Geschäftslogik oder cachebaren Feldern, die nicht aus einer externen Quelle stammen.
Anti-Pattern: Erwartung, dass Codable automatisch mit allen Fällen von Verschachtelung und Vererbung ohne explizite Implementierung der Methoden umgeht.

Beispiel aus dem Leben

** Negativer Fall

Ein Entwickler fügte ein berechnetes Eigenschaft in das Modell ein, ohne benutzerdefinierte Methoden für encode und decode zu implementieren, in der Hoffnung auf die automatische Verarbeitung von Codable.

Vorteile:

Schnelles Prototyping, weniger Code.

Nachteile:

Daten werden nicht vollständig serialisiert, Probleme beim Lesen/Schreiben, Bugs, die nicht immer offensichtlich sind.

** Positiver Fall

Ein Entwickler implementiert benutzerdefinierte CodingKeys und benutzerdefinierte Methoden für encode/decode in komplexen Fällen, wo Eigenschaften nicht mit Schlüsseln übereinstimmen, es berechnete Felder gibt und Vererbung angewendet wird.