나무's 블로그

JSON Decoing with Codable

이전에 작성한 포스팅에서 간단한 JSON을 Codable과 JSONDecoder를 이용해 파싱하였다.

https://wlgusdn700.tistory.com/50?category=913317

하지만, 프로젝트를 진행하다보면 서버에서 내려준 JSON(Key:Value) 중에 굳이 없어도 되는 값들이 존재한다.

"""
{
	id: 10,
    name: "tree",
    nation: "대한민국"
    ....
}
"""

해당 JSON을 불러오고 여기서 id와 name만 사용한다고 가정하자.

필요없는 Key&Value는 선언하지 않고 Decodable을 채택/준수하면 된다.

struct Person: Decodable{
	let id: Int
    let name: String
  
//property 명과 key가 같기 때문에 CodingKeys를 작성하지 않아도 된다.  
//    enum CodingKeys: String, CodingKey{
//    
//    }
}

struct Person2: Decodable{
	let identifier: Int
    let nickname: String
    
    enum CodingKeys: String, CodingKey{
    	case identifier = "id"
        case nickname = "name"
    }
}

Nested Decodable

"""
{
	"id": 11,
    "name": "tree",
    "nation": "대한민국",
    "company": {
    	"name": "네카라쿠",
        "industry": "IT",
        ....
    }
    ....
}
"""

위의 JSON이 있다고 가정하자.

만약 내가 필요한 Key&Value가 name, companyIndustry 2가지가 필요하다고 가정하자.

기존의 방식을 사용하면 Person이라는 struct안에 Company라는 struct를 하나 더 두어서 구현하는 방식이 있다.

(물론 해당 방식도 틀리다고 생각하지는 않는다.)

struct Person: Decodable{

    let name: String
	let company: Company
    
    struct Company: Decodable{
    	let industry: String
    }
    
}

이렇게 구현 시, industry라는 property에 접근하기 위해서는 

person.company.industry 로 접근해야 한다. 사실 2-depth밖에 되지 않기 때문에, 불편해 보이지는 않는다.

더 심한 예를 들어보자.

"""
{
	"httpDomain": "www......",
    "response": {
    	...
        "person":{
        	"id": 29,
            "name": "tree",
            "company": {
                "industry": "IT",
                .....
            }
        }
        .....
    }
}
"""

depth를 한단계 더 추가하였다. (실제 프로젝트에서는 더 깊고, 배열 등의 자료구조까지 들어간다면 훨씬 복잡해진다.)

(나는 name과 industry만 필요한데, 굳이 Response, Person, Company라는 struct를 만들어야하네...? 코드가 너무 길어지는데..?)

사실 response.person.company.industry 를 짧게 줄이는 방법은 여러가지가 있을 것이다.

1. computed Property

읽기 전용 computedProperty를 선언한다.

struct Response: Decodable{
	....
    var industry: String{
	person.company.industry
    }
    ....
}

2. Subcript

배열인 경우에는 서브스크립트를 사용해서 가져올 수 있다.

3. init(from decoder: Decoder)

struct Response: Decodable{
.....
	let name: String
    let industry: String

    enum CodingKeys: String, CodingKey{
    	case name
        case response
        case person
        case company
        case industry
    }

    init(from decoder: Decoder) throws{
    //가장 큰 {}가 있는 영역 -> {}를 컨테이너라고 생각하는 것이 이해하기 쉬웠다.
        let values = try decoder.container(keyedBy: CodingKeys.self)
        //response가 차지하고 있는 {}가 있는 영역
        let response = try values.nestedContainer(keyedBy: CodingKeys.self, forKey: .response)
        //response 영역 내에 있는 name을 파싱
        self.name = try response.decode(String.self, forKey: .name)
        //response 영역 내에 있는 person 영역
        let person = try response.nestedContainer(keyedBy: CodingKeys.self, forKey: .person)
        //person 영역 내에 있는 company 영역
        let company = try person.nestedContainer(keyedBy: CodingKeys.self, forKey: .company)
        //company 영역 내에 있는 industry를 파싱
        self.industry = try company.decode(String.self, forKey: .industry)
        
        //물론 한번에 작성해도 된다.
        
        self.industry = try response.nestedContainer(keyedBy: CodingKeys.self, forKey: .person)
        						.nestedContainer(keyedBy: CodingKeys.self, forKey: .company)
                                .decode(String.self, forKey: .industry)
    }
.....
}

이렇게 작성하게 되면 여러개의 struct를 굳이 만들지 않고도 industry를 최상단 struct에서 사용할 수 있다.

또한, String이나 Int 그리고 모든 Key&Value에서 struct에 저장할 때! 변경/조작하고 싶다면 init(from:)에서 조작도 가능하므로

더 폭넓게 사용할 수 있다.

Codable이란?

A type that can convert itself into and out of an external representation.

자신을 변환하거나 외부 표현(JSON 같은 데이터를 주고 받는 형식)으로 변환할 수 있는 타입이다.

또한

Codable은 Decodable과 Encodable을 동시에 채택한 타입이다.

Decodable : 자신을 외부표현(external representation)에서 디코딩 할 수 있는 타입

Encodable : 자신을 외부표현(external representation)으로 인코딩 할 수 있는 타입

따라서, Codable은 자신을 외부표현으로 디코딩 & 인코딩이 가능한 타입 이라고 생각하시면 될 것 같다

Codable은 프로토콜

Codable은 프로토콜이므로 Class, Struct, Enum 에서 모두 사용할 수 있습니다. (이전 Protocol 포스팅에 있음)

그리고 타입에서 Codable을 채택했다는 것은 해당 타입을 serialize / deserialize 할 수 있다는 것

struct SomeType{
	var name: String
    var id: Int
}

이라는 구조체가 있다고 가정하자.

해당 타입에 Codable을 채택해보자

struct SomeType: Codable {
	var name: String
    var id: Int
}

이제 SomeType이라는 구조체는 외부표현(JSON형식)으로 변환이 가능한 타입입니다.

Encode

JSON으로 만드는 방법

//인코더 생성
let encoder = JSONEncoder()

//인스턴스 생성
let someInstance = SomeType(name: "First", id: 1)

//인코딩해서 jsonData에 저장 
// 1. encode메소드의 리턴타입은 Data
// 2. encode메소드는 throws -> try? 사용 -> try? 사용으로 jsonData는 옵셔널
let jsonData = try? encoder.encode(someInstance)

//Data 형식을 보기 좋게 String으로 변환
if let jsonData = jsonData, let jsonString = String(data: jsonData, encoding: .utf8){
	print(jsonString) // {"name" : "First", "id" : 1}
}

주로 주고받을 데이터 형식을 약속할 때, JSON을 사용한다. 하지만 어느 곳을 가도 {"name":"First","id":1} 처럼 가로로 쭉 늘어놓은 데이터로 약속을 하지 않을 것이다. 보통 봐온 JSON형식은 아래와 같다

{
	"name" : "First",
    "id" : 1
}

위처럼 JSONString을 이쁘게 만들 수 있다

//위와 같이 이쁘게 만들어준다
encoder.outputFormatting = .prettyPrinted

//key값을 기준으로 오름차순으로 정렬한다
encoder.outputFormatting = .sortedKeys

//그렇다면 나는 key값을 기준으로 오름차순으로 정렬한 이쁜 데이터를 받고싶어!
encoder.outputFormatting = [.prettyPrinted, .sortedKeys]

Decode

JSON을 내가 만든 타입으로 변환하기

주로 서버에 있는 데이터(JSON)을 받아서 내가 저장하고 싶은 타입의 모델에 저장하는 작업을 자주하게 된다.

이때 사용할 수 있는 것이 Codable이다.

//디코더 생성
let decoder = JSONDecoder()

//위에서 만든, Encode된 JSON을 Data로 변환
var data = jsonString.data(using: .utf8)

//Data 형식을 내가 만든 모델인 SomeType의 인스턴스로 변환
if let data = data, let someInstance = try? decoder.decode(SomeType.self, from: data){
	print(someInstance.name) // First
    print(someInstance.id) // 1
}

CodingKey

음... 쉽게 예를 들어보자

struct SomeType: Codable{
	var name: String
    var id: Int
}

위와 같은 타입에 Codable을 채택했다.

근데 넘어오는 데이터 형식이

{
	"name" : "First",
    "identifier" : 1
}

이렇게 넘어온다고 하자

내가 생성한 모델의 id와 넘어오는 JSON의 identifier의 "Key"가 다르다 -> 이렇게 되면 

No Value associated with key id 라고 나온다.

해결 방법은 2가지가 있다.

1. JSON형식에 맞춰 모델의 프로퍼티 명을 작성하는 방법
   1. 오류는 없겠지만, 가독성 측면에서 좋지 않다
2. CodingKey 사용!

CodingKey 사용

struct SomeType: Codable{
	var name: String
    var id: Int
    
    enum CodingKeys: String, CodingKey{
    	case name
        case id = "identifier" // identifier라는 키는 이제부터 id프로퍼티가 담당할거야!
    }
}

지금까지 Swift에서 모델에서 JSON으로 인코딩, JSON에서 모델로 디코딩 방법과

key값이 다를 때 사용하는 CodingKey에 대해 알아보았다.