Swift-Reflection

前言

熟悉 Java 的读者可能会知道反射 (Reflection)。这是一种在运行时检测、访问或者修改类型的行为的特性。一般的静态语言类型的结构和方法的调用等都需要在编译时决定,开发者能做的很多时候只是使用控制流 (比如 if 或者 switch) 来决定做出怎样的设置或是调用哪个方法。而反射特性可以让我们有机会在运行的时候通过某些条件实时地决定调用的方法,或者甚至向某个类型动态地设置甚至加入属性及方法,是一种非常灵活和强大的语言特性。

Objective-C 中我们不太会经常提及到 “反射” 这样的词语,因为 Objective-C 的运行时比一般的反射还要灵活和强大。可能很多读者已经习以为常的像是通过字符串生成类或者 selector,并且进而生成对象或者调用方法等,其实都是反射的具体的表现。而在 Swift 中其实就算抛开 Objective-C 的运行时的部分,在纯 Swift 范畴内也存在有反射相关的一些内容,只不过相对来说功能要弱得多。

摘抄自《Swifter: 100个Swift开发必备 Tip》

需求

  • 获取类的属性列表
  • 给属性赋值

Swift 反射的实现方式

  • Mirror
  • OC runtime

方式一:Mirror

实现方式

获取属性的类型

func getTypeOfProperty (_ name: String) -> Any.Type {
    // 注意:self是实例(对象),如果是类,则无法获取其属性
    var type: Mirror = Mirror(reflecting: self)
    for child in type.children {
        if child.label! == name {
           return  type(of: child.value)
        }
    }
    while let parent = type.superclassMirror {
        for child in parent.children {
            if child.label! == name {
                return type(of: child.value)
            }
        }
        type = parent
    }
    return NSNull.Type.self
}

给属性赋值

func setObjectParams(obj: NSObject, paramsDic:[String:Any]?) {
    if let paramsDic = paramsDic {
        for (key,value) in paramsDic {
            let type = obj.getTypeOfProperty(key)
            if type == NSNull.Type.self {
                print("[\(obj)]没有[\(key)]参数")
            }else if …… {
                // ……
            }else {
                obj.setValue(value, forKey: key)
            }
        }
    }
}

特点

  • 简单(Swift 中所有的类型都实现了 _Reflectable)
  • 无法获取类型的属性,只能获取实例的属性
  • 无法获取写的有getset方法的属性

方式二:OC runtime

实现方式(部分代码)

获取属性的类型

/// 获取对象属性类型列表
/// - 注意:这种方式获取属性,对于非引用类型的属性,必须有初始值,否则无法获取到!
/// - 参考自:https://github.com/Sajjon/SwiftReflection
///
/// - parameter clazz:         对象类型
///
/// - returns: 属性名 & 类型 字典数组.
open class func propertyList(clazz: NSObject.Type) -> [[String: Any]]? {
    var count: UInt32 = 0
    let list = class_copyPropertyList(clazz, &count)
    var resultList = [[String: Any]]()
    for i in 0..<Int(count) {
        guard let pty = list?[i],
            let cName = getNameOf(property: pty),
            let name = String(utf8String: cName)
            else {
                continue
        }
        let type = getTypeOf(property: pty)
        resultList.append([name: type])
    }
    free(list)
    return resultList
}

给属性赋值

/// 给对象赋值
///
/// - parameter paramsDict:         参数字典
/// - parameter obj:                待赋值的对象
/// - parameter complete:           赋值完成的回调
open class func setParams(_ paramsDict:[String:Any]?, for obj: NSObject, complete: (()->()) = {}) {
    if let paramsDict = paramsDict {
        let clazz: NSObject.Type = type(of: obj)
        let list = propertyList(clazz: clazz) ?? []
        var filteredList = [[String: Any]]()
        let _ = paramsDict.map({ dict in
            let tmp = list.filter({ $0.keys.contains(dict.key)}).first ?? [:]
            filteredList.append(tmp)
        })
        print("================= 赋值开始 =================")
        for (key, value) in paramsDict {
            // 取出key对应的类型
            let value = "\(value)"
            let type = getType(key: key, typeDictList: filteredList)
            if InnerConst.BOOL == type {
                let toValue = value.toBool() ?? false
                obj.setValue(toValue, forKey: key)
            } else if …… {
                // ……
            } else if InnerConst.NULL == type {
                print("[\(obj)]没有[\(key)]参数")
            }
        }
        print("================= 赋值完成 =================")
        complete()
    }
}

特点

  • 功能强大,可作用于任何类或者实例
  • 比较麻烦,需要有 Objective-C 的基础
  • 无法获取没有初始化的非引用类型属性(值类型必须得初始化!)
  • 所作用的对象,必须继承自NSObject

用法(附上单元测试)

获取属性列表

func testGetPropertyList() {
    if let list = SwiftReflectionTool.propertyList(clazz: Book.self) {
        for dict in list {
            for (value, type) in dict {
                print("\(value) : \(type)")
            }
        }
    } else {
        print("未获取到任何属性!")
    }
}

给静态属性赋值(KVC)

func testSetParams4StaticProperty() {
    print("============== 哥只是条单纯的分割线 ==============")
    print("赋值前:count = \(Book.value(forKey: InnerConst.CountKey) ?? "")")
    Book.setValue(2, forKey: InnerConst.CountKey)
    print("赋值后:count = \(Book.value(forKey: InnerConst.CountKey) ?? "")")
}

给实例属性赋值

func testSetParams4InstanceProperty() {
    print("============== 哥只是条单纯的分割线 ==============")
    let paramsDict = [
        "title": "XXX从入门到放弃",
        "author": "cy",
        "numberOfPages": 250,
        "released": "20170707",
        "isSaled": true
    ] as [String : Any]
    let book = Book(title: "", author: "", numberOfPages: 0, released: Date(), isSaled: false)
    print("赋值前:")
    printProperties(obj: book)
    SwiftReflectionTool.setParams(paramsDict, for: book) { 
        print("赋值完成")
    }
    print("赋值后:")
    printProperties(obj: book)
}
// 打印属性
private func printProperties(obj: NSObject) {
    if let list = SwiftReflectionTool.propertyList(clazz: type(of: obj)) {
        for dict in list {
            for (value, _) in dict {
                print("\(value) : \(obj.value(forKey: value) ?? "")")
            }
        }
    } else {
        print("未获取到任何属性!")
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容