Local Storage with UserDefaults

# CHAPTER 20

Local Storage with UserDefaults #

1. Introduction #

2. Learning Objectives #

• Understand the concept of persistent local storage.

• Write and Read basic data types using the UserDefaults API.

• Understand the specific limitations of what UserDefaults should hold.

• Utilize the @AppStorage property wrapper for instant, reactive persistence in SwiftUI.

3. The UserDefaults API (The Core Engine) #

Saving Data (Writing to disk):

// Saving a high score
UserDefaults.standard.set(500, forKey: "HighestScore")

// Saving a boolean
UserDefaults.standard.set(true, forKey: "IsProUser")

Retrieving Data (Reading from disk):

// Retrieving the score later
let savedScore = UserDefaults.standard.integer(forKey: "HighestScore")
print(savedScore) // Prints 500

*Note: If the key doesn't exist yet, integer(forKey:) safely returns 0, and bool(forKey:) safely returns false.*

4. What SHOULD you save in UserDefaults? #

• User Settings (Dark Mode, Notification preferences).

• Feature flags (Has the user completed the onboarding tutorial?).

• High scores or simple integers.

DO NOT save heavy data here!

• Do not save massive arrays of downloaded JSON.

• Do not save Images.

• Do not save highly sensitive passwords (use the iOS Keychain instead).

5. The SwiftUI Magic: @AppStorage #

import SwiftUI

struct SettingsView: View {
    // 1. We specify the "Key" we want to save it under in the database.
    // 2. We provide a default value (false) if the user has never saved anything.
    @AppStorage("isDarkModeOn") private var isDarkMode = false
    
    var body: some View {
        Form {
            // When the user toggles this, it changes the variable, redraws the UI, 
            // AND saves the new boolean to the iPhone hard drive permanently!
            Toggle("Enable Dark Mode", isOn: $isDarkMode)
        }
    }
}

6. Mini Project: Persistent Theme Settings #

import SwiftUI

struct ThemeAppView: View {
    // This is connected directly to the hard drive!
    @AppStorage("themeColor") private var selectedColorString = "Blue"
    
    // A computed property to turn the saved String into an actual SwiftUI Color!
    var themeColor: Color {
        switch selectedColorString {
        case "Red": return .red
        case "Green": return .green
        default: return .blue
        }
    }
    
    var body: some View {
        ZStack {
            themeColor.ignoresSafeArea() // The background reacts to the saved setting!
            
            VStack {
                Text("Select your Theme")
                    .font(.title)
                    .foregroundColor(.white)
                    .padding()
                
                // Changing the Picker immediately saves the new String to the hard drive!
                Picker("Theme Color", selection: $selectedColorString) {
                    Text("Blue Theme").tag("Blue")
                    Text("Red Theme").tag("Red")
                    Text("Green Theme").tag("Green")
                }
                .pickerStyle(.segmented)
                .padding()
                .background(Color.white.opacity(0.8))
                .cornerRadius(10)
            }
        }
    }
}

*If you close this app and open it a year later, the background will still be Green!*

7. Combining UserDefaults and ViewModels #

class ProfileViewModel: ObservableObject {
    @Published var score = 0
    
    init() {
        // When the brain boots up, fetch the saved score from the hard drive!
        self.score = UserDefaults.standard.integer(forKey: "UserScore")
    }
    
    func increaseScore() {
        score += 10
        // Instantly save it to the hard drive!
        UserDefaults.standard.set(score, forKey: "UserScore")
    }
}

8. Common Mistakes #

• Typo in the Key: If you save data using the key "HighScore", but later try to read it using "highScore" (lowercase 'h'), you will get 0. The keys are strictly case-sensitive Strings. A professional practice is to define all keys as static constants in a central file to prevent typos.

• Saving Structs: You cannot directly save a custom Swift struct (like User) into UserDefaults. It only accepts basic types (String, Int, Double, Bool, Data). To save a Struct, you must first encode it into JSON Data using JSONEncoder(), which is generally overkill for UserDefaults.

9. Best Practices #

• Use @AppStorage for UI Toggles: If the persistent data is purely visual (like a toggle switch or a color preference), bypass the ViewModel entirely and use @AppStorage directly in the View. It requires 90% less code and is perfectly safe.

10. Exercises #

1. 1. Write the Swift code utilizing UserDefaults.standard to save the String "JohnDoe" under the key "username".

1. 2. Create an @AppStorage variable named hasSeenOnboarding that defaults to false.

11. Coding Challenges #

12. MCQ Quiz with Answers #

13. Interview Questions #

• Q: Explain the mechanical difference between a variable wrapped in @State versus one wrapped in @AppStorage. In the context of the application lifecycle, what happens to the data when the user forcibly terminates the app from the multitasking switcher?

• Q: Why is the iOS Keychain fundamentally required for storing user passwords, rather than simply saving them as a String inside UserDefaults?

• Q: Describe how a developer might mitigate string-typo errors when managing dozens of UserDefaults keys across a massive codebase.

14. FAQs #

15. Summary #

16. Next Chapter Recommendation #