Codable protocol for encoding/decoding in Swift - Step-by-Step Execution

Concept Flow - Codable protocol for encoding/decoding

Define struct/class conforming to Codable

↓

Create instance with data

↓

Encode instance to JSON/Data

↓

Transmit or save encoded data

↓

Decode JSON/Data back to instance

↓

Use decoded instance in code

This flow shows how a Swift type that conforms to Codable can be converted to and from JSON or other formats by encoding and decoding.

Execution Sample

Swift

struct User: Codable {
    var name: String
    var age: Int
}

let user = User(name: "Anna", age: 28)
let data = try JSONEncoder().encode(user)
let decodedUser = try JSONDecoder().decode(User.self, from: data)

This code creates a User, encodes it to JSON data, then decodes it back to a User instance.

Execution Table

Step	Action	Evaluation	Result
1	Create User instance	User(name: "Anna", age: 28)	User object with name=Anna, age=28
2	Encode User to JSON	JSONEncoder().encode(user)	{"name":"Anna","age":28} (Data)
3	Decode JSON to User	JSONDecoder().decode(User.self, from: data)	User(name: "Anna", age: 28)
4	Use decoded User	Access decodedUser.name and decodedUser.age	name = "Anna", age = 28
5	End	No more steps	Process complete

💡 Encoding and decoding complete, original and decoded User match

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
user	nil	User(name: "Anna", age: 28)	User(name: "Anna", age: 28)	User(name: "Anna", age: 28)	User(name: "Anna", age: 28)
data	nil	nil	{"name":"Anna","age":28} (Data)	{"name":"Anna","age":28} (Data)	{"name":"Anna","age":28} (Data)
decodedUser	nil	nil	nil	User(name: "Anna", age: 28)	User(name: "Anna", age: 28)

Key Moments - 3 Insights

Why do we need to conform to Codable to encode/decode?

Conforming to Codable tells Swift how to convert the type to and from data formats like JSON. Without it, encoding or decoding will fail (see Step 2 and 3 in execution_table).

What happens if the JSON keys don't match the property names?

Decoding will fail or produce wrong results because Swift matches JSON keys to property names exactly. You can customize keys with CodingKeys, but here keys match (Step 3).

Is the decodedUser exactly the same as the original user?

Yes, after decoding, decodedUser has the same property values as user (Step 4), showing encoding and decoding preserved data.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'data' after Step 2?

A User(name: "Anna", age: 28)

B nil

C "{\"name\":\"Anna\",\"age\":28}" as Data

D JSONDecoder instance

💡 Hint

Check the 'data' variable value in variable_tracker after Step 2

At which step does decoding from JSON back to User happen?

A Step 1

B Step 3

C Step 2

D Step 4

💡 Hint

Look at the 'Action' column in execution_table for decoding

If the User struct did not conform to Codable, what would happen at Step 2?

A Encoding would fail with an error

B Encoding would succeed but decoding would fail

C Decoding would produce a default User

D Nothing would change

💡 Hint

Refer to key_moments about the importance of Codable conformance

Concept Snapshot

Codable protocol allows Swift types to be encoded to and decoded from formats like JSON.
Conform your struct/class to Codable.
Use JSONEncoder to encode an instance to Data.
Use JSONDecoder to decode Data back to an instance.
Property names must match JSON keys or use CodingKeys.
Encoding and decoding preserve data structure.

Full Transcript

This visual trace shows how a Swift struct named User, which conforms to Codable, is created with properties name and age. The User instance is then encoded into JSON data using JSONEncoder. This JSON data is a serialized form representing the User's properties. Next, JSONDecoder decodes this data back into a User instance. The decoded instance has the same property values as the original, demonstrating that encoding and decoding preserve the data. Variables user, data, and decodedUser change values step-by-step as shown. Key points include the need for Codable conformance to enable encoding and decoding, the importance of matching property names to JSON keys, and confirmation that the decoded object matches the original. The quiz questions test understanding of these steps and the role of Codable.

Practice

1. What is the main purpose of the Codable protocol in Swift?

easy

A. To create user interfaces quickly

B. To enable easy encoding and decoding of data to formats like JSON

C. To manage memory automatically

D. To handle network requests

Solution

1. Step 1: Understand Codable's role

   The Codable protocol allows Swift types to be encoded to and decoded from external representations like JSON.

2. Step 2: Compare with other options

   Options B, C, and D relate to UI, memory, and networking, which are unrelated to Codable.

3. Final Answer:

   To enable easy encoding and decoding of data to formats like JSON -> Option B

