Swift开源项目ObjectMapper基本使用

最近开始研究一些swift的实用三方库,发现ObjectMapper是一个比较好用的json、模型相互转换的三方库。下面就总结一下ObjectMapper的一些基本使用

一: 创建Model

ObjectMapper中定义了一个协议Mappable,需要创建一个遵循协议的model,并实现协议中声明的两个方法

class testModel: Mappable {
    var name: String! = ""
    var age: String! = ""
    required init?(map: Map) {
    }
    func mapping(map: ObjectMapper.Map) {
        name    <- map["name"]
        age    <- map["age"]
    }
}

二: 转Model

单条数据转换

提供的有map开头的四种方法可供使用,分别是JSON、JSONObject、JSONString、JSONfile。和直接用model初始化去转的JSON、JSONString两种方法

        let dic = ["name" : "zhangsan", "age" : "22"]
        
//        字典转json字符串
        let data : Data! = try? JSONSerialization.data(withJSONObject: dic, options: []) as Data?
        let JSONString = NSString(data:data as Data,encoding: String.Encoding.utf8.rawValue)
        
//        需要传[String: Any]格式数据,也就是字典即可
        let model1 = Mapper<TestWSModel>().map(JSON: dic)
//        传Any也就是任何格式数据都可以,但是我们点进去后可以发现,如果不是[String: Any]格式,直接返回nil
        let model2 = Mapper<TestWSModel>().map(JSONObject: dic)
        let model3 = Mapper<TestWSModel>().map(JSONObject: JSONString! as String)
//        传string格式数据,也就是json字符串
        let model4 = Mapper<TestWSModel>().map(JSONString: JSONString! as String)
//        传string格式数据,也就是文件路径(这里没测试)
        let model5 = Mapper<TestWSModel>().map(JSONfile: JSONString! as String)
//        需要传[String: Any]格式数据,也就是字典即可
        let model6 = TestWSModel(JSON: dic)
//        传string格式数据,也就是json字符串
        let model7 = TestWSModel(JSONString: JSONString! as String)
        
        printLog((model1?.name ?? "") as String)
        printLog((model2?.name ?? "") as String)
        printLog((model3?.name ?? "") as String)
        printLog((model4?.name ?? "") as String)
        printLog((model6?.name ?? "") as String)
        printLog((model7?.name ?? "") as String)

输出结果:
2023-04-24 14:16:31.543: zhangsan
2023-04-24 14:16:31.556: zhangsan
2023-04-24 14:16:31.556:
2023-04-24 14:16:31.556: zhangsan
2023-04-24 14:16:31.556: zhangsan
2023-04-24 14:16:31.556: zhangsan

正常来说单条数据转换基本实现字典或者json字符串转model即可,字典转使用JSON、JSONObject都可以,json字符串转使用JSONObject不报错,但是转换结果为nil,需要使用JSONString去转。

另:这四个转换方法都对应有一个加toObject参数的转换方法

        let dic1 = ["userName" : "zhangsan", "age" : "22"]
        let dic2 = ["name" : "lisi", "age" : "23"]

        let model1 = Mapper<TestWSModel>().map(JSON: dic1, toObject: TestWSModel(JSON: dic2)!)

        printLog((model1.name ?? "") as String)
        printLog((model1.age ?? "") as String)

输出结果:
2023-04-24 14:33:17.414: lisi
2023-04-24 14:33:17.431: 22

可以发现转换后的model,name取得是dic2的值,age取得是dic1的值,也就是这个转换方法是现在dic1里面取值,如果没有对应的key则从toObject参数dic2里面取。

mapDictionary开头方法使用

let dic = ["name" : "zhangsan", "age" : "22"]
        let dic1 = ["person" : dic, "personnn" : dic,]
//        使用方法上和map开头方法大致相同,只是在要转model的字典外面再加一层,相当于把要转model的字典当value
        let model = Mapper<TestWSModel>().mapDictionary(JSON: dic1, toDictionary: ["person" : TestWSModel(JSON: dic)!])
        printLog(model["person"]?.name)

多条数据转换

提供的有mapArray开头的四种方法可供使用,分别是JSONArray、JSONObject、JSONString、JSONfile。

        let dic = ["name" : "zhangsan", "age" : "22"]
        var array: [[String : Any]] = []
        for _ in 0 ..< 100 {
            array.append(dic)
        }
        
//        数组转json字符串
        let data : Data! = try? JSONSerialization.data(withJSONObject: array, options: []) as Data?
        let JSONString = NSString(data:data as Data,encoding: String.Encoding.utf8.rawValue)
        
//        需要传[String: Any]格式的数组即可
        let array1 = Mapper<TestWSModel>().mapArray(JSONArray: array)
//        传Any也就是任何格式数据都可以,但是我们点进去后可以发现,如果不是[String: Any]格式的数组,直接返回nil
        let array2 = Mapper<TestWSModel>().mapArray(JSONObject: array)
        let array3 = Mapper<TestWSModel>().mapArray(JSONObject: JSONString! as String)
//        传string格式数据,也就是json字符串
        let array4 = Mapper<TestWSModel>().mapArray(JSONString: JSONString! as String)
//        传string格式数据,也就是文件路径(这里没测试)
        let array5 = Mapper<TestWSModel>().mapArray(JSONfile: JSONString! as String)
        
        let model1 = array1[0]
        let model2 = array2?[0]
        let model3 = array3?[0]
        let model4 = array4?[0]
  
        printLog((model1.name ?? "") as String)
        printLog((model2?.name ?? "") as String)
        printLog((model3?.name ?? "") as String)
        printLog((model4?.name ?? "") as String)

输出结果:
2023-04-24 15:47:21.870: zhangsan
2023-04-24 15:47:21.872: zhangsan
2023-04-24 15:47:21.872:
2023-04-24 15:47:21.872: zhangsan

正常来说多条数据转换基本实现数组或者json字符串转model即可,数组转使用JSONArray、JSONObject都可以,json字符串转使用JSONObject不报错,但是转换结果为nil,需要使用JSONString去转。

三: Model转出

model转字典

     let dic1 =  model?.toJSON()
     let dic2 = Mapper().toJSON(model!)

model转json字符串

      let jsonStr1 =  model?.toJSONString(prettyPrint: true)
      let jsonStr2 = Mapper().toJSONString(model!, prettyPrint: true)

model数组转字典数组

      let array1 = array.toJSON()
      let array2 = Mapper().toJSONArray(array)

四:转Model耗时

        let dic = ["name" : "zhangsan", "age" : "22"]
        var array: [[String : Any]] = []
        for _ in 0 ..< 500000 {
            array.append(dic)
        }
//        数组转json字符串
        let data : Data! = try? JSONSerialization.data(withJSONObject: array, options: []) as Data?
        let JSONString = NSString(data:data as Data,encoding: String.Encoding.utf8.rawValue)

        printLog("JSONArray数组转model开始")
//        需要传[String: Any]格式的数组即可
        let array1 = Mapper<TestWSModel>().mapArray(JSONArray: array)
        printLog("JSONArray数组转model结束")
        printLog("JSONObject数组转model开始")
        let array2 = Mapper<TestWSModel>().mapArray(JSONObject: array)
        printLog("JSONObject数组转model结束")
        printLog("json字符串转model开始")
        let array3 = Mapper<TestWSModel>().mapArray(JSONString: JSONString! as String)
        printLog("json字符串转model结束")

输出结果:
2023-04-24 15:58:13.045: JSONArray数组转model开始
2023-04-24 15:58:14.999: JSONArray数组转model结束
2023-04-24 15:58:14.999: JSONObject数组转model开始
2023-04-24 15:58:16.961: JSONObject数组转model结束
2023-04-24 15:58:16.961: json字符串转model开始
2023-04-24 15:58:20.195: json字符串转model结束

对50万条2个字段数组进行转换,直接array转model,用JSONArray和JSONObject方法耗时大概一致,都是2秒左右,用json字符串转model则需要3秒多一点。

同样50万条数据,进行不同处理后,使用JSONArray方法转换结果对比

区别 时间
2个字段,且对应value简单 2秒左右
2个字段,且对应value复杂 2.1到2.2秒左右
转换的数组为2个字段,对应模型10个字段 接近5秒
转换的数组为10个字段,对应模型2个字段 2秒左右
转换的数组为10个字段,对应模型10个字段 8.5秒左右

可以发现时间跟转换的字段的多少关系比较大,字段长度关系不大

四:初始化一个空model

将NSObject协议添加到model里面,然后添加一个init方法即可

    class TestWSModel: NSObject,Mappable 
    
    override init() {
        super.init()
    }
    
   let model1: TestWSModel? = TestWSModel()
   model1?.name = "zhangsan"

五:嵌套对象

