Swift Codable使用及说明

Coadble是在WWDC2017中发布的 Swift4.0 有一个有趣的新特性,CodableEncodableDecodable 两个协议的组合,写法如下:

public typealias Codable = Decodable & Encodable

Encodable 这个协议用在那些需要被编码的类型上。如果遵守了这个协议,并且这个类的所有属性都是 Encodable 的, 编译器就会自动的生成相关的实现。如果不是,或者说你需要自定义一些东西,就需要自己实现了。

Decodable这个协议跟 Encodable 相反,它表示那些能够被解档的类型。跟 Encodable 一样,编译器也会自动为你生成相关的实现,前提是所有属性都是Decodable 的.

这两个协议的实现都很简单,内部都只有一个方法

public protocol Encodable {
    func encode(to encoder: Encoder) throws
}
public protocol Decodable {
    init(from decoder: Decoder) throws
}

下面使用一个例子来展示Coadble的用法:

let json = """
    {
        "firstName": "米饭童鞋",
        "points": 200,
        "description": "A handsome boy."
    }
"""
/// 建立模型
struct Person : Codable {
  var firstName: String
  var points: Int
  var description: String
}


/// JSON 转换为Model
let decoder = JSONDecoder()
// 数组模型转化  (注意:先将json字符串转为data)
let products = try decoder.decode(Person.self, from: json.data(using:.utf8)!)

如果后台返回的JSON的数据结构比较复杂嵌套的时候,我们可以在struct 里再套一个 struct 来建立模型。

但有时后台系统使用的命名规则有可能与前端不一致,比如后台字段返回下划线命名法,而一般我们使用驼峰命名法,所以在字段映射的时候就需要修改一下,例如后台返回first_name而不是firstName。

let json = """
    {
        "first_name": "米饭童鞋",
        "points": 200,
        "description": "A handsome boy."
    }
"""

这里有两种解决:

  1. 实现CodingKey协议 进行枚举映射;
/// 只需修改模型,实现CodingKey协议
struct Person : Codable {
  var firstName: String
  var points: Int
  var description: String
  
  /// 自定义字段属性
  /// 注意 1.需要遵守Codingkey  2.每个字段都要枚举
   private enum CodingKeys: String, CodingKey {
       case name = "first_Name"
       case points 
       case description
    }
}
  1. 通过DecoderkeyDecodingStrategy属性, 将属性的值设置为convertFromSnakeCase,这样我们就不需要写额外的代码处理了,该属性是swift4.1之后推出的。
/// 只需增加一行代码
let decoder = JSONDecoder()
// 编码策略  使用从蛇形转化为大写 encode时同样也可将驼峰命名法转化为下划线
decoder.keyDecodingStrategy = .convertFromSnakeCase  
let products = try decoder.decode(Person.self, from: json.data(using:.utf8)!)

keyDecodingStrategy是一个枚举值,他还提供了自定义转化规则

 public enum KeyDecodingStrategy {
        case useDefaultKeys
        case convertFromSnakeCase
        case custom(([CodingKey]) -> CodingKey) //自定义转化规则
  }
let json = """
    {
        "First_name": "米饭童鞋",
        "Points": 200,
        "Pescription": "A handsome boy."
    }
"""

 let decoder = JSONDecoder()
// 自定义转化规则
 decoder.keyDecodingStrategy = .custom({ (keys) -> CodingKey in
             let lastKey = keys.last!
             guard lastKey.intValue == nil else { return lastKey }
             // 将首字母大写的转化为小写的
             let stringValue = lastKey.stringValue.prefix(1).lowercased()    +lastKey.stringValue.dropFirst()
             return AnyKey(stringValue: stringValue)!
  })

Swift 4 的 Codable 简化我们很多代码。对 JSON 来说, 声明对应的模型来遵守 Codable 协议,然后让编译器做剩下的事情,就完全够了。如果需要,你还可以实现这个协议的某一个部分来满足你自己的需求,甚至你还可以完全自己实现。

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

推荐阅读更多精彩内容