Ответ.

Протокол Codable был введён в Swift для упрощения процесса сериализации и десериализации данных, таких как JSON или Property List. Ранее для этого требовалось вручную реализовывать парсинг, что было трудоёмко, подвержено ошибкам и плохо читаемо. Автоматизация этого процесса позволила разрабатывать более безопасный и лаконичный код.

Проблема заключается в том, что при автоматическом применении Codable все свойства должны быть также Codable, а любое нарушение этой цепочки требует явной реализации методов декодирования и кодирования. Помимо этого, есть особенности при работе со структурами, классами с наследованием, а также при кастомном сопоставлении ключей.

Решение заключается в том, чтобы использовать Codable для простых моделей, строго следить за тем, какие свойства должны сериализоваться, и в случае сложных моделей реализовывать методы encode(to:) и init(from:), а также использовать CodingKeys для сопоставления ключей.

Пример кода:

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"
    }
}

Ключевые особенности:

Обеспечивает автоматическую сериализацию, если все свойства соответствуют протоколу Codable.
Позволяет настраивать сопоставление свойств и внешних ключей с помощью CodingKeys.
Требует ручной реализации при наличии расчетных свойств или специальных логик сериализации.

Вопросы с подвохом.

Может ли класс с наследованием и уникальными свойствами потомка быть корректно сериализован с помощью Codable автоматически?

Нет, для классов с наследованием Swift требует ручной реализации encode(to:) и init(from:) в подклассах, иначе свойства родителя и потомка не сериализуются корректно. Пример:

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)
    }
}

Что произойдёт, если свойство в структуре помечено как private, а используется автоматический Codable?

Если свойство private и не объявлено как var/let с явным CodingKeys, оно не будет сериализовано или десериализовано. Поэтому для private свойств обязательно нужно объявлять CodingKeys и включить их в перечисление при необходимости.

Возможно ли реализовать Codable только для декодирования (только чтение)?

Да, для этого достаточно реализовать только init(from:) и подчинять тип протоколу Decodable вместо Codable.

struct ReadOnlyModel: Decodable {
    let id: Int
}

Типовые ошибки и анти-паттерны

Ошибка: Использование Codable для моделей с бизнес-логикой или кэшируемыми полями, которых нет во внешнем источнике.
Анти-паттерн: Ожидание, что Codable автоматически справится с любыми случаями вложенности и наследования без явной реализации методов.

Пример из жизни

** Негативный кейс

Разработчик добавил в модель вычисляемое свойство, не реализовав кастомные методы encode и decode, надеясь на автоматическую обработку Codable.

Плюсы:

Быстрое prototyping, меньше кода.

Минусы:

Данные не сериализуются полностью, проблемы при чтении/записи, баги, не всегда явно обнаруживаются.

** Позитивный кейс

Разработчик реализует кастомные CodingKeys и кастомные методы encode/decode для сложных случаев, где свойства не совпадают с ключами, есть вычисляемые поля, и применяется наследование.