Swift下面字典（json）和模型的转换

一、swift下使用OC框架

在OC下面字典和模型的转换有些非常好用的第三方框架，如（YYMode， MJExtension等），当然Swift也可以借鉴这两个框架，只是需要创建模型的时候继承自NSObject，并且加上关键字@objcMembers既可。

@objcMembers class CDBaseModel: NSObject, YYModel {
    //swift 借鉴YYModel
    var name:String = ""
    var age:Int = 0
    var uid:String = ""
    
    static func modelCustomPropertyMapper() -> [String : Any]? {
        return [
            "uid":"id",
        ]
    }
}

swift使用原生Codable 协议

1、在用原生Codable协议的时候，需要当前类继承协议Codable，只是swift的枚举、结构体和类都可以继承该协议。这点事OC无法做到的。

enum Gender:String, Decodable {
    case male
    case female
    case other
}

struct BookModel:Codable {
    
    var name:String = ""
    var price:Float = 0
    
}

class PersonModel: NSObject, Codable {
    
    var name:String = ""
    
}

2、在使用Codable协议的时候，一定要确保模型和原始json数据之间的key值的一致性。
列入有一段json字典如下（这里我用的字典）

private var dictionary:[String:Any] = [:]

        self.dictionary["name"] = "天王"
        self.dictionary["age"] = 9
        self.dictionary["sex"] = true

那么你的模型就需要如下实现(当然这是理想状态)

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
}

3、如果你的模型里面有一个字段如（name_op）并且原始json数据里面没有该值，此时你的模型如果如下。

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var name_op:    String = ""
}

那么你解析成模型的时候会失败，此时需要把不确定的值定义为可选类型。那么不管原始json数据有没有这个字段，都可以解析成功，如果没有，那么该属性为nil。

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var name_op:    String?
}

4、如果你的模型已经设计好了，但是原始json数据里面有个字段和你的字段事冲突的（如你的属性叫 nick 而原始数据为 nick_name ），那么该值是解析不成功的，如果是可选还好，至少能成功，否则就失败。
解决的办法是实现 enum CodingKeys: String, CodingKey {}这个映射关系

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var name_op:    String?
    var nick: String?
      enum CodingKeys: String, CodingKey {
        case name
        case age
        case sex
        case name_op 
        case nick = "nick_name" 
    }
}

5、如果你的模型里面带有嵌套关系，比如你的模型里面有个其他模型或者模型数组，那么只要保证嵌套的模型里面依然实现了对应的协议，和当前模型一样即可。

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var name_op:    String?
    var nick: String?
    //嵌套关系（保证嵌套模型里面同样实现了Codable协议即可）
    var animo_op:   AnimalModel?
    var books_op:   [BookModel]?

      enum CodingKeys: String, CodingKey {
        case name
        case age
        case sex
        case name_op 
        case nick = "nick_name" 
    }
}

6、如果模型里面和原始数据里面的类型不统一，那么这个解析也会以失败告终。而这种情况需要自定义一个类去适配当前属性。最常见的有（Bool和Int，Int和String）这些在后台若类型语言上是不加区分的。所以不确定到底是什么类型，如果随意定义一个那么会失败。
如下：定义了一个可能是Bool或者Int的类型

struct TIntBool:Codable { 
    var int:Int {
        didSet {
            if int == 0 { self.bool = false
            } else { self.bool = true }
        }
    } 
    var bool:Bool {
        didSet {
            if bool { self.int = 1
            } else { self.int = 0 }
        }
    } 
    //自定义解码(通过覆盖默认方法实现)
    init(from decoder: Decoder) throws {
        let singleValueContainer = try decoder.singleValueContainer()
        if let intValue = try? singleValueContainer.decode(Int.self) {
            self.int = intValue
            self.bool = (intValue != 0)
        } else if let boolValue = try? singleValueContainer.decode(Bool.self) {
            self.bool = boolValue
            if boolValue { self.int = 1
            } else { self.int = 0 }
        } else {
            self.bool = false
            self.int = 0
        }
    } 
}

