Introducing Tiny Storage: a small, lightweight UserDefaults replacement
October 8, 2024
Following my last blog post about difficulties surrounding UserDefaults and edge cases that lead to data loss (give it a read if you haven’t, it’s an important precursor to this post!), I wanted to build something small and lightweight that would serve to fix the issues I was encountering with UserDefaults and thus TinyStorage was born! It’s open source so you can use it in your projects too if would like.
Overview
As mentioned in that blog post, UserDefaults has more and more issues as of late with returning nil data when the device is locked and iOS “prelaunches” your app, leaving me honestly sort of unable to trust what UserDefaults returns. Combined with an API that doesn’t really do a great job of surfacing whether it’s available, you can quite easily find yourself in a situation with difficult to track down bugs and data loss. This library seeks to address that fundamentally by not encrypting the backing file, allowing more reliable access to your saved data (if less secure, so don’t store sensitive data), with some niceties sprinkled on top.
This means it’s great for preferences and collections of data like bird species the user likes, but not for sensitive details. Do not store passwords/keys/tokens/secrets/diary entries/grammy’s spaghetti recipe, anything that could be considered sensitive user information, as it’s not encrypted on the disk. But don’t use UserDefaults for sensitive details either as UserDefaults data is still fully decrypted when the device is locked so long as the user has unlocked the device once after reboot. Instead use Keychain for sensitive data.
As with UserDefaults, TinyStorage is intended to be used with relatively small, non-sensitive values. Don’t store massive databases in TinyStorage as it’s not optimized for that, but it’s plenty fast for retrieving stored Codable types. As a point of reference I’d say keep it under 1 MB.
This reliable storing of small, non-sensitive data (to me) is what UserDefaults was always intended to do well, so this library attempts to realize that vision. It’s pretty simple and just a few hundred lines, far from a marvel of filesystem engineering, but just a nice little utility hopefully!
(Also to be clear, TinyStorage is not a wrapper for UserDefaults, it is a full replacement. It does not interface with the UserDefaults system in any way.)
Features
- Reliable access: even on first reboot or in application prewarming states,
TinyStoragewill read and write data properly - Read and write Swift
Codabletypes easily with the API - Similar to
UserDefaultsuses an in-memory cache on top of the disk store to increase performance - Thread-safe through an internal
DispatchQueueso you can safely read/write across threads without having to coordinate that yourself - Supports storing backing file in shared app container
- Uses
NSFileCoordinatorfor coordinating reading/writing to disk so can be used safely across multiple processes at the same time (main target and widget target, for instance) - When using across multiple processes, will automatically detect changes to file on disk and update accordingly
- SwiftUI property wrapper for easy use in a SwiftUI hierarchy (Similar to
@AppStorage) - Can subscribe to to
TinyStorage.didChangeNotificationinNotificationCenter, and includes the key that changed inuserInfo - Uses
OSLogfor logging - A function to migrate your
UserDefaultsinstance toTinyStorage
Limitations
Unlike UserDefaults, TinyStorage does not support mixed collections, so if you have a bunch of strings, dates, and integers all in the same array in UserDefaults without boxing them in a shared type, TinyStorage won’t work. Same situation with dictionaries, you can use them fine with TinyStorage but the key and value must both be a Codable type, so you can’t use [String: Any] for instance where each string key could hold a different type of value.
Installation
Simply add a Swift Package Manager dependency for https://github.com/christianselig/TinyStorage.git
Usage
First, either initialize an instance of TinyStorage or create a singleton and choose where you want the file on disk to live. To keep with UserDefaults convention I normally create a singleton for the app container:
extension TinyStorage {
static let appGroup: TinyStorage = {
let appGroupID = "group.com.christianselig.example"
let containerURL = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: appGroupID)!
return .init(insideDirectory: containerURL)
}()
}
(You can store it wherever you see fit though, in URL.documentsDirectory is also an idea for instance!)
Then, decide how you want to reference your keys, similar to UserDefaults you can use raw strings, but I recommend a more strongly-typed approach, where you simply conform a type to TinyStorageKey and return a var rawValue: String and then you can use it as a key for your storage without worrying about typos. If you’re using something like an enum, making it a String enum gives you this for free, so no extra work!
After that you can simply read/write values in and out of your TinyStorge instance:
enum AppStorageKeys: String, TinyStorageKey {
case likesIceCream
case pet
case hasBeatFirstLevel
}
// Read
let pet: Pet? = TinyStorage.appGroup.retrieve(type: Pet.self, forKey: AppStorageKeys.pet)
// Write
TinyStorage.appGroup.store(true, forKey: AppStorageKeys.likesIceCream)
(If you have some really weird type or don’t want to conform to Codable, just convert the type to Data through whichever means you prefer and store that, as Data itself is Codable.)
If you want to use it in SwiftUI and have your view automatically respond to changes for an item in your storage, you can use the @TinyStorageItem property wrapper. Simply specify your storage, the key for the item you want to access, and specify a default value.
@TinyStorageItem(key: AppStorageKey.pet, storage: .appGroup)
var pet: = Pet(name: "Boots", species: .fish, hasLegs: false)
var body: some View {
Text(pet.name)
}
You can even use Bindings to automatically read/write.
@TinyStorageItem(key: AppStorageKeys.message, storage: .appGroup)
var message: String = ""
var body: some View {
VStack {
Text("Stored Value: \(message)")
TextField("Message", text: $message)
}
}
It also addresses some of the annoyances of @AppStorage, such as not being able to store collections:
@TinyStorageItem(key: "names", storage: .appGroup)
var names: [String] = []
Or better support for optional values:
@TinyStorageItem(key: "nickname", storage: .appGroup)
var nickname: String? = nil // or "Cool Guy"
You can also migrate from a UserDefaults instance to TinyStorage with a handy helper function:
let keysToMigrate = ["favoriteIceCream", "appFontSize", "useCustomTheme", "lastFetchDate"]
TinyStorage.appGroup.migrate(userDefaults: .standard, keys: keysToMigrate, overwriteIfConflict: true)
(Read the migrate function documentation for more details.)
If you want to migrate multiple keys manually or store a bunch of things at once, rather than a bunch of single store calls you can consolidate them into one call with bulkStore which will only write to disk the once:
let item1 = TinyStorageBulkStoreItem(key: AppGroup.pet, value: pet)
let item2 = TinyStorageBulkStoreItem(key: AppGroup.theme, value: "sunset")
TinyStorage.appGroup.bulkStore(items: [item1, item2])
Hope it’s handy!
If you like it or have any feedback let me know! I’m going to start slowly integrating it into Pixel Pals and hopefully solve a few bugs in the process.
