Swift Academy · 강의

이름 변경을 위한 CodingKeys

서로 다른 JSON 이름과 속성 이름을 매핑합니다.

이름 변경을 위한 CodingKeys은(는) CoddyKit의 무료 Swift Academy 강의입니다. 이것은 4개 중 1번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Swift Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Swift Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

키 이름을 바꾸는 이유

JSON API에서는 Swift 프로퍼티 이름과 다른 이름을 사용하는 경우가 많습니다. 예를 들어 first_name과 firstName이 있습니다. CodingKeys 열거형을 사용하면 모델의 API를 변경하지 않고 두 이름을 연결할 수 있습니다.

import Foundation

struct User: Codable {
    var firstName: String
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
    }
}

print("CodingKeys maps firstName to first_name")

CodingKeys의 구성

CodingKeys는 String, CodingKey를 준수하는 중첩 열거형입니다. 각 케이스는 프로퍼티 이름에 대응하고, 원시 값은 사용할 JSON 키가 됩니다.

import Foundation

struct Product: Codable {
    var productName: String
    var unitPrice: Double
    enum CodingKeys: String, CodingKey {
        case productName = "product_name"
        case unitPrice = "unit_price"
    }
}

print(Product.CodingKeys.productName.rawValue)

이름을 바꾼 키로 디코딩하기

디코딩할 때 디코더는 CodingKeys의 원시 값을 사용해 각 프로퍼티를 찾으므로 snake_case JSON이 camelCase 프로퍼티에 채워집니다.

import Foundation

struct User: Codable {
    var firstName: String
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
    }
}

let json = "{\"first_name\":\"Ada\"}"
let u = try JSONDecoder().decode(User.self, from: json.data(using: .utf8)!)
print(u.firstName)

이름을 바꾼 키로 인코딩하기

인코딩에서는 같은 매핑을 반대로 사용합니다. 출력 JSON에는 Swift 프로퍼티 이름이 아니라 원시 값인 키가 들어갑니다.

import Foundation

struct User: Codable {
    var firstName: String
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
    }
}

let data = try JSONEncoder().encode(User(firstName: "Ada"))
print(String(data: data, encoding: .utf8)!)

모든 프로퍼티 나열하기

CodingKeys 열거형을 추가하면 인코딩하거나 디코딩할 모든 프로퍼티에 해당하는 케이스를 포함해야 합니다. 원시 값 없이 유지한 케이스는 프로퍼티 이름을 그대로 사용합니다.

import Foundation

struct Item: Codable {
    var id: Int
    var displayName: String
    enum CodingKeys: String, CodingKey {
        case id
        case displayName = "display_name"
    }
}

let data = try JSONEncoder().encode(Item(id: 1, displayName: "Pen"))
print(String(data: data, encoding: .utf8)!)

프로퍼티 제외하기

프로퍼티를 CodingKeys에서 제외하면 인코딩과 디코딩에서 빠집니다. 이러한 프로퍼티에는 기본값이 있어야 합성된 초기화 구문이 타입을 계속 만들 수 있습니다.

import Foundation

struct User: Codable {
    var name: String
    var cachedToken: String = "none"
    enum CodingKeys: String, CodingKey {
        case name
    }
}

let u = try JSONDecoder().decode(User.self, from: "{\"name\":\"Ada\"}".data(using: .utf8)!)
print(u.name, u.cachedToken)

여러 키 이름 바꾸기

필요한 만큼 키를 매핑하세요. 각 케이스는 Swift 프로퍼티와 서버가 기대하는 정확한 JSON 키를 연결합니다.

import Foundation

struct Account: Codable {
    var userId: Int
    var isVerified: Bool
    enum CodingKeys: String, CodingKey {
        case userId = "user_id"
        case isVerified = "is_verified"
    }
}

let json = "{\"user_id\":7,\"is_verified\":true}"
let a = try JSONDecoder().decode(Account.self, from: json.data(using: .utf8)!)
print(a.userId, a.isVerified)