下面是一个Int 或者String类型的

struct TStrInt: Codable {
    var int:Int {
        didSet {
            let stringValue = String(int)
            if  stringValue != string {
                string = stringValue
            }
        }
    } 
    var string:String {
        didSet {
            if let intValue = Int(string), intValue != int {
                int = intValue
            }
        }
    } 
    //自定义解码(通过覆盖默认方法实现)
    init(from decoder: Decoder) throws {
        let singleValueContainer = try decoder.singleValueContainer() 
        if let stringValue = try? singleValueContainer.decode(String.self)
        {
            string = stringValue
            int = Int(stringValue) ?? 0
            
        } else if let intValue = try? singleValueContainer.decode(Int.self)
        {
            int = intValue
            string = String(intValue);
        } else
        {
            int = 0
            string = ""
        }
    }
}

在设计模型的时候，如下赋值

struct UserModel:Codable {
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var name_op:    String?
    var nick: String?
    //嵌套关系（保证嵌套模型里面同样实现了Codable协议即可）
    var animo_op:   AnimalModel?
    var books_op:   [BookModel]?
  
    //数据类型不一样（如果原始数据为Int，模型里面却是String，这个需要单独定义一种数据类型这种数据类型可能是整型、浮点型、布尔型或者字符串）
    var stringInt:  TStrInt?
    var boolInt:    TIntBool?

      enum CodingKeys: String, CodingKey {
        case name
        case age
        case sex
        case name_op 
        case nick = "nick_name" 
        case  animo_op
        case  animo_op
        case  stringInt
        case boolInt
    }
}

若是完成上面几步，基本可以解决字典模型转换的巨大部分问题。贴上我设计的模型。

struct UserModel:Codable {
    
    //1、必选值（这里的声明需要和原始数据对应的类型和字段完全一样，否则解析失败）
    var name:   String = ""
    var age:    Int = 0
    var sex:    Bool = false
    var weight: Double = 0
    var height: Float = 0
    var animo:  AnimalModel = AnimalModel.init()
    var books:  [BookModel] = []
    
    //2、可选值（这里的类型一定要和原始数据一样，原始数据可以不存在，那么解析为空即可）
    var name_op:    String?
    var age_op:     Int?
    var sex_op:     Bool?
    var weight_op:  Double?
    var height_op:  Float?
    var animo_op:   AnimalModel?
    var books_op:   [BookModel]?
    
    //3、key不一样的情况（如果原始数据和模型的key不一样，那么需要实现一个协议‘CodingKeys’自定义映射关系）
    var nick:       String = ""     //对应原始数据的nick_name
    var nick_op:    String?         //对应原始数据的nick_optional
    
    //4、数据类型不一样（如果原始数据为Int，模型里面却是String，这个需要单独定义一种数据类型这种数据类型可能是整型、浮点型、布尔型或者字符串）
    var birthday:   TStrInt?
    var stringInt:  TStrInt?
    var birthday_op:TStrDou?
    var stringDou:  TStrDou?
    var boolInt:    TIntBool?
    var intBool:    TIntBool?
    
    
    //自定义key的映射关系。
    enum CodingKeys: String, CodingKey {
        case name
        case age
        case sex
        case weight
        case height
        case animo
        case books
        
        case name_op
        case age_op
        case sex_op
        case weight_op
        case height_op
        case animo_op
        case books_op
        
        case nick = "nick_name"
        case nick_op = "nick_optional"
         
        case birthday
        case stringInt
        case birthday_op
        case stringDou
        case boolInt
        case intBool
        
    }
     
}

struct AnimalModel:Codable {
    
    var name:String = ""
    
}

struct BookModel:Codable {
    
    var name:String = ""
    var price:Float = 0
    
}

