How to load and save a struct in UserDefaults using Codable

Swift version: 5.0

Paul Hudson    @twostraws    March 28th 2019

The Codable protocol makes it easy to load and save native Swift types to JSON, and with a little typecasting you can get that data into UserDefaults so it’s safe.

Here’s some trivial Codable data we can work with:

struct Person: Codable {
    var name: String
}

let taylor = Person(name: "Taylor Swift")

To save that to UserDefaults you must first encode it as JSON using JSONEncoder, which will send back a Data instance you can send straight to UserDefaults. For example:

let encoder = JSONEncoder()
if let encoded = try? encoder.encode(taylor) {
    let defaults = UserDefaults.standard
    defaults.set(encoded, forKey: "SavedPerson")
}

Reading saved data back into a Person instance is a matter of converting from Data using a JSONDecoder, like this:

if let savedPerson = defaults.object(forKey: "SavedPerson") as? Data {
    let decoder = JSONDecoder()
    if let loadedPerson = try? decoder.decode(Person.self, from: savedPerson) {
        print(loadedPerson.name)
    }
}

Available from iOS 8.0 – learn more in my book Swift Design Patterns

Did this solution work for you? Please pass it on!

Tweet

Other people are reading…

• How to run an external program using Process
• How to stop the screen from going to sleep
• How to run code at a specific time
• How to make the device vibrate
• How to parse JSON using JSONSerialization

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.