4. Quick Check:

   Codable = encoding/decoding data [OK]

Hint: Codable means convert data to/from JSON easily [OK]

Common Mistakes:

• Confusing Codable with UI or networking protocols
• Thinking Codable manages memory
• Assuming Codable is for database operations

2. Which of the following is the correct way to declare a struct that supports encoding and decoding using Codable?

easy

A. struct User: Codable { var name: String; var age: Int }

B. struct User { var name: String; var age: Int }

C. struct User: Encodable { var name: String; var age: Int }

D. struct User: Decodable { var name: String; var age: Int }

Solution

1. Step 1: Check Codable conformance

   To support both encoding and decoding, the struct must conform to Codable, which combines Encodable and Decodable.

2. Step 2: Analyze options

   struct User: Codable { var name: String; var age: Int } correctly uses : Codable. Options C and D only support encoding or decoding, not both. struct User { var name: String; var age: Int } has no conformance.

3. Final Answer:

   struct User: Codable { var name: String; var age: Int } -> Option A

4. Quick Check:

   Use Codable to encode and decode both ways [OK]

Hint: Use Codable to encode and decode both ways [OK]

Common Mistakes:

• Using only Encodable or Decodable when both needed
• Forgetting to add Codable conformance
• Declaring struct without protocol conformance

3. Given the following code, what will be printed?

struct Person: Codable {
    var name: String
    var age: Int
}

let jsonData = "{\"name\": \"Anna\", \"age\": 30}".data(using: .utf8)!
let decoder = JSONDecoder()
if let person = try? decoder.decode(Person.self, from: jsonData) {
    print(person.name)
} else {
    print("Failed to decode")
}

medium

A. Anna

B. Failed to decode

C. 30

D. nil

Solution

1. Step 1: Decode JSON string to Person

   The JSON string matches the Person struct keys and types, so decoding succeeds.

2. Step 2: Print the name property

   Since decoding succeeds, person.name is "Anna", which is printed.

3. Final Answer:

   Anna -> Option A

4. Quick Check:

   Decoded name = Anna [OK]

Hint: Match JSON keys exactly to struct properties [OK]

Common Mistakes:

• Mismatching JSON keys and struct properties
• Not unwrapping optional data safely
• Confusing print output with age value

4. What is wrong with this code snippet that tries to decode JSON into a struct conforming to Codable?

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

let json = "{\"id\": 101, \"title\": \"Book\"}"
let data = json.data(using: .utf8)!
let decoder = JSONDecoder()
let product = try? decoder.decode(Product.self, from: data)

medium

A. The JSON string is not valid JSON

B. The struct does not conform to Codable

C. The JSON key "title" does not match the struct property "name"

D. The decoder is not initialized properly

Solution

1. Step 1: Compare JSON keys with struct properties

   The JSON has key "title" but the struct expects "name"; this mismatch causes decoding to fail.

2. Step 2: Check other code parts

   The struct conforms to Codable, JSON is valid, and decoder is correctly initialized, so no issues there.

3. Final Answer:

   The JSON key "title" does not match the struct property "name" -> Option C

4. Quick Check:

   JSON keys must match struct properties exactly [OK]

Hint: JSON keys must match struct property names exactly [OK]

Common Mistakes:

• Ignoring key name mismatches
• Assuming decoder setup causes error
• Not validating JSON format

5. You want to encode a struct with an optional property that should be omitted from the JSON if it is nil. Which approach using Codable is correct?

hard

A. Declare the property as optional and use JSONEncoder's default behavior

B. Use Decodable instead of Codable

C. Make the property non-optional and assign a default value

D. Use a custom encode(to:) method to skip encoding nil properties

Solution

1. Step 1: Understand default Codable behavior

   By default, JSONEncoder encodes optional properties as null if nil, not omitting them.

2. Step 2: Use custom encoding to omit nil

   To omit nil optional properties, implement a custom encode(to:) method and encode only non-nil values.

3. Step 3: Evaluate other options

   Declare the property as optional and use JSONEncoder's default behavior keeps nulls, C changes property type, B is unrelated to encoding.

4. Final Answer:

   Use a custom encode(to:) method to skip encoding nil properties -> Option D

5. Quick Check:

   Custom encode(to:) omits nil optionals [OK]

Hint: Custom encode(to:) skips nil optionals in JSON [OK]

Common Mistakes:

• Expecting default encoder to omit nil optionals
• Making optional properties non-optional unnecessarily
• Confusing Decodable with encoding behavior