KeyPaths in Swift

KeyPaths 是啥？

KeyPaths是对实例属性的一种引用，注意是对实例的属性的引用，而不是对属性值的引用，我们可以通过KeyPaths去获得或者设置属性的值，也可以在代码中传递KeyPaths；

struct Model {
    let title: String
    let desc: String
}

let model = Model(title: "model", desc: "this is model")
let titleKeyPath = \Model.title
let title = model[keyPath: titleKeyPath]
print(title)
// model

上面的代码中我们创建的 titleKeyPath: KeyPath<Model, String> 就是KeyPath, 然后我们通过titleKeyPath获取model实例的title属性值；

上面的例子可能看不出什么，下面给大家介绍下KeyPath 的强大；

代替闭包使用

如果我们想获得所有model的title，通常我们这么做：

let models = [model, model, model]
let titles = models.map { $0.title }

在Swift5.2中后 KeyPath可以代替闭包

let titles = models.map(\.title)

是不是看着舒服了不少

同样的我们还可以做一些有意思的扩展：

extension Sequence {
    func sorted<T: Comparable>(by keyPath: KeyPath<Element, T>) -> [Element] {
        return sorted { a, b in
            return a[keyPath: keyPath] < b[keyPath: keyPath]
        }
    }
}

达到类似协议封装的效果

struct ModelCellConfigurator {
    func configure(_ cell: UITableViewCell, for model: ProtocolModel) {
        cell.textLabel?.text = model.title
        cell.detailTextLabel?.text = model.desc
    }
}

当我们给cell赋值的时候，一般如果我们想要避免直接传递Model，我们可能会创建个协议，通过协议进行数据的传递，同样的KeyPath也可以达到类似的效果;

struct CellConfigurator<Model> {
    let titleKeyPath: KeyPath<Model, String>
    let descKeyPath: KeyPath<Model, String>

    func configure(_ cell: UITableViewCell, for model: Model) {
        cell.textLabel?.text = model[keyPath: titleKeyPath]
        cell.detailTextLabel?.text = model[keyPath: descKeyPath]
    }
}

当我们调用的时候就可以这样

let config1 = CellConfigurator<Model>(titleKeyPath: \.title, descKeyPath: \.desc)
let model = Model(title: "title", desc: "this is desc")
config1.configure(UITableViewCell(), for: model)

上面的代码就是我们通过KeyPath达到和Protocol一样隐藏Model的效果，使得代码更加通用，进一步解耦；

Converting to functions

class ListViewController {
    private var items = [Item]() { didSet { render() } }

    func loadItems() {
        loader.load { [weak self] items in
            self?.items = items
        }
    }
}

上面的代码，通常我们都需要将网络获取的数据赋值给本地数据源，然后本地数据源去通知刷新UI展示数据；

这个时候为了避免循环引用[weak self]是必不可少的，我们可以通过ReferenceWritableKeyPath来更加巧妙地解决这个问题；

func setter<Object: AnyObject, Value>(for object: Object, keyPath: ReferenceWritableKeyPath<Object, Value>) -> (Value) -> Void {
    return { [weak object] value in
        object?[keyPath: keyPath] = value
    }
}

我们改写原来的代码

class ListViewController {
    private var items = [Item]() { didSet { render() } }

    func loadItems() {
        loader.load(then: setter(for: self, keyPath: \.items))
    }
}

上面就是KeyPath部分功能的演示，运用熟练后KeyPath应该会成为一个利器；

引用：

The power of key paths in Swift

Keypaths in Swift Explained