您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 使用技巧 >> iOS 7 技巧

Swift 反射(Reflection)完全指南:用 Mirror 走訪屬性,並比較 KVC 應用

編輯:iOS 7 技巧

寫過 C# 或 Java 的人對「反射」應該不陌生。簡單說,反射就是讓程式在執行期而非編譯期,動態取得型別與成員資訊,並據此呼叫方法或存取屬性。本文把 Swift 的反射機制與 KVC 一起整理清楚。

一、什麼是反射

Java 世界裡的兩個知名框架就是活教材:Hibernate 的屬性映射靠反射完成賦值,Spring 建立 Bean 時則依設定檔中的 class 名稱反射出實體。共同點是——程式在編譯當下並不知道型別,一切都是執行期才決定。

二、Objective-C 的 Runtime

用 ObjC 開發時反而很少提「反射」這個詞,因為它的 Runtime 比其他語言的反射機制強大得多:字串轉型別(NSClassFromString())、動態呼叫方法(performSelector:withObject:)、動態賦值(KVC)全都輕鬆寫成。

三、Swift 的反射:Mirror

Swift 並不鼓勵直接玩 Runtime,而是提供了一套名為 Mirror 的 struct 來做反射。老實說,它的能力目前還不及 ObjC 的 Runtime,跟 Java 的反射也有段距離,但足以應付「走訪屬性」這類常見需求。Mirror 主要的成員有:

let children: Children                  // 物件的子節點
displayStyle: Mirror.DisplayStyle?      // 物件的展示風格
let subjectType: Any.Type               // 物件的型別
func superclassMirror() -> Mirror?      // 父類的 mirror

四、範例一:列出物件的型別與所有屬性

先定義一個使用者類別:

// 用戶類
class User {
    var name: String = ""       // 姓名
    var nickname: String?       // 暱稱
    var age: Int?               // 年齡
    var emails: [String]?       // 郵件地址
}

再用 Mirror(reflecting:) 包裝物件,就能取出型別、屬性個數與每一組「屬性名/屬性值」:

// 建立 User 實例
let user1 = User()
user1.name = "hangge"
user1.age = 100
user1.emails = ["hangge@hangge.com", "system@hangge.com"]

// 進行反射
let hMirror = Mirror(reflecting: user1)

print("對象類型:\(hMirror.subjectType)")
print("對象子元素個數:\(hMirror.children.count)")

print("--- 對象子元素的屬性名和屬性值分別如下 ---")
for case let (label?, value) in hMirror.children {
    print("屬性:\(label)     值:\(value)")
}

主控台輸出如下:

五、範例二:用屬性名字串取值並判斷型別

這段更接近實用場景。先準備兩個工具函式:getValueByKey 依屬性名取回值,unwrap 負責把 Optional 拆包(非可選型別則原樣回傳)。

// 依屬性名字串取得屬性值
func getValueByKey(obj: AnyObject, key: String) -> Any {
    let hMirror = Mirror(reflecting: obj)
    for case let (label?, value) in hMirror.children {
        if label == key {
            return unwrap(value)
        }
    }
    return NSNull()
}

// 將可選類型(Optional)拆包
func unwrap(any: Any) -> Any {
    let mi = Mirror(reflecting: any)
    if mi.displayStyle != .Optional {
        return any
    }
    if mi.children.count == 0 { return any }
    let (_, some) = mi.children.first!
    return some
}

實測時,除了存在的屬性,故意傳入一個不存在的 tel,就能看到 NSNull() 的 fallback 生效:

let user1 = User()
user1.name = "hangge"
user1.age = 100
user1.emails = ["hangge@hangge.com", "system@hangge.com"]

let name = getValueByKey(user1, key: "name")
let nickname = getValueByKey(user1, key: "nickname")
let age = getValueByKey(user1, key: "age")
let emails = getValueByKey(user1, key: "emails")
let tel = getValueByKey(user1, key: "tel")
print(name, nickname, age, emails, tel)

// 對取到的值進行型別判斷
if name is NSNull {
    print("name 這個屬性不存在")
} else if (name as? AnyObject) == nil {
    print("name 這個屬性是個可選類型,且為 nil")
} else if name is String {
    print("name 這個屬性 String 類型,其值為:\(name)")
}

if nickname is NSNull {
    print("nickname 這個屬性不存在")
} else if (nickname as? AnyObject) == nil {
    print("nickname 這個屬性是個可選類型,且為 nil")
} else if nickname is String {
    print("nickname 這個屬性 String 類型,其值為:\(nickname)")
}

if tel is NSNull {
    print("tel 這個屬性不存在")
} else if (tel as? AnyObject) == nil {
    print("tel 這個屬性是個可選類型,且為 nil")
} else if tel is String {
    print("tel 這個屬性 String 類型,其值為:\(tel)")
}

執行結果:

附:用 KVC 存取屬性值

KVC 是 Key-Value Coding 的縮寫,本質上是依賴 Objective-C Runtime 的動態能力來「間接」存取物件。在 Swift 中,只要類別繼承 NSObject 就能使用。key 就是屬性名稱的字串,取回的 value 是任意型別,需要自己轉換。

要特別注意:由於 KVC 建立在 ObjC 之上,它無法處理 Optional 屬性,例如上面的 var age: Int? 就會出問題,因此使用者類別要改成這樣:

// 用戶類
class User: NSObject {
    var name: String = ""       // 姓名
    var nickname: String?       // 暱稱
    var age: Int = 0            // 年齡(改為非可選)
    var emails: [String]?       // 郵件地址
}

(1)依 key 取值:

let user1 = User()
user1.name = "hangge"
user1.age = 100
user1.emails = ["hangge@hangge.com", "system@hangge.com"]

// 使用 KVC 取值
let name = user1.valueForKey("name")
let nickname = user1.valueForKey("nickname")
let age = user1.valueForKey("age")
let emails = user1.valueForKey("emails")
print(name, nickname, age, emails)

if name == nil {
    print("name 這個屬性是個可選類型,且為 nil")
} else if name is String {
    print("name 這個屬性 String 類型,其值為:\(name)")
}

if nickname == nil {
    print("nickname 這個屬性是個可選類型,且為 nil")
} else if nickname is String {
    print("nickname 這個屬性 String 類型,其值為:\(nickname)")
}

(2)依 key 賦值:

let user1 = User()

// 使用 KVC 賦值
user1.setValue("hangge", forKey: "name")
user1.setValue(100, forKey: "age")
user1.setValue(["hangge@hangge.com", "system@hangge.com"], forKey: "emails")

print(user1.name, user1.nickname, user1.age, user1.emails)

Mirror 與 KVC 該怎麼選

如果只是想讀取屬性清單、做除錯輸出或輕量的資料列舉,Mirror 就夠了,它純 Swift、型別安全,也不要求繼承 NSObject。若需要「寫入」屬性,或者要串接既有的 ObjC 生態(例如 KVO 觀察、序列化框架),那就得靠 KVC。順帶一提,KVO 是建在 KVC 之上的機制,有興趣可以再往下研究。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved