Swift 与 JSON 数据

我们大家平时在开发 App 的时候，相信接触最多的就是 JSON 数据了。只要你的 App 有读取网络数据的功能，你就免不了要与 JSON 打交道。比如你做一个新闻 App，你要读取和解析新闻数据，这样才能显示给用户。

那么我们今天就来了解一下 JSON 以及它在 App 中的应用吧。

在前两节我们会介绍 JSON 数据格式，如果您已经对 JSON 比较了解了，那么也可以跳过前两节，继续阅读后面的内容。

什么是 JSON

首先，JSON 的全称叫做 JavaScript Object Notation ，翻译成中文就是 JavaScript 对象表示法，是一种轻量级的数据交互格式。

JSON 数据分为三种形式，对象，数组，值。

对象是一个无序的“‘名称/值’对”集合。一个对象以“{”（左括号）开始，“}”（右括号）结束。每个“名称”后跟一个“:”（冒号）；“‘名称/值’ 对”之间使用“,”（逗号）分隔。

数组是值（value）的有序集合。一个数组以“[”（左中括号）开始，“]”（右中括号）结束。值之间使用“,”（逗号）分隔。

值（value）可以是双引号括起来的字符串（string）、数值(number)、true、false、 null、对象（object）或者数组（array）。这些结构可以嵌套。

下面是一个简单的例子:

{
  "firstname": "San",
  "lastname" : "Zhang",
  "age": 21,
  "friends": ["Mark","Li"]
}

上面的数据示例，表示了这样一个结构，首先我们的数据被一对大括号包围，那么我们的数据就是 对象 类型，然后它里面有四个属性，firstname,lastname,age,friends。 其中前两个属性 firstname 和 lastname 字符串类型，他们的值分别是 San 和 Zhang。 age 属性代表年龄，所以它的值一个 Number 类型的 21。

注意一下，字符串类型和数字类型的区别，字符串类型的值用一对双引号括了起来，而数值类型不需要双引号。

最后，friends 属性的值是一个数组，用一对中括号包围起来，而数组中的元素，仍然是字符串类型。

以上就是 JSON 的一个基本结构，关于 JSON 更详细的介绍，可以参看 json.org

JSON 数据实例

我们看完了 JSON 的格式之后，那么我们就接着看一下具体的 JSON 数据是怎样的格式呢？

比如这个天气数据接口： http://api.openweathermap.org/data/2.5/weather?q=China,bj&lang=zh_cn

如果我们在浏览器打开这个地址，我们就可以看到类似这样的数据：

{
  "coord": {
    "lon": 116.4,
    "lat": 39.91
  },
  "weather": [
    {
      "id": 520,
      "main": "Rain",
      "description": "阵雨",
      "icon": "09d"
    },
    {
      "id": 701,
      "main": "Mist",
      "description": "薄雾",
      "icon": "50d"
    }
  ],
  "base": "stations",
  "main": {
    "temp": 300.39,
    "pressure": 1008,
    "humidity": 94,
    "temp_min": 297.15,
    "temp_max": 303.71
  },
  "visibility": 2300,
  "wind": {
    "speed": 1,
    "deg": 140
  },
  "clouds": {
    "all": 75
  },
  "dt": 1437281131,
  "sys": {
    "type": 1,
    "id": 7405,
    "message": 0.0136,
    "country": "CN",
    "sunrise": 1437253268,
    "sunset": 1437305986
  },
  "id": 1816670,
  "name": "Beijing",
  "cod": 200
}

我们来简单看一下，数据整体使用一对大括号包围的，也就是说返回给我们的数据，是一个 JSON 对象 紧接着，这个对象包含了 coord 属性，这个属性的值又是一个对象，里面有两个属性 ‘lon‘ 和 ‘lat‘ 代表地理位置，后面还有很多其他属性代表天气的数据。

JSON 数据格式，可以很结构化的表示出天气的信息。而且数据结构一目了然，非常的清晰。并且有很多在线工具可以帮助大家更好的编辑和查看 JSON 数据。
比如 http://www.jsoneditoronline.org

Swift 中处理 JSON 数据

我们在了解过 JSON 数据后，就继续我们的主题吧。

使用 NSJSONSerialization

Swift 中处理 JSON 数据方式有很多种。首先，由于 Swift 可以引用 Cocoa 原生库，所以我们可以用 Cocoa 中的 NSJSONSerialization 来处理 JSON 数据，这个类也很好理解，它会将 JSON 数据，转换成 Cocoa 中的 NSDictionary 和 NSArray。我们来看一下如何用 NSJSONSerialization 来处理：