더 이해하기 쉬운 이름으로 매핑하기

CodingKeys는 snake_case에만 사용하는 것이 아닙니다. 이를 사용해 이해하기 어려운 API 키를 명확한 Swift 프로퍼티 이름으로 바꿀 수 있습니다.

import Foundation

struct Reading: Codable {
    var temperature: Double
    enum CodingKeys: String, CodingKey {
        case temperature = "t"
    }
}

let json = "{\"t\":19.5}"
let r = try JSONDecoder().decode(Reading.self, from: json.data(using: .utf8)!)
print(r.temperature)

중첩 타입의 CodingKeys

각 Codable 타입에는 고유한 CodingKeys가 있습니다. 중첩 구조체는 부모와 독립적으로 자체 키 이름을 바꿀 수 있습니다.

import Foundation

struct Meta: Codable {
    var createdAt: String
    enum CodingKeys: String, CodingKey { case createdAt = "created_at" }
}
struct Doc: Codable { var title: String; var meta: Meta }

let json = "{\"title\":\"A\",\"meta\":{\"created_at\":\"today\"}}"
let d = try JSONDecoder().decode(Doc.self, from: json.data(using: .utf8)!)
print(d.meta.createdAt)

이름을 바꾼 키의 왕복 처리

같은 CodingKeys가 양방향을 모두 제어하므로 값은 snake_case로 인코딩된 후 동일한 Swift 값으로 다시 디코딩됩니다.

import Foundation

struct User: Codable {
    var firstName: String
    var lastName: String
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
        case lastName = "last_name"
    }
}

let u = User(firstName: "Ada", lastName: "Lovelace")
let data = try JSONEncoder().encode(u)
let back = try JSONDecoder().decode(User.self, from: data)
print(back.firstName, back.lastName)

CodingKeys를 사용할 때

개별 키를 정밀하게 제어해야 하거나, 일부 키만 다르거나, 프로퍼티를 제외해야 할 때 명시적인 CodingKeys 열거형을 사용하세요. 모든 키가 일관되게 snake_case인 API라면 디코딩 전략이 더 간단할 수 있습니다.

import Foundation

struct Event: Codable {
    var eventName: String
    var startTime: String
    enum CodingKeys: String, CodingKey {
        case eventName = "name"
        case startTime = "start_time"
    }
}

let json = "{\"name\":\"Launch\",\"start_time\":\"10:00\"}"
let e = try JSONDecoder().decode(Event.self, from: json.data(using: .utf8)!)
print(e.eventName, e.startTime)

빠른 확인: CodingKeys

키 이름 변경에 대한 이해도를 테스트해 보세요.

복습: 이름 변경을 위한 CodingKeys

키를 정밀하게 제어하는 방법을 배웠습니다:

타입 안에 enum CodingKeys: String, CodingKey를 중첩해 선언합니다.
각 케이스의 원시 값이 JSON 키가 되며, 케이스가 인코딩과 디코딩을 모두 제어합니다.
코딩할 모든 프로퍼티를 나열하세요. 하나라도 제외하면 해당 프로퍼티가 빠지며 기본값이 필요합니다.
중첩 타입은 서로 독립적인 CodingKeys를 가집니다.

자주 묻는 질문

“이름 변경을 위한 CodingKeys” 강의는 무료인가요?

네 — “이름 변경을 위한 CodingKeys” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Swift Academy 강의 전체를 잠금 해제할 수 있습니다. Swift Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“이름 변경을 위한 CodingKeys”에서 뭘 배우나요?

서로 다른 JSON 이름과 속성 이름을 매핑합니다. 브라우저에서 직접 실행하는 실습 코드로 Swift Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Swift Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Swift Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 1번째 강의입니다.

“이름 변경을 위한 CodingKeys” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Swift Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Swift Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← Swift Academy(으)로 돌아가기