Swift KeyPath

Swift KeyPath

swift是一门类型安全的编程语言,不像OC、Ruby等可以在运行时检查甚至改变某一种类型或者实现,swift在编译的时候,就明确一个变量的类型,但是有些时候,我们需要一些动态的特性,例如,我们不需要在乎某个对象的类型,只在乎其某些属性的类型,或者根本不需要在乎对象本身,只需要在乎其类型。swift为我们提供了这种机制KeyPath。

几种常用的KeyPath:

public class KeyPath<Root, Value> : PartialKeyPath<Root> {
}

public class WritableKeyPath<Root, Value> : KeyPath<Root, Value> {
}

public class ReferenceWritableKeyPath<Root, Value> : WritableKeyPath<Root, Value> {
}

KeyPath是一种只读的,WritableKeyPath是可读可写的,ReferenceWritableKeyPath只能作用在引用类型(class)的可读可写的KeyPath。

使用KeyPath

例如我们有一个结构体:

struct Color: CustomStringConvertible {
    var red: UInt8
    var green: UInt8
    var blue: UInt8
    var alpha: UInt8
    
    var value: Int32 {
        return Int32(red) << 3 | Int32(green) << 2 | Int32(blue) << 1 | Int32(alpha)
    }
}

之前获取属性的方式,例如获取Colorvalue属性:

let color = Color.init(red: 255, green: 255, blue: 255, alpha: 255)
print(color.value)

使用KeyPath的方式如下:

print(color[keyPath: \.value])
// or
let keyPath: KeyPath<Color, Int32> = \.value
print(color[keyPath: keyPath])

通过KeyPath获取某一个对象的属性可以使用objectName[keyPath: \.propertyName]的方式,也可以通过let keyPath: KeyPath<Color, Int32> = \.value先创建KeyPath。
如果对象和属性是可变的话,可以使用WritableKeyPath来改变属性值:

var mutColor = Color(red: 1, green: 1, blue: 1, alpha: 1)
mutColor[keyPath: \.red] = 255
let mutKeyPath: WritableKeyPath<Color, UInt8> = \.blue
mutColor[keyPath: mutKeyPath] = 255

用途

假设我们需要展示一个对象的所有数据,可以考虑使用KeyPath,传统的做法,例如展示一个Person的详细信息:

struct Person {
    var name: String
    var address: String
    var postCode: String
    var age: Int
}

之前的做法是:

func showPerson(p: Person) {
    print(p.name)
    print(p.address)
    print(p.postCode)
    print(p.age)
}
let tom = Person(...)
showPerson(p: tom)

但是这么做虽然没什么问题,只是不容易扩展,如果需要展示一辆汽车或者学生信息的话,就需要创建更多的方法。
可以使用KeyPath来构建一个新方法,该方法接受可变数量的KeyPath<Element, String>作为参数:

func showDetail<Element>(object: Element, keys: KeyPath<Element, String> ...) {
    for one in keys {
        print(object[keyPath: one])
    }
}
let p = Person.init(...)
showDetail(object: p, keys: \.name, \.postCode, \.address)

如果说某些数据不是String类型的话,可以通过为对象添加一个extension 来将某些属性转换成String

extension Person {
    var ageStr: String { return "\(self.age)" }
}
showDetail(object: p, keys: \.name, \.postCode, \.address, \.ageStr)

还有就是我们平常会用到排序,如果给你一组数据,并且需要按照数据的某个属性进行排序的话,也可以使用KeyPath来做通用方法:

extension Array {
    func sort<Value: Comparable>(ascendingKey: KeyPath<Element, Value>) -> Array<Element> {
        sorted { l, r -> Bool in
            return l[keyPath: ascendingKey] < r[keyPath: ascendingKey]
        }
    }
    
    func sort<Value: Comparable>(descendingKey: KeyPath<Element, Value>) -> Array<Element> {
        sorted { l, r -> Bool in
            return l[keyPath: descendingKey] > r[keyPath: descendingKey]
        }
    }
}

某些时候,需要把一个数组转换成字典,字典的Key是数据的某个属性:

extension Array {
    func map<Key: Hashable>(mapKey: KeyPath<Element, Key>) -> [Key: Element] {
        var result: [Key: Element] = [:]
        forEach { element in
            result[element[keyPath: mapKey]] = element
        }
        return result
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容