Как мапить JSON-ключи в свойства модели, если ключ совпадает с зарезервированным словом Swift?

При работе с JSON в Swift протоколы Codable, Decodable и Encodable предоставляют удобный способ сериализации и десериализации данных. Однако иногда ключи в JSON могут совпадать с зарезервированными словами Swift, такими как default, self, case, return и другими. Использование таких слов в качестве имён свойств напрямую приведёт к ошибке компиляции.

Решение с помощью CodingKeys

Стандартный подход — определить перечисление CodingKeys внутри вашей модели, которое соответствует протоколу CodingKey. В этом перечислении вы можете указать, как ключ JSON должен быть сопоставлен с свойством модели. Для свойств, имена которых являются зарезервированными словами, можно использовать обратные кавычки (`) в имени свойства, а в CodingKeys задать строковый ключ из JSON.

Пример кода

Предположим, у нас есть JSON с ключом "default", который является зарезервированным словом в Swift.

import Foundation

struct Settings: Codable {
    let name: String
    // Используем обратные кавычки для имени свойства
    let `default`: Bool
    let value: Int

    // Определяем CodingKeys для маппинга
    enum CodingKeys: String, CodingKey {
        case name
        // Ключ JSON "default" мапится на свойство `default`
        case `default` = "default"
        case value
    }
}

// Пример JSON
let jsonString = """
{
    "name": "Auto-save",
    "default": true,
    "value": 10
}
"""

let jsonData = jsonString.data(using: .utf8)!
let decoder = JSONDecoder()
do {
    let settings = try decoder.decode(Settings.self, from: jsonData)
    print(settings.name)      // Auto-save
    print(settings.default)   // true
    print(settings.value)     // 10
} catch {
    print("Decoding error: \(error)")
}

Где это применяется

Этот подход необходим при работе с внешними API, где вы не контролируете структуру JSON. Часто такие ситуации возникают при интеграции с бэкенд-сервисами, которые могут использовать ключи, совпадающие с ключевыми словами различных языков программирования. Использование CodingKeys обеспечивает гибкость и позволяет адаптировать модель под любой JSON, сохраняя чистоту кода на Swift.

Вывод: Используйте перечисление CodingKeys и обратные кавычки для свойств, когда ключи JSON совпадают с зарезервированными словами Swift. Это стандартное и безопасное решение, которое обеспечивает корректное декодирование данных и предотвращает ошибки компиляции.