swift 使用Codable协议实现模型与json互转

在写项目开发中,编辑创建情况下提交数据的时候无可避免的会出现模型转换成对应的字典样式提交数据,在swift里面利用Codable协议可以很轻松的解决这个原本需要人为去一行一行代码来转化的问题。

Codable协议介绍

/// A type that can convert itself into and out of an external representation.
///
/// `Codable` is a type alias for the `Encodable` and `Decodable` protocols.
/// When you use `Codable` as a type or a generic constraint, it matches
/// any type that conforms to both protocols.


public typealias Codable = Decodable & Encodable

Codable协议是一个组合协议,包含Decodable协议(json转模型的协议)与Encodable协议(模型转json的协议),这协议struct,class,protocol,都可以使用。

简单使用

json数据字符串准备:

/// json数据
        let jsonString = """
        {
        "name":"张三",
        "ages":"23",
        "height":"170",
        "carsArray" :
            [{
            "color":"蓝色",
            "size":"180*100"
            },
            {
            "color":"红色",
            "size":"200*100"
            }]
        }
        """

数据模型代码:

/// 人的模型
struct PeopleStruct:Codable {
    var name : String
    var age :String
    var height : String
    var carsArray:[PeopleCarStruct]
    
    /// 设置不一致字段(自定义字段,模型中有的字段即使不更改这里也都要写上)
    enum CodingKeys: String,CodingKey {
        case name
        case age = "ages"
        case height
        case carsArray
    }
}
/// 人拥有的车模型
struct PeopleCarStruct:Codable {
    var color:String
    var size:String
}

json转模型代码方法设置:

/*
 * 解析json数据
 * 参数jsonStr:传入json字符串
 * 返回值: 返回结构体PeopleStruct的对象
 */
func getDecoderData(jsonStr:String) -> PeopleStruct? {
    if let jsonData = jsonStr.data(using: .utf8) {
        do {
            let dataStruct = try JSONDecoder().decode(PeopleStruct.self, from: jsonData)
            return dataStruct
        } catch {
            debugPrint("error == \(error)")
        }
    }
    return nil
}

该方法的调用及输出结果展示:

let dataModel = getDecoderData(jsonStr: jsonString)
debugPrint(dataModel!)
// debugPrint输出结果
Test123456.PeopleStruct(name: "张三", age: "23", height: "170", carsArray: [Test123456.PeopleCarStruct(color: "蓝色", size: "180*100"), Test123456.PeopleCarStruct(color: "红色", size: "200*100")])

模型转json代码方法设置

/*
 * 模型转json
 * 参数dataModel:数据模型对象
 * 返回值:返回json字符串
 */
func getJsonData(dataModel:PeopleStruct) -> String? {
    do {
        let encoder = JSONEncoder()
//        if #available(iOS 13.0, *) {
//            /// 设置json格式
//            encoder.outputFormatting = .withoutEscapingSlashes
//        } else {
//            encoder.outputFormatting = .prettyPrinted
//        }
        let data = try encoder.encode(dataModel)
        if let str = String(data: data, encoding: .utf8) {
            return str
        }
    } catch {
        debugPrint("error == \(error)")
    }
    return nil
}

模型转json方法调用及结果输出

/// 序列化模型转化json测试
if let peopleStruct = dataModel {
    let json = getJsonData(dataModel: peopleStruct) ?? ""
    debugPrint(json)
}
/// debugPrint 输出结果
"{\"ages\":\"23\",\"name\":\"张三\",\"height\":\"170\",\"carsArray\":[{\"color\":\"蓝色\",\"size\":\"180*100\"},{\"color\":\"红色\",\"size\":\"200*100\"}]}"

附言

如果需要单独使用Decodable或者Encodable协议,也是可以的,这两个协议不必成对出现,模型只要实现对应使用的协议即可,不是必须实现Codable协议。

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

推荐阅读更多精彩内容