Swift: KVC字典转模型、runtime帮助实现归、解档

字典转模型

开发中网络请求成功,通常情况下三方(AFNetWorking / Alamofire)都会自动帮我们解析json为字典返回我们。而实际开发中我们是主张面对模型开发而非面对字典,这就需要将拿到的字典转换成我们想要的模型。OC中字典转模型有很多非常成熟的三方,如:MJExtension、JsonModel等。而在Swift中如果不是特别复杂的字典我们基本可以利用KVC直接将其转换成模型

模型一

class JYModelOne: NSObject, NSCoding {
    /// 姓名
    var name: String?
    /// 年龄
    var age: String?
    /// 爱好
    var hobby: [String]?
    /// 自定义对象
    var friend: JYModelTwo?
}

模型二

class JYModelTwo: NSObject {
    var height: String?
    var weight: String?
}

这里有两个模型,其中模型JYModelOne中有一个属性是模型二JYModelTwo类型的属性,简单实现下“模型套模型”的字典转模型(两层的嵌套在平时开发中基本够用)

class JYModelOne: NSObject, NSCoding {
    /// 姓名
    var name: String?
    /// 年龄
    var age: String?
    /// 爱好
    var hobby: [String]?
    /// 自定义对象
    var friend: JYModelTwo?
    
    init(dict: [String: Any]) {
        super.init()
        
        // KVC赋值
        setValuesForKeys(dict)
    }
    
    override func setValue(_ value: Any?, forKey key: String) {
        if key == "friend" {// 如果是自定义对象特殊处理
            if let dict = value as? [String: Any] {
                friend = JYModelTwo(dict: dict)
            }
            
        }else {// 基本数据类型直接KVC赋值
            super.setValue(value, forKey: key)
        }
    }
    
    /// 字典中有的key,但是model中没有对应的属性,在赋值的时候就会调用这个方法,空实现,不写会崩溃
    override func setValue(_ value: Any?, forUndefinedKey key: String) {}
class JYModelTwo: NSObject {
    var height: String?
    var weight: String?
    
    init(dict: [String: Any]) {
        super.init()
        
        // KVC赋值
        setValuesForKeys(dict)
    }
    
    override func setValue(_ value: Any?, forKey key: String) {
        // 基本数据类型直接KVC赋值
        super.setValue(value, forKey: key)
    }
    
    /// 字典中有的key,但是model中没有对应的属性,在赋值的时候就会调用这个方法,空实现,不写会崩溃
    override func setValue(_ value: Any?, forUndefinedKey key: String) {}
}

runtime帮助实现归、解档

说到归档其实无非就是遵守NSCoding协议,实现两个方法,倒也没什么难,但麻烦的是什么呢?如果一个对象有特别多的属性,不多说直接上代码亲自感受......

/// 登录用户信息
class CCUserinfo: NSObject, NSCoding {
    /// 用户唯一标识 uid(用户体系统一用)
    var uid: String?
    var id: String?
    /// 注册类型 1:pad app 2:虫钢网站 3:第三方注册
    var register_type: String?
    /// 用户绑定email
    var email: String?
    /// 用户虫钢用户名
    var username: String?
    /// 用户手机号
    var user_phone: String?
    /// 用户头像地址
    var head_portrait_image: String?
    /// 是否已验证手机 0:未验证 1:已验证
    var is_phone: String?
    /// 昵称
    var nickname: String?
    /// 性别 0:位置 1:男 2:女
    var gender: String?
    /// 出生年月日
    var birthday: String?
    /// 所在省份
    var province: String?
    /// 所在城市
    var city: String?
    /// 所在县
    var area: String?
    /// 用户简介
    var personal_profile: String?
    /// 用户状态
    var status: String?
    /// 校验手机时间
    var checktime: String?
    /// 注册时间
    var addtime: String?
}

通常归档写法

func encode(with aCoder: NSCoder) {
        aCoder.encode(uid, forKey: "uid")
        aCoder.encode(id, forKey: "id")
        aCoder.encode(register_type, forKey: "register_type")
        aCoder.encode(email, forKey: "email")
        aCoder.encode(username, forKey: "username")
        aCoder.encode(user_phone, forKey: "user_phone")
        aCoder.encode(head_portrait_image, forKey: "head_portrait_image")
        aCoder.encode(is_phone, forKey: "is_phone")
        aCoder.encode(nickname, forKey: "nickname")
        aCoder.encode(gender, forKey: "gender")
        aCoder.encode(birthday, forKey: "birthday")
        aCoder.encode(province, forKey: "province")
        aCoder.encode(city, forKey: "city")
        aCoder.encode(area, forKey: "area")
        aCoder.encode(personal_profile, forKey: "personal_profile")
        aCoder.encode(status, forKey: "status")
        aCoder.encode(checktime, forKey: "checktime")
        aCoder.encode(addtime, forKey: "addtime")
    }
    
    required init?(coder aDecoder: NSCoder) {
        super.init()

        uid = aDecoder.decodeObject(forKey: "uid") as? String
        id = aDecoder.decodeObject(forKey: "id") as? String
        register_type = aDecoder.decodeObject(forKey: "register_type") as? String
        email = aDecoder.decodeObject(forKey: "email") as? String
        username = aDecoder.decodeObject(forKey: "username") as? String
        user_phone = aDecoder.decodeObject(forKey: "user_phone") as? String
        head_portrait_image = aDecoder.decodeObject(forKey: "head_portrait_image") as? String
        is_phone = aDecoder.decodeObject(forKey: "is_phone") as? String
        nickname = aDecoder.decodeObject(forKey: "nickname") as? String
        gender = aDecoder.decodeObject(forKey: "gender") as? String
        birthday = aDecoder.decodeObject(forKey: "birthday") as? String
        province = aDecoder.decodeObject(forKey: "province") as? String
        city = aDecoder.decodeObject(forKey: "city") as? String
        area = aDecoder.decodeObject(forKey: "area") as? String
        personal_profile = aDecoder.decodeObject(forKey: "personal_profile") as? String
        status = aDecoder.decodeObject(forKey: "status") as? String
        checktime = aDecoder.decodeObject(forKey: "checktime") as? String
        addtime = aDecoder.decodeObject(forKey: "addtime") as? String
    }

如果有100个属性我们就要在init和encode方法中把100个属性都写到里面,以后给对象添加、删减属性,还要对应的去修改init和encode方法中的代码,麻烦且容易出错,代码看着也很臃肿。不妨考虑下runtime动态获取对象属性,再利用KVC赋值,最后进行对象归档和解档,这样方便很多,以后迭代中给对象添加、删减属性就不再考虑修改init和encode函数中代码。

    // 解档
    required init?(coder aDecoder: NSCoder) {
        super.init()
        
        // 1.动态获取对象所有成员变量
        var count: UInt32 = 0
        let propertyArray = class_copyPropertyList(JYModelOne.self, &count)
        for i in 0..<Int(count) {
            // 2.1、根据下表获取属性
            let property = propertyArray?[i]
            // 2.2、获取属性名称(c语言字符串)
            guard let cName = property_getName(property) else {
                return
            }
            
            guard let name = String(utf8String: cName) else {
                return
            }
            
            // 3、解档
            if name == "friend" {// 自定义对象特殊处理
                friend = JYModelTwo.unarchive()
                
            }else {
                let value = aDecoder.decodeObject(forKey: name)
                setValue(value, forKey: name)
            }
        }
    }
    
    // 归档
    func encode(with aCoder: NSCoder) {
        // 1.动态获取对象所有成员变量
        var count: UInt32 = 0
        let propertyArray = class_copyPropertyList(JYModelOne.self, &count)
        for i in 0..<Int(count) {
            // 2.1、根据下表获取属性
            let property = propertyArray?[i]
            // 2.2、获取属性名称(c语言字符串)
            guard let cName = property_getName(property) else {
                return
            }
            
            guard let name = String(utf8String: cName) else {
                return
            }
            
            // 3、归档
            if name == "friend" {// 自定义对象特殊处理
                if let modelTwo = self.value(forKey: name) as? JYModelTwo {
                    modelTwo.archive()
                }
                
            }else {
                let value = self.value(forKey: name)
                aCoder.encode(value, forKey: name)
            }
        }
    }

主要部分实现完成,但实际开发中如果需要将对象进行归、解档实现时建议将具体的操作封装成对应的函数开放出来,这样外部要实现归、解档只需调对应函数,而不用管什么实现逻辑,充分利用面向对象思想,谁的事情就让谁来做。

extension JYModelOne {
    /// 路径
    fileprivate class func getArchivePath() -> (String) {
        let path = NSSearchPathForDirectoriesInDomains(FileManager.SearchPathDirectory.documentDirectory, FileManager.SearchPathDomainMask.userDomainMask, true).first!
        return path + "/JYModelOne.plist"
    }
    
    /// 归档
    func archive() -> () {
        NSKeyedArchiver.archiveRootObject(self, toFile: JYModelOne.getArchivePath())
    }
    
    /// 解档
    class func unarchive() -> (JYModelOne?) {
        return NSKeyedUnarchiver.unarchiveObject(withFile: JYModelOne.getArchivePath()) as? JYModelOne
    }
    
    /// 删除归档信息
    class func remove(complete: () -> ()) -> () {
        if FileManager.default.fileExists(atPath: JYModelOne.getArchivePath()) == false {
            return
        }
        
        do {
            try FileManager.default.removeItem(atPath: JYModelOne.getArchivePath())
            
        }catch {}
        complete()
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,302评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,232评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,337评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,977评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,920评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,194评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,638评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,319评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,455评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,379评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,426评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,106评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,696评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,786评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,996评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,467评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,043评论 2 341

推荐阅读更多精彩内容