Swift：KeyPath

Swift KeyPath 深度解析

最新推荐文章于 2025-02-14 16:36:49 发布

原创最新推荐文章于 2025-02-14 16:36:49 发布 · 2.2k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#swift

Swift 专栏收录该内容

3 篇文章

订阅专栏

本文介绍了Swift中的KeyPath，它允许开发者通过语法来获取属性值。文中通过官方示例展示了如何使用KeyPath获取实例的属性，并讨论了KeyPath与点语法的区别。此外，还澄清了KeyPath与下标访问的区别，指出KeyPath适用于类型安全的属性访问，而下标常用于字典等数据结构的访问。

Swift 中可以使用 KeyPath 来获取属性值，语法为\Type.property.property.....。

官方给出的示例：

class Animal: NSObject {
    @objc var name: String

    init(name: String) {
        self.name = name
    }
}

let llama = Animal(name: "Llama")
let nameAccessor = \Animal.name
let nameCountAccessor = \Animal.name.count

llama[keyPath: nameAccessor]
// "Llama"
llama[keyPath: nameCountAccessor]
// "5"

\Animal.name 是一个KeyPath，通过 subscript 来获取 Animal 实例的 name 属性值。

另外，一说 KeyPath，肯定就能想到 KVC、KVO，通过 #keyPath(Type.property.property.....) 来创建一个 key，就能使用 KVC 的方法 value(forKey:) 、value(forKeyPath:) 和 KVO 的方法 addObserver(_:forKeyPath:options:context:)。

官方给出示例：

class Person: NSObject {
    @objc var name: String
    @objc var friends: [Person] = []
    @objc var bestFriend: Person? = nil

    init(name: String) {
        self.name = name
    }
}

let gabrielle = Person(name: "Gabrielle")
let jim = Person(name: "Jim")
let yuanyuan = Person(name: "Yuanyuan")
gabrielle.friends = [jim, yuanyuan]
gabrielle.bestFriend = yuanyuan

#keyPath(Person.name)
// "name"
gabrielle.value(forKey: #keyPath(Person.name))
// "Gabrielle"
#keyPath(Person.bestFriend.name)
// "bestFriend.name"
gabrielle.value(forKeyPath: #keyPath(Person.bestFriend.name))
// "Yuanyuan"
#keyPath(Person.friends.name)
// "friends.name"
gabrielle.value(forKeyPath: #keyPath(Person.friends.name))
// ["Yuanyuan", "Jim"]

另外，\Animal.name 和 #keyPath(Animal.name) 是两个完全不同的东西，通过输出可以看出:

print(\Animal.name)
// Swift.ReferenceWritableKeyPath<__lldb_expr_146.Animal, Swift.String>

print(#keyPath(Animal.name))
// name

\Animal.name 用于 Swift 的下标访问，#keyPath(Animal.name) 用于 KVC、KVO。

参考 The Swift Programming Language (Swift 4)