以及创建的字典

    func setupData() {
        self.dictionary["name"] = "天王"
        self.dictionary["age"] = 9
        self.dictionary["sex"] = true
        self.dictionary["weight"] = 177.7
        self.dictionary["height"] = 77.7
        self.dictionary["animo"] = ["name":"小狗"]
        self.dictionary["books"] = [["name":"语文", "price":22],["name":"数学", "price":33]]
        
        self.dictionary["name_op"] = "tiangwang"
        self.dictionary["age_op"] = 11
        self.dictionary["sex_op"] = false
        self.dictionary["weight_op"] = 22.2
        self.dictionary["height_op"] = 22.2
        self.dictionary["animo_op"] = ["name":"阿毛"]
        self.dictionary["books_op"] = [["name":"社会", "price":11.5],["name":"自然", "price":11.6]]
        
        self.dictionary["nick_name"] = "这是一个昵称"
        self.dictionary["nick_optional"] = "这是可选小名"
        
        self.dictionary["birthday"] = 20000102
        self.dictionary["stringInt"] = "123"
        self.dictionary["birthday_op"] = 123456.5
        self.dictionary["stringDou"] = "321"
        self.dictionary["boolInt"] = true
        self.dictionary["intBool"] = 1
    }

三、模型转化用 JSONDecoder，由于 JSONDecoder 需要的是Data类型，所以先要将json转化为Data。

guard let data = try? JSONSerialization.data(withJSONObject: self.dictionary, options: JSONSerialization.WritingOptions.init()) else {
            print("获取JSON失败")
            return
        }
        guard let model = try? JSONDecoder.init().decode(UserModel.self, from: data)  else {
            print("model转化失败,)")
            return
        }
        print("model = \(model)")

四、为了可以通用，设计一个字典模型转化的工具类

struct CDModel {
    
    //单独的字典（json）转模型
    static public func jsonToModel<T>(type:T.Type, json:Any) -> T? where T:Codable {
        
        guard let jsonData = try? JSONSerialization.data(withJSONObject: json, options: []) else {
            return nil
        }
        guard let model = try? JSONDecoder.init().decode(type, from: jsonData) else {
            return nil
        }
        return model
    }
    
    //json数组转模型数组
    static public func jsonToModel<T>(type:T.Type, array:[[String:Any]]) -> [T]? where T:Codable {
        
        guard let jsonData = try? JSONSerialization.data(withJSONObject: array, options: []) else {
            return nil
        }
        guard let result = try? JSONDecoder.init().decode([T].self, from: jsonData) else {
            return nil
        }
        return result
    }
    
    //单个模型转json字符串
    public static func modelToJson<T>(toString model:T) -> String? where T:Encodable {

        let encoder = JSONEncoder()
        encoder.outputFormatting = .prettyPrinted
        guard let data = try? encoder.encode(model)else{
            return nil
        }
        guard let jsonStr = String(data: data, encoding: .utf8)else{
            return nil
        }
        return jsonStr
    }
    
    //单个模型转json字典
    public static func modelToJson<T>(toDictionary model:T) -> [String:Any]? where T:Encodable{

        let encoder = JSONEncoder()
        encoder.outputFormatting = .prettyPrinted
        guard let data = try? encoder.encode(model) else {
            return nil
        }
        guard let dict = try? JSONSerialization.jsonObject(with: data, options: .mutableLeaves)as? [String:Any] else {
            return nil
        }
        return dict
    }

}

使用

        guard let model = CDModel.jsonToModel(type: UserModel.self, json: self.dictionary) else {
            return
        }
        print("model = \(model)")
        
        let array = CDModel.jsonToModel(type: UserModel.self, array: [self.dictionary])
        print("array = \(array ?? [])")
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,736评论 4赞 362
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,167评论 1赞 291
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,442评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,902评论 0赞 204
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,302评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,573评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,847评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,562评论 0赞 197
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,260评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2赞 245
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,367评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,016评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2赞 274
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2赞 269