let APIURL = "http://api.openweathermap.org/data/2.5/weather?q=China,bj&lang=zh_cn"

if let url = NSURL(string: APIURL) {

    if let jsonData = NSData(contentsOfURL: url) {

        if let jsonObj:NSDictionary = NSJSONSerialization.JSONObjectWithData(jsonData, options: NSJSONReadingOptions.allZeros, error: nil) as? NSDictionary{

            if let weathers:NSArray = jsonObj["weather"] as? NSArray {

                var weatherSummary = "北京天气情况："

                for weather in weathers {

                    if let desc:String = weather["description"] as? String {

                      weatherSummary += desc + " "

                    }

                }

                print(weatherSummary)

            }

        }

    }

}

让我们来逐个讲解。

1. 首先，我们通过 let url = NSURL(string: APIURL) 来讲天气接口包装成 NSURL。
2. 然后，我们使用 let jsonData = NSData(contentsOfURL: url) 将这个 URL 的内容读取下载，存放到 NSData 中。

3. 接下来，我们就要使用 NSJSONSerialization 将这些数据解析成 JSON 了。
   let jsonObj:NSDictionary = NSJSONSerialization.JSONObjectWithData(jsonData, options: NSJSONReadingOptions.allZeros, error: nil) as? NSDictionary
   这里我们 JSONObjectWithData 方法将传入的 NSData 数据解析成 JSON 对象，如果我们的 JSON 根节点是以对象形式存放的，那么我们得到的就是一个 NSDictionary。而如果是以数组形式存放的，那么我们得到的就是一个 NSArray 了。后面还有两个参数 options 代表 JSON 读取选项，这个我们稍后会讲到，error 参数表示 JSON 读取中的错误，如果传入 nil 表示不接受错误消息。

4. 我们得到了解析出来的 JSON 后，我们就可以像访问普通集合对象那样得到里面的信息了：

if let weathers:NSArray = jsonObj["weather"] as? NSArray {

    var weatherSummary = "北京天气情况："

    for weather in weathers {

        if let desc:String = weather["description"] as? String {

          weatherSummary += desc + " "

        }

    }

    print(weatherSummary)

}

我们这里将天气情况读取出来，并打印到屏幕上，以我们上面的数据为例，打印到屏幕上就是这个样子：

北京天气情况：阵雨 薄雾

NSJSONSerialization 的读取选项

就在刚刚，我们使用 NSJSONSerialization 成功的解析了 JSON 数据，觉得用起来很爽吧。仔细回想一下，我们刚才还注意到有一个 options 参数我们没有详细介绍。这个我们可以把它叫做读取选项，这个参数的类型是 NSJSONReadingOptions，它的取值可以是以下几种：

1. MutableContainers: 让返回的 JSON 数据中的数组和字典是可更改的。
2. AllowFragments: 允许 JSON 返回的数据有多个根节点。
3. MutableLeaves: 使 JSON 返回的字符串是可更改的。

相信部分胆大心细的朋友会发现。。。

我靠，这说的都是什么那，我还是不明白!

所以。。客官莫急，听我一一道来。

• MutableContainers

首先，MutableContainers 这个选项就让返回的 JSON 集合可更改，让我们来看一个例子就一目了然了：

var jsonString:NSString = "{\"names\":[\"James\",\"Jobs\",\"Tom\"]}" as NSString
let jsonData = jsonString.dataUsingEncoding(NSUTF8StringEncoding)

if let jsonObj:NSDictionary = NSJSONSerialization.JSONObjectWithData(jsonData!, options: NSJSONReadingOptions.MutableContainers, error: nil) as? NSDictionary {

    //操作之前
    print(jsonObj) //James, Jobs, Tom

    if let nameArray:NSMutableArray = jsonObj["names"] as? NSMutableArray {

        nameArray.addObject("Cook")

    }

    //操作之后
    print(jsonObj) //James, Jobs, Tom, Cook

}

我们看一下吧，上面的代码，我们在 JSONObjectWithData 方法调用的时候，加入了 NSJSONReadingOptions.MutableContainers 读取参数, 这样一来我们就可以更改我们的结果集了，我们注意到上面的这段代码：

if let nameArray:NSMutableArray = jsonObj["names"] as? NSMutableArray {

       nameArray.addObject("Cook")

}

取得 names 数组，并在里面增加一个新的项。随后我们再次打印 jsonObj 对象，这次显示的结果就是我们更改过的了。

如果我们在调用 JSONObjectWithData 方法的时候将 NSJSONReadingOptions.MutableContainers 选项去掉的话，我们就不能更改这里面任何数组的元素了。

