Codable magic

Feb 15, 2018
#ios #swift

I have finally started replacing all NSCoding objects in my code with Codable. This post covers things that I’ve learned along the way.

Disclaimer

The protocol and implementations in this post are fictional representations of a real world domain model that I work with.

Model

Lets say that our app has Movie and MovieGenre structs that look like this:

struct Movie {
    
    let id: Int
    let name: String
    let releaseDate: Date
    let genre: MovieGenre
}

enum MovieGenre: String { case
    
    action,
    drama,
    ...
}

If these structs are central to our app, we probably want to use them in various ways, e.g. serializing and deserializing them. Let’s have a look at how we built this functionality before, using NSCoding:

NSCoding

Before Codable, you could have added this support by letting Movie implement NSCoding. However, that would also require it to be a class and not a struct:

import Foundation

class Movie: NSObject, NSCoding {

    
    // MARK: - Initialization

    // ...more initializers
    
    required init?(coder: NSCoder) {
        guard
            let id = coder.decodeObject(forKey: idKey) as? Int,
            let name = coder.decodeObject(forKey: nameKey) as? String,
            let date = coder.decodeObject(forKey: releaseDateKey) as? Date,
            let _genre = coder.decodeObject(forKey: genreKey) as? String,
            let genre = MovieGenre(rawValue: _genre)
            else { return nil }
        self.id = id
        self.name = name
        self.releaseDate = date
        self.genre = genre
    }
    
    
    // MARK: - Mapping Keys
    
    private let idKey = "id"
    private let nameKey = "name"
    private let releaseDateKey = "releaseDate"
    private let genreKey = "genre"
    
    
    // MARK: - Properties
    
    let id: Int
    let name: String
    let releaseDate: Date
    let genre: MovieGenre
    
    
    // MARK: - Public Functions
    
    func encode(with coder: NSCoder) {
        coder.encode(NSNumber(value: id), forKey: idKey)
        coder.encode(name, forKey: nameKey)
        coder.encode(releaseDate, forKey: releaseDateKey)
        coder.encode(genre.rawValue, forKey: genreKey)
    }
}

As you can see, we inherit NSObject and implement a bunch of encoding/decoding logic. This is really tedious, especially if you have nested types. Let’s take a look at how Codable can make this a lot easier and cleaner.

Codable

First of all, Codable does not require you to use classes. Your Movie can be a struct and still implement Codable, like this:

import Foundation

struct Movie: Codable {

    let id: Int
    let name: String
    let releaseDate: Date
    let genre: MovieGenre
}

With the code above, however, the compiler will complain that the Movie struct does not implement Decodable. If you’re new to using Codable, you can easily end up adding a bunch of code to make it conform to Codable, for instance:

import Foundation

struct Movie: Codable {


    // MARK: - Initialization

    // ...more initializers

    required init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        id = try values.decode(Int.self, forKey: .id)
        name = try values.decodeIfPresent(String.self, forKey: .name)
        releaseDate = try values.decode(Date.self, forKey: .releaseDate)
        genre = try values.decode(BookFormat.self, forKey: .genre)
    }


    // MARK: - Encoding

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(id, forKey: .id)
        try container.encode(name, forKey: .name)
        try container.encode(releaseDate, forKey: .releaseDate)
        try container.encode(genre, forKey: .genre)
    }


    // MARK: - Enums

    private enum CodingKeys: String, CodingKey { case
        id,
        name,
        releaseDate,
        genre
    }

    
    // MARK: - Properties
    
    var id: Int
    var name: String
    var releaseDate: Date
    var genre: MovieGenre
}

Keep in mind that this is a simple example model, and that your real world model would probably contain a lot more properties, nested types etc. With an approach like the one above, the Codable approach would ended up looking a lot like the old NSCoding implementation, with the biggest difference being using enum keys instead of strings (which we could have used in the old model as well).

So clearly, this approach should be used very seldom, if ever, and only when you know exactly what you’re doing and as a conscious choice.

Instead, the correct way of solving the problem above is to make the MovieGenre model Codable as well, like this:

enum MovieGenre: String, Codable {
    
    ...
}

If you do this, you don’t have to add any additional code to Movie. Everything will work right away! I removed all additional code and my unit tests that cover encoding/decoding still worked.

Conclusion

As long as your entire model is Codable, things seem to sort themselves out. I love this new approach and can’t wait for the Swift community to embrace it.