Swift version: 5.6
Key-value observing is the ability for Swift to attach code to variables, so that whenever the variable is changed the code runs. It’s similar to property observers (willSet
and didSet
), except KVO is for adding observers outside of the type definition.
KVO isn’t terribly nice in pure Swift code, because it relies on the Objective-C runtime – you need to use @objc
classes that inherit from NSObject
, then mark each of your properties with @objc dynamic
.
For example, we could create a Person
class like this:
@objc class Person: NSObject {
@objc dynamic var name = "Taylor Swift"
}
let taylor = Person()
You could then observe that user’s name changing like this:
taylor.observe(\Person.name, options: .new) { person, change in
print("I'm now called \(person.name)")
}
That asks Swift to watch for new values coming in, then prints the person’s name as soon as the new value is set.
To try it out, just change the person’s name to something else:
taylor.name = "Justin Bieber"
That will print “I’m now called Justin Bieber.”
Although KVO is unpleasant in pure Swift code, it’s better when working with Apple’s own APIs – they are all automatically both @objc
and dynamic
because they are written in Objective-C.
However, one warning: even though large parts of UIKit might work with KVO, this is a coincidence rather than a promise – Apple make no guarantees about UIKit remaining KVO-compatible in the future.
SAVE 50% To celebrate WWDC23, all our books and bundles are half price, so you can take your Swift knowledge further without spending big! Get the Swift Power Pack to build your iOS career faster, get the Swift Platform Pack to builds apps for macOS, watchOS, and beyond, or get the Swift Plus Pack to learn advanced design patterns, testing skills, and more.
Available from iOS 8.0 – learn more in my book Swift Design Patterns
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
Link copied to your pasteboard.