Скачать или смотреть How to Set Default Values for Missing Keys in Swift's JSONDecoder

Learn how to manage missing keys in Swift's JSONDecoder and ensure your models have default values. Follow these steps to simplify your remote configuration file parsing.
---
This video is based on the question https://stackoverflow.com/q/70137249/ asked by the user 'user2161301' ( https://stackoverflow.com/u/2161301/ ) and on the answer https://stackoverflow.com/a/70137763/ provided by the user 'Christos Koninis' ( https://stackoverflow.com/u/2894790/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Swift JSONDecoder replace all missing keys by default value?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Handling Missing Keys in Swift's JSONDecoder

As developers, we often work with external data sources such as JSON files to manage application settings or configuration. A common pitfall arises when certain keys in the JSON file are missing but are defined in our model. In such cases, Swift's JSONDecoder throws an error, disrupting the decoding process. In this guide, we'll explore an effective solution for setting default values for missing keys using a custom initializer in Swift's Codable structs.

The Problem at Hand

Imagine you are building a feature that relies on a remote configuration file, perhaps for staged feature releases or seasonal updates. While using a JSON file simplifies data management compared to plain text files, it poses a challenge if certain keys are missing. Your model structure might look like this:

[[See Video to Reveal this Text or Code Snippet]]

However, when you attempt to decode a JSON object that omits notIncludedC, such as:

[[See Video to Reveal this Text or Code Snippet]]

The JSONDecoder fails with an error, disrupting your application and leaving you with no value for notIncludedC. You want to skip over these unknown keys while maintaining default values for those that are defined in your struct.

A Viable Solution: Custom Initializer

To tackle this issue, you’ll need to define a custom initializer in your Codable struct that allows you to handle missing keys gracefully. Here's how you can modify DefaultConfiguration to include this initializer:

[[See Video to Reveal this Text or Code Snippet]]

Breakdown of the Custom Initializer

Define Coding Keys: The CodingKeys enum maps your struct properties, ensuring proper decoding using the expected JSON keys.

Decoder Container: Use try decoder.container(keyedBy:) to create a container that can access the keys defined by your enum.

Decode Values: Attempt to decode version and includedB normally, assuming they will be present in the JSON.

Handle Optional Keys: For notIncludedC, use decodeIfPresent. If this key is missing, the fallback value is provided, maintaining the integrity of your data:

[[See Video to Reveal this Text or Code Snippet]]

Benefits of This Approach

Simplified Error Handling: Automatically sidesteps the need to deal with errors thrown by missing keys.

Cleaner Code: Reduces the boilerplate needed for larger or more complex JSON responses.

Decoupling from JSON Structure: Your code logic is less dependent on the JSON structure changing since default values are preserved.

Conclusion

By implementing a custom initializer as shown above, you can efficiently manage missing keys in Swift's JSONDecoder, thus ensuring your application continues to function smoothly even in varying data scenarios. This approach greatly enhances your app's reliability, particularly when handling remote configuration files.

Feel free to reach out in the comments if you have any questions or further tips on managing JSON in Swift!