Apple 终于在 Swift 4 的 Foundation 的模块中添加了对 JSON 解析的原生支持。

虽然已经有很多第三方类库实现了 JSON 解析，但是能够看到这样一个功能强大、易于使用的官方实现还是不免有些兴奋。

值得注意的是，官方的实现方式适用于任何 Encoder/Decoder ，例如 PropertyListEncoder 。当然如果你需要 XML 格式的内容，可以进行自定义实现。在接下来的内容中，我们将专注于 JSON 格式的解析，因为这是 iOS 开发中最常见的数据格式。

基础

如果你的 JSON 数据结构和你使用的 Model 对象结构一致的话，那么解析过程将会非常简单。

下面是一个 JSON 格式的啤酒说明：

{
    "name": "Endeavor",
    "abv": 8.9,
    "brewery": "Saint Arnold",
    "style": "ipa"
}

对应的 Swift 数据结构如下：

enum BeerStyle : String {
    case ipa
    case stout
    case kolsch
    // ...
}
struct Beer {
    let name: String
    let brewery: String
    let style: BeerStyle
}

为了将 JSON 字符串转化为 Beer 类型的实例，我们需要将 Beer 类型标记为 Codable。

Codable 实际上是 Encodable & Decodable 两个协议的组合类型，所以如果你只需要单向转换的话，你可以只选用其中一个。该功能也是 Swift 4 中引入的最重要新特性之一。

Codable 带有默认实现，所以在大多数情形下，你可以直接使用该默认实现进行数据转换。

enum BeerStyle : String, Codable {
   // ...
}
struct Beer : Codable {
   // ...
}

下面只需要创建一个解码器：

let jsonData = jsonString.data(encoding: .utf8)!
let decoder = JSONDecoder()
let beer = try! decoder.decode(Beer.self, for: jsonData)

这样我们就将 JSON 数据成功解析为了 Beer 实例对象。因为 JSON 数据的 Key 与 Beer 中的属性名一致，所以这里不需要进行自定义操作。

需要注意的是，这里直接使用了 try! 操作。因为这里只是简单示例，所以在真实程序中你应该对错误进行捕获并作出对应的处理。

但是，现实中不可能一直都是完美情形，很大几率存在 Key 值与属性名不匹配的情形。

自定义键值名

通常情形下，API 接口设计时会采用 snake-case 的命名风格，但是这与 Swift 中的编程风格有着明显的差异。

为了实现自定义解析，我们需要先去看下 Codable 的默认实现机制。

默认情形下 Keys 是由编译器自动生成的枚举类型。该枚举遵守 CodingKey 协议并建立了属性和编码后格式之间的关系。

为了解决上面的风格差异需要对其进行自定义，实现代码：

struct Beer : Codable {
      // ...
      enum CodingKeys : String, CodingKey {
          case name
          case abv = "alcohol_by_volume"
          case brewery = "brewery_name"
          case style
    }
}

现在我们将 Beer 实例转化为 JSON ，看看自定义之后的 JSON 数据格式：

let encoder = JSONEncoder()
let data = try! encoder.encode(beer)
print(String(data: data, encoding: .utf8)!)

输出如下：

{"style":"ipa","name":"Endeavor","alcohol_by_volume":8.8999996185302734,"brewery_name":"Saint Arnold"}

上面的输出格式对阅读起来并不是太友好。不过我们可以设置 JSONEncoder 的 outputFormatting 属性来定义输出格式。

默认 outputFormatting 属性值为 .compact，输出效果如上。如果将其改为.prettyPrinted 后就能获得更好的阅读体检。

encoder.outputFormatting = .prettyPrinted

效果如下：

{
  "style" : "ipa",
  "name" : "Endeavor",
  "alcohol_by_volume" : 8.8999996185302734,
  "brewery_name" : "Saint Arnold"
}

JSONEncoder 和 JSONDecoder 其实还有很多选项可以自定义设置。其中有一个常用的需求就是自定义时间格式的解析。

时间格式处理

JSON 没有数据类型表示日期格式，因此需要客户端和服务端对序列化进行约定。通常情形下都会使用 ISO 8601 日期格式并序列化为字符串。

提示：nsdateformatter.com 是一个非常有用的网站，你可以查看各种日期格式的字符串表示，包括 ISO 8601。

其他格式可能是参考日期起的总秒（或毫秒）数，并将其序列化为 JSON 格式中的数字类型。

之前，我们必须自己处理这个问题。在数据结构中使用属性接收该字符串格式日期，然后使用 DateFormatter 将该属性转化为日期，反之亦然。

不过 JSONEncoder 和 JSONDecoder 自带了该功能。默认情况下，它们使用 .deferToDate 处理日期，如下：

struct Foo : Encodable {
    let date: Date
}
let foo = Foo(date: Date())
try! encoder.encode(foo)
{
  "date" : 519751611.12542897
}

当然，我们也可以选用 .iso8601 格式：

encoder.dateEncodingStrategy = .iso8601
{
  "date" : "2017-06-21T15:29:32Z"
}

其他日期编码格式选择如下：

  • .formatted(DateFormatter) - 当你的日期字符串是非标准格式时使用。需要提供你自己的日期格式化器实例。

  • .custom((Date, Encoder) throws -> Void ) - 当你需要真正意义上的自定义时，使用一个闭包进行实现。

  • .millisecondsSince1970、 .secondsSince1970 - 这在 API 设计中不是很常见。 由于时区信息完全不在编码表示中，所以不建议使用这样的格式，这使得人们更容易做出错误的假设。

对日期进行 Decoding 时基本上是相同的选项，但是 .custom 形式是 .custom((Decoder) throws -> Date )，所以我们给了一个解码器并将任意类型转换为日期格式。

浮点类型处理

浮点是 JSON 与 Swift 另一个存在不匹配情形的类型。如果服务器返回的事无效的 "NaN" 字符串会发生什么？无穷大或者无穷大？这些不会映射到 Swift 中的任何特定值。

默认的实现是 .throw，这意味着如果上述数值出现的话就会引发错误，不过对此我们可以自定义映射。

{
   "a": "NaN",
   "b": "+Infinity",
   "c": "-Infinity"
}
struct Numbers {
  let a: Float
  let b: Float
  let c: Float
}
decoder.nonConformingFloatDecodingStrategy =
  .convertFromString(
      positiveInfinity: "+Infinity",
      negativeInfinity: "-Infinity",
      nan: "NaN")
let numbers = try! decoder.decode(Numbers.elf, from: jsonData)
dump(numbers)

上述处理后：

__lldb_expr_71.Numbers
  - a: inf
  - b: -inf
  - c: nan

当然，我们也可以使用 JSONEncoder 的 nonConformingFloatEncodingStrategy 进行反向操作。

虽然大多数情形下上述处理不太可能出现，但是以防万一也不给过。

Data 处理

有时候服务端 API 返回的数据是 base64 编码过的字符串。

对此，我们可以在 JSONEncoder 使用以下策略：

  • .base64

  • .custom((Data, Encoder) throws -> Void)

反之，编码时可以使用：

  • .base64

  • .custom((Decoder) throws -> Data)

显然，.base64 时最常见的选项，但如果需要自定义的话可以采用 block 方式。

Wrapper Keys

通常 API 会对数据进行封装，这样顶级的 JSON 实体 始终是一个对象。

例如：

{
  "beers": [ {...} ]
}

在 Swift 中我们可以进行对应处理：

struct BeerList : Codable {
    let beers: [Beer]
}

因为键值与属性名一致，所有上面代码已经足够了。

Root Level Arrays

如果 API 作为根元素返回数组，对应解析如下所示：

let decoder = JSONDecoder()
let beers = try decoder.decode([Beer].self, from: data)

需要注意的是，我们在这里使用 Array 作为类型。只要 T 可解码，Array 就可解码。

Dealing with Object Wrapping Keys

另一个常见的场景是，返回的数组对象里的每一个元素都被包装为字典类型对象。

[
  {
    "beer" : {
      "id": "uuid12459078214",
      "name": "Endeavor",
      "abv": 8.9,
      "brewery": "Saint Arnold",
      "style": "ipa"
    }
  }
]

你可以使用上面的方法来捕获此 Key 值，但最简单的方式就是认识到该结构的可编码的实现形式。

如下：

[[String:Beer]]

或者更易于阅读的形式：

Array

与上面的 Array 类似，如果 K 和 T 是可解码 Dictionary就能解码。

let decoder = JSONDecoder()
let beers = try decoder.decode([[String:Beer]].self, from: data)
dump(beers)
 1 element
  ? 1 key/value pair
    ? (2 elements)
      - key: "beer"
      ? value: __lldb_expr_37.Beer
        - name: "Endeavor"
        - brewery: "Saint Arnold"
        - abv: 8.89999962
        - style: __lldb_expr_37.BeerStyle.ipa

更复杂的嵌套

有时候 API 的响应数据并不是那么简单。顶层元素不一定只是一个对象，而且通常情况下是多个字典结构。

例如：

{
    "meta": {
        "page": 1,
        "total_pages": 4,
        "per_page": 10,
        "total_records": 38
    },
    "breweries": [
        {
            "id": 1234,
            "name": "Saint Arnold"
        },
        {
            "id": 52892,
            "name": "Buffalo Bayou"
        }
    ]
}

在 Swift 中我们可以进行对应的嵌套定义处理：

struct PagedBreweries : Codable {
    struct Meta : Codable {
        let page: Int
        let totalPages: Int
        let perPage: Int
        let totalRecords: Int
        enum CodingKeys : String, CodingKey {
            case page
            case totalPages = "total_pages"
            case perPage = "per_page"
            case totalRecords = "total_records"
        }
    }
    struct Brewery : Codable {
        let id: Int
        let name: String
    }
    let meta: Meta
    let breweries: [Brewery]
}

该方法的最大优点就是对同一类型的对象做出不同的响应（可能在这种情况下，“brewery” 列表响应中只需要 id 和 name 属性，但是如果查看详细内容的话则需要更多属性内容）。因为该情形下 Brewery 类型是嵌套的，我们依旧可以在其他地方进行不同的 Brewery 类型实现。

结论

Swift 4 中基础 Codable API 的内容已经介绍差不多了。更多的内容可以查看 Codable.swift、Using JSON with Custom Types 。

iOS开发之Swift 4 JSON 解析指南相关推荐

  1. iOS开发之swift资料大全

    目录(?)[+] 版本:Swift github排名 https://github.com/trending,github搜索:https://github.com/search 主要工作说明:  1 ...

  2. 芒果iOS开发之Swift教程05-Swift字符串和字符

    [主要内容] 1. 字符串字面量 2. 初始化空字符串 3. 字符串可变性4. 字符串是值类型 5. 使用字符 6. 连接字符串和字符 7. 字符串差值 8. Unicode 9. 计算字符数量 10 ...

  3. IOS开发之Swift学习笔记

    1.因为存储属性要求初始化,我们可以使用lazy修饰符来延迟初始化. 转载于:https://www.cnblogs.com/luntai/p/5430223.html

  4. 芒果iOS开发之AFNetworking3.0.4使用指南

    前几天发现iOS9.xcode7之后NSURLConnection的API被弃用了,取而代之的是NSURLSession,看到这我首先想到了AFNetworking,因为工程的所有网络请求都是基于AF ...

  5. IOS开发之JSON序列化从客户端发送到服务器端

    IOS开发之JSON序列化从客户端发送到服务端的准备工作 共有6种情况 需要序列化 请查看源代码. 服务器端接受我们采用的是java的Tomcat服务器.配合 struts 2 controller框 ...

  6. IOS开发之JSON文件的读写

    IOS开发之JSON文件的读写 // // ViewController.m // 20-JSON的读写 // // Created by 鲁军 on 2021/2/13. //#import &qu ...

  7. iOS开发之Objective-C（中级篇）-李飞-专题视频课程

    iOS开发之Objective-C(中级篇)-307人已学习 课程介绍         该系列课程详细的讲解了iOS开发过程中的常用知识点及难点.在此基础上面,还扩充讲解了数据库的和H5的知识.如果能 ...

  8. iOS开发之AVKit框架使用

    2019独角兽企业重金招聘Python工程师标准>>> iOS开发之AVKit框架使用 一.引言 在iOS开发框架中,AVKit是一个非常上层,偏应用的框架,它是基于AVFounda ...

  9. iOS开发之Accounts框架详解

    2019独角兽企业重金招聘Python工程师标准>>> iOS开发之Accounts框架详解 Accounts框架是iOS原生提供的一套账户管理框架,其支持Facebook,新浪微博 ...

  10. ios开发之OC基础-类和对象

    ios开发之OC基础-类和对象 本系列的文章主要来自于个人在学习前锋教育-欧阳坚老师的iOS开发教程之OC语言教学视频所做的笔记,边看视频,边记录课程知识点.建议大家先过一遍视频,在看视频的过程中记录 ...

最新文章

  1. DT技术助力企业创新转型
  2. golang实现二叉搜索树
  3. yum与rpm的使用
  4. 【经验分享】计算机专业如何自己增加项目经验？
  5. 六自由度机器人逆向运动学_【课程笔记】Notes for Robotics/机器人学 (Part1)
  6. python类及其方法
  7. SAS在金融中的应用四
  8. 华为HCIE云计算培训笔记第一天
  9. vue项目中使用词云_如何在vue项目中使用高拍仪
  10. 电脑上的字体安装教程
  11. CTO、技术总监、首席架构师的区别
  12. 平板电脑安装软件_哪个便签可以横屏？平板电脑横屏便签软件推荐
  13. Unity快速实现回合制游戏
  14. php把字符串做为代码执行的函数eval
  15. html5 加速球 效果,css 渐隐渐现、echarts 圆环图、百度地图覆盖物、echarts水球图（360加速球效果）...
  16. beanshell断言_jmeter之beanshell断言实例
  17. nonebot2聊天机器人插件1：基础应答print
  18. Ubuntu17.04+Nvidia GT 640LE+CUDA9.0+cuDNN7.05+Tensorflow1.5r0(GPU)+Anaconda5.01(python3.6)安装
  19. Java面向对象选择题2
  20. c语言调用c 接口方法,C++调用C接口的实现示例

热门文章

  1. window 平台高性能多国语解决方案
  2. ASP.NET2.0 Person Web Site:将图片以二进制的从数据库读取
  3. K-Means原理及代码实现
  4. MySQL数据表查询操作
  5. 远程桌面连接--“发生身份验证错误。要求的函数不受支持
  6. 电话号码以185****3547显示demo
  7. sqlserver 备份脚本
  8. 如何去除快捷方式上的小箭头
  9. 浅谈javascript和java中的字符串
  10. 不要做浮躁的软件工程师——经典