在 Swift 裡解析 JSON,若直接用 NSJSONSerialization,光是層層剝可選值就能寫到崩潰。SwiftyJSON 把這件事變得非常乾脆。本文從安裝講到進階操作,並示範如何搭配網路請求使用。
SwiftyJSON 是以 Swift 撰寫的開源庫,能讓解析與產生 JSON 變得輕鬆。
GitHub:https://github.com/SwiftyJSON/SwiftyJSON
使用方式很樸素——把 SwiftyJSON.swift 直接拉進專案即可。
跟 NSJSONSerialization 相比,在取得多層結構的資料時,SwiftyJSON 不需要一路判斷節點存不存在、型別对不对、下一層又在不在。同時它內部會自動處理 Optional 的拆包,程式碼量大幅縮減。
以下面這份「聯絡人清單」為例:
[
{
"name": "hangge",
"age": 100,
"phones": [
{ "name": "公司", "number": "123456" },
{ "name": "家庭", "number": "001" }
]
},
{
"name": "big boss",
"age": 1,
"phones": [
{ "name": "公司", "number": "111111" }
]
}
]
測試前先把 JSON 字串轉成 NSData:
let jsonStr = "[{\"name\": \"hangge\", \"age\": 100, \"phones\": [{\"name\": \"公司\",\"number\": \"123456\"}, {\"name\": \"家庭\",\"number\": \"001\"}]}, {\"name\": \"big boss\",\"age\": 1,\"phones\": [{ \"name\": \"公司\",\"number\": \"111111\"}]}]"
if let jsonData = jsonStr.dataUsingEncoding(NSUTF8StringEncoding,
allowLossyConversion: false) {
// ...
}
想拿第一位聯絡人的第一個電話,每一層都得判斷一次:
if let userArray = try? NSJSONSerialization.JSONObjectWithData(jsonData,
options: .AllowFragments) as? [[String: AnyObject]],
let phones = userArray?[0]["phones"] as? [[String: AnyObject]],
let number = phones[0]["number"] as? String {
print("第一個聯絡人的第一個電話號碼:", number)
}
即使改用 optional 鏈式寫法精簡一些,行數依然可觀:
if let userArray = try? NSJSONSerialization.JSONObjectWithData(jsonData,
options: .AllowFragments) as? [[String: AnyObject]],
let number = (userArray?[0]["phones"] as? [[String: AnyObject]])?[0]["number"] as? String {
print("第一個聯絡人的第一個電話號碼:", number)
}
不用怕越界、不用判節點、不用手動拆包:
let json = JSON(data: jsonData)
if let number = json[0]["phones"][0]["number"].string {
print("第一個聯絡人的第一個電話號碼:", number)
}

取不到值時,直接把那個節點印出來,錯誤資訊會告訴你問題出在哪一層:
let json = JSON(data: jsonData)
if let number = json[0]["phones"][0]["number"].string {
print("第一個聯絡人的第一個電話號碼:", number)
} else {
// 印出錯誤資訊
print(json[0]["phones"][0]["number"])
}
實務上更常是從遠端拉資料再解析,以下兩種常見組合。
let urlString: String = "https://www.111cn.net/getJsonData.php"
let url: NSURL! = NSURL(string: urlString)
let request: NSURLRequest = NSURLRequest(URL: url)
let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request,
completionHandler: { (data, response, error) -> Void in
if error != nil {
print(error?.code)
print(error?.description)
} else {
let json = JSON(data: data!)
if let number = json[0]["phones"][0]["number"].string {
print("第一個聯絡人的第一個電話號碼:", number)
}
}
}) as NSURLSessionTask
// 啟動任務
dataTask.resume()
let urlString: String = "https://www.111cn.net/code/test.php"
let url: NSURL! = NSURL(string: urlString)
Alamofire.request(.GET, url).validate().responseJSON { response in
switch response.result {
case .Success:
if let value = response.result.value {
let json = JSON(value)
if let number = json[0]["phones"][0]["number"].string {
print("第一個聯絡人的第一個電話號碼:", number)
}
}
case .Failure(let error):
print(error)
}
}
用 .number、.string、.bool、.int、.uInt、.float、.double、.array、.dictionary 以及 int8 / Uint8 / int16 / Uint16 / int32 / Uint32 / int64 / Uint64 等,取回的是 optional,需要自行判斷,取不到時還能拿到錯誤資訊。
// Int
if let age = json[0]["age"].int {
print(age)
} else {
print(json[0]["age"]) // 印出錯誤資訊
}
// String
if let name = json[0]["name"].string {
print(name)
} else {
print(json[0]["name"])
}
使用 xxxValue 這類屬性,取不到就回傳型別的預設值,省去拆包判斷:
// 不是數字或 nil 時回傳 0
let age: Int = json[0]["age"].intValue
// 不是字串或 nil 時回傳 ""
let name: String = json[0]["name"].stringValue
// 不是陣列或 nil 時回傳 []
let list: Array<JSON> = json[0]["phones"].arrayValue
// 不是字典或 nil 時回傳 [:]
let phone: Dictionary<String, JSON> = json[0]["phones"][0].dictionaryValue
let jsonObject: AnyObject = json.object
if let jsonObject: AnyObject = json.rawValue
// 轉成 NSData
if let data = json.rawData() {
// 你想做的事
}
// 轉成字串
if let string = json.rawString() {
// 你想做的事
}
json[0]["age"].int = 101
json[0]["name"].string = "111cn.net"
json[0]["phones"].arrayObject = [["name": "固話", "number": 110],
["name": "手機", "number": 120]]
json[0]["phones"][0].dictionaryObject = ["name": "固話", "number": 100]
數字、字串、或整組陣列都能當下標,以下三種寫法結果完全相同:
// 寫法一
let number = json[0]["phones"][0]["number"].stringValue
// 寫法二
let number = json[0, "phones", 0, "number"].stringValue
// 寫法三
let keys: [JSONSubscriptType] = [0, "phones", 0, "number"]
let number = json[keys].stringValue
for (index, subJson): (String, JSON) in json {
print("\(index):\(subJson)")
}

for (key, subJson): (String, JSON) in json[0] {
print("\(key):\(subJson)")
}

let json: JSON = nil
// StringLiteralConvertible
let json: JSON = "I'm a son"
// IntegerLiteralConvertible
let json: JSON = 12345
// BooleanLiteralConvertible
let json: JSON = true
// FloatLiteralConvertible
let json: JSON = 2.8765
// DictionaryLiteralConvertible
let json: JSON = ["I": "am", "a": "son"]
// ArrayLiteralConvertible
let json: JSON = ["I", "am", "a", "son"]
// 陣列與字典混用
var json: JSON = ["name": "Jack", "age": 25, "list": ["a", "b", "c", ["what": "this"]]]
json["list"][3]["what"] = "that"
json["list", 3, "what"] = "that"
let path = ["list", 3, "what"]
json[path] = "that"
整體來說,SwiftyJSON 的價值在於把「層層防禦式判斷」收斂成一條可讀的鏈式表達,讓資料取用的意圖直接浮現在程式碼上。