[인터뷰질문 004] Codable protocol이 하는 역할이 무엇인가요?
Cadable이란?
encodable과 decodable 프로토콜을 모두 채택한 프로토콜 입니다. 데이터를 손쉽게 Json이나 다른 구조화된 데이터로 인코딩 하거나, 파싱할 때 사용합니다.
예제
import Foundation
struct Student: Codable {
var name: String
var age: Int
}
let studentData = """
{
"name": "leeo",
"age": 17
}
""".data(using: .utf8)!
let student1 = try! JSONDecoder().decode(Student.self, from: studentData)
print(student1) // Student(name: "leeo", age: 17)
print(student1.name) // leeo
print(student1.age) // 17
모델을 만들고, Codable 프로토콜을 채택하면 Decodable 프로토콜이 포함되어 있기 때문에 JSONDecoder().decode()를 사용할 수 있습니다.
그러면 from: studentData이 부분에 입력된 데이터와 Student.self이 같은 타입인지 비교하고 일치하면 Student의 객체로 만들어 줍니다.
사용할 때의 문제점1
swift 에서 사용하고 있는 변수는 camelCase를 사용하고 있습니다. 하지만 내려오는 데이터도 같은 키로 내려오리란 보장이 없죠 그 때 사용할 수 있는것이 CodingKey입니다. 같은 키는 알아서 찾지만, 다른 이름으로 내려왔을 때 수동으로 매칭해준다고 생각하시면 쉬울 것 같습니다.
코드로 예를 들어보면 아래와 같습니다.
struct StudentFullname: Codable {
var firstName: String
var lastName: String
}
let studentFullname = """
{
"first_name": "hyunho",
"last_name": "lee"
}
""".data(using: .utf8)!
let student1Fullname = try! JSONDecoder().decode(StudentFullname.self, from: studentFullname)
print(student1Fullname.firstName)
print(student1Fullname.lastName)
실행 해보면 다음과 같은 에러가 발생 합니다.
No value associated with key CodingKeys(stringValue: \"firstName\", intValue: nil) (\"firstName\").", underlyingError: nil)
사실 당연합니다. first_name를 디코더에 넣고 firstName나 lastName로 바꾸라고 하면 어떤걸 골라야 할지 사람도 헷갈리 수 있으니까요!
그래서 수동으로 지정해주는 겁니다. 햇갈리지 않게!
struct StudentFullname: Codable {
var firstName: String
var lastName: String
enum CodingKeys: String, CodingKey {
case firstName = "first_name"
case lastName = "last_name"
}
}
let studentFullname = """
{
"first_name": "hyunho",
"last_name": "lee"
}
""".data(using: .utf8)!
let student1Fullname = try! JSONDecoder().decode(StudentFullname.self, from: studentFullname)
print(student1Fullname.firstName)
print(student1Fullname.lastName)
의미를 해석해보면, first_name이라는 녀석을 파싱해야 할 때는, firstName로 처리 해주면 되겠죠.
사용할 때의 문제점2
만약 원래 내려오던 키가 내려오지 않는다면, Swift.DecodingError.keyNotFound(CodingKeys(stringValue: "last_name", intValue: nil)와 같은 키를 찾지 못하는 에러가 발생할 것 입니다.
물론 var lastName: String?와 같은 방법으로 처리하는 해결책이 있을 수 있겠지만, 원래 스펙이 옵셔널이 아닌데 옵셔널로 처리하는 방법은 좋지 않습니다. 서버에서 발생한 오류겠지만, 실제 오류가 터지는 곳은 앱이니 앱에서 안전하게 처리할 수 있는 방법은 없는지 알아보겠습니다.
struct StudentFullname: Codable {
var firstName: String
var lastName: String
enum CodingKeys: String, CodingKey {
case firstName = "first_name"
case lastName = "last_name"
}
init(from decoder: Decoder) throws {
let values = try decoder.container(keyedBy: CodingKeys.self)
firstName = (try? values.decode(String.self, forKey: .firstName)) ?? "error first name"
lastName = (try? values.decode(String.self, forKey:.lastName)) ?? "error last name"
}
}
let studentFullname = """
{
"first_name": "hyunho"
}
""".data(using: .utf8)!
let student1Fullname = try! JSONDecoder().decode(StudentFullname.self, from: studentFullname)
print(student1Fullname.firstName)
print(student1Fullname.lastName)
위와 같이, 모델에서 직접 Decode 하면서, 값이 내려오지 않을 경우에 처리해주는 로직을 추가한다면, 값이 내려오지 않을 때에도 안전하게 처리할 수 있습니다.
값이 내려오긴 하는데 내려오지 않아야 할 값이 내려온다면 어떻게 할까요? 이전 예제는 아얘 아무값도 안내려 오는 것이지만, required인 값이 null로 내려온다면 마찬가지의 방법으로 에러인 상황을 안전하게 처리할 수 있다.
도움을 받을 수 있는 방법
디코딩이 생각대로 되지 않을 때, 어디서 부터 잘못되었는지 찾기 쉽지 않아서 공부한 방법을 하나 소개하겠습니다. 바로 모델에 CustomDebugStringConvertible을 채책해서 구현하는 것 입니다.
extension StudentFullname: CustomDebugStringConvertible {
var debugDescription: String {
var output: [String] = []
output.append("firstName : \(firstName)")
output.append("lastName : \(lastName)")
return output.joined(separator: "\n")
}
}
위와 같이 구현을 해놓으면, 현재 어떤 값에 문제가 있는지 한 눈에 들어오기 때문에 문제를 쉽게 파악할 수 있습니다. 앞으로 모델을 구현할 때, 같이 구현해 에러상황에서 스트레스를 받지 않고 문제를 해결할 수 있도록 해 놓아야 겠습니다.
let studentFullname = """
{
"first_name": "hyunho",
}
""".data(using: .utf8)!
let student1Fullname = try! JSONDecoder().decode(StudentFullname.self, from: studentFullname)
print(student1Fullname.debugDescription)
// firstName : hyunho
// lastName : error last name
댓글
댓글 쓰기