嵌套对象为字典,两种处理方法

字典对象直接用当前model接收

class TestWSModel: NSObject,Mappable {
    
    var name: String! = ""
    var achievement: Dictionary<String, Any>! = [:]
    var chinese: String! = ""
    var maths: String! = ""
    
    
    override init() {
        super.init()
    }
    required init?(map: Map) {
    }
    
    func mapping(map: ObjectMapper.Map) {
        name    <- map["name"]
        achievement    <- map["achievement"]
        chinese    <- map["achievement.chinese"]
        maths    <- map["achievement.maths"]
    }
}
   let dic = ["name" : "zhangsan", "age" : "22", "achievement" : ["chinese" : "99", "maths" : "88"]] as [String : Any]
        //        需要传[String: Any]格式数据,也就是字典即可
        let model = Mapper<TestWSModel>().map(JSON: dic)
        printLog(model?.name)
        printLog(model?.achievement)
        printLog(model?.chinese)
        printLog(model?.maths)

输出结果:
2023-04-25 13:57:28.781: Optional("zhangsan")
2023-04-25 13:57:28.783: Optional(["chinese": "99", "maths": "88"])
2023-04-25 13:57:28.784: Optional("99")
2023-04-25 13:57:28.784: Optional("88")

字典用另外一个model接收

class TestWSModel: NSObject,Mappable {
    
    var name: String! = ""
    var achievement: achievementModel! = AchievementModel()
    
    
    override init() {
        super.init()
    }
    required init?(map: Map) {
    }
    
    func mapping(map: ObjectMapper.Map) {
        name    <- map["name"]
        achievement    <- map["achievement"]
    }
}


class AchievementModel: NSObject,Mappable {
    
    var chinese: String! = ""
    var maths: String! = ""
    
    override init() {
        super.init()
    }
    required init?(map: Map) {
    }
    
    func mapping(map: ObjectMapper.Map) {
        chinese    <- map["chinese"]
        maths    <- map["maths"]
    }
}
       let dic = ["name" : "zhangsan", "age" : "22", "achievement" : ["chinese" : "99", "maths" : "88"]] as [String : Any]
        //        需要传[String: Any]格式数据,也就是字典即可
        let model = Mapper<TestWSModel>().map(JSON: dic)
        printLog(model?.name)
        printLog(model?.achievement)
        printLog(model?.achievement.chinese)
        printLog(model?.achievement.maths)

输出结果:
2023-04-25 14:01:06.049: Optional("zhangsan")
2023-04-25 14:01:06.051: Optional(<TestSwift.AchievementModel: 0x600001fc8720>)
2023-04-25 14:01:06.051: Optional("99")
2023-04-25 14:01:06.051: Optional("88")

嵌套对象为数组

class TestWSModel: NSObject,Mappable {
    
    var name: String! = ""
    var achievement: Array<AchievementModel>! = []
    
    override init() {
        super.init()
    }
    required init?(map: Map) {
    }
    
    func mapping(map: ObjectMapper.Map) {
        name    <- map["name"]
        achievement    <- map["achievement"]
    }
}


class AchievementModel: NSObject,Mappable {
    
    var chinese: String! = ""
    var maths: String! = ""
    
    override init() {
        super.init()
    }
    required init?(map: Map) {
    }
    
    func mapping(map: ObjectMapper.Map) {
        chinese    <- map["chinese"]
        maths    <- map["maths"]
    }
}
      let dic = ["name" : "zhangsan", "age" : "22", "achievement" : [["chinese" : "99", "maths" : "88"], ["chinese" : "77", "maths" : "66"]]] as [String : Any]
        //        需要传[String: Any]格式数据,也就是字典即可
        let model = Mapper<TestWSModel>().map(JSON: dic)
        printLog(model?.name)
        printLog(model?.achievement)
        
        for achModel in model!.achievement {
            printLog(achModel.chinese)
            printLog(achModel.maths)
        }

输出结果:
2023-04-25 14:25:08.579: Optional("zhangsan")
2023-04-25 14:25:08.581: Optional([<TestSwift.AchievementModel: 0x6000005d2820>, <TestSwift.AchievementModel: 0x6000005d23d0>])
2023-04-25 14:25:08.582: Optional("99")
2023-04-25 14:25:08.582: Optional("88")
2023-04-25 14:25:08.582: Optional("77")
2023-04-25 14:25:08.582: Optional("66")

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

推荐阅读更多精彩内容