第一个选项 MutableContainers 我们看完啦。 我们继续

• AllowFragments

还有另外一个选项参数，就是 AllowFragments 这个参数的官方解释是允许被解析的 JSON 数据的根层级，不是数组和对象。

额。。 听起来怪怪的不好理解是吧。

这个选项确实容易引起歧义，包括他的名称 AllowFragments,翻译成中文叫允许碎片, 什么叫允许碎片呢，我再自己实践研究过这个之前我一直是这么认为的。。。

AllowFragments 的意思，是不是可以解析这样的 JSON？

{"name":"Jobs"},{"name":"Ive"}

一段时间以来我的思维里是这么想的。可惜完全不是那么回事儿，如果你将这样的 JSON 数据传给 JSONObjectWithData 方法，你将得到一个无情的解析错误。。。

那么，这东西到底是干什么用的呀~

其实官方文档上面说的清清楚楚，可以让跟节点不是对象或者数组。在 JSON 中只有三种类型，对象，数组，值。

其实说白了就是这样，允许你的 JSON 数据是一个字面值，比如字符串，数字，等等。

比如我们可以传入一个原始的字符串

"something wrong about api"

这种数据，如果你打开了 AllowFragments， 是完全可以正常解析的（注意两边的双引号，这个也包含在返回的数据中）。而如果你没有打开这个选项，对于这种数据就会解析失败了。

var jsonFragmentString = "\"something wrong about api\"" as NSString

let jsonFragmentData = jsonFragmentString.dataUsingEncoding(NSUTF8StringEncoding)

if let jsonObj: AnyObject = NSJSONSerialization.JSONObjectWithData(jsonFragmentData!, options: .AllowFragments, error: nil) {

    //使用 AllowFragments 选项，解析成功。
    print(jsonObj)

}

看完上面的代码，相信大家瞬间就明白了，原来这家伙是做这个用的。

• ** MutableLeaves **
  MutableLeaves 选项，这个选项让我一直百思不得其解，文档上说，使用了这个选项后，所有对象的叶子节点的字符串属性，都会变成 NSMutableString，而我试遍多种文档，也未验证出来，得到的字符串依然是 NSString 而不是 NSMutableString。

使用 NSJSONSerialization 创建 JSON 数据

刚才我们了解到如何用 NSJSONSerialization 来解析数据。同样的，我们还可以使用 NSJSONSerialization 来构建 JSON 数据。

让我们看一下下面的代码：

let names = ["Jobs","Cook","Ive"]

if let jsonData = NSJSONSerialization.dataWithJSONObject(names, options: NSJSONWritingOptions.allZeros, error: nil) {
    let jsonString = NSString(data: jsonData, encoding: NSUTF8StringEncoding)
    // ["Jobs","Cook","Ive"]
}

我们使用 dataWithJSONObject 方法将 JSON 对象转换成 JSON 数据，我们传入的对象可以是数组也可以是字典，分别对应了 JSON 中的数组和对象。

我们注意到 dataWithJSONObject 这个方法也有个 options 选项，它用来控制构建 JSON 时的选项，类型为 NSJSONWritingOptions。它只有一个选项，就是 NSJSONWritingOptions.PrettyPrinted。

这个选项的作用也不言而喻，就是让生成的 JSON 数据是良好的格式化的：

let jsonObj = ["name":"Jobs","friends":["Ive","Cook"]]

if let jsonData = NSJSONSerialization.dataWithJSONObject(jsonObj, options: NSJSONWritingOptions.PrettyPrinted, error: nil) {

    let jsonString = NSString(data: jsonData, encoding: NSUTF8StringEncoding)

}

使用 PrettyPrinted 选项，我们输出的 JSON 就是这样一个良好格式化的：

{
  "name": "Jobs",
  "friends": [
    "Ive",
    "Cook"
  ]
}

如果我们没有使用这个选项，那么我们得到的输出就是这样：

{"name": "Jobs","friends": ["Ive","Cook"]}

区别就在这，这下明白了吧。

其他方案

当然了，除了使用原生的 NSJSONSerialization 来处理 JSON，我们还可以使用很多第三方库来进行 JSON 数据的操作，比如:SwiftyJSON, Argo。

限于篇幅以及大家的阅读疲劳期，我们这篇文章只介绍原生的方式。后续还会为大家更详细的讲解这些第三方库的运用，以及他们的好处及缺点。

下面是本篇文章对应的 playground 文件，大家下载下来应该应该能作为更好的参考：

swift-json.playground