- Notifications
You must be signed in to change notification settings - Fork162
The better way to deal with JSON data in Swift
License
aemaeth-me/SwiftyJSON
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
#SwiftyJSON中文介绍
SwiftyJSON makes it easy to deal with JSON data in Swift.
##Why is the typical JSON handling in Swift NOT good?Swift is very strict about types. But although explicit typing is good for saving us from mistakes, it becomes painful when dealing with JSON and other areas that are, by nature, implicit about types.
Take the Twitter API for example. Say we want to retrieve a user's "name" value of some tweet in Swift (according to Twitter's APIhttps://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline).
The code would look like this:
letjsonObject:AnyObject!=NSJSONSerialization.JSONObjectWithData(dataFromTwitter, options:NSJSONReadingOptions.MutableContainers, error:nil)iflet statusesArray= jsonObjectas?NSArray{iflet aStatus=statusesArray[0]as?NSDictionary{iflet user=aStatus["user"]as?NSDictionary{iflet userName=user["name"]as?NSDictionary{ //Finally We Got The Name}}}}
It's not good.
Even if we use optional chaining, it would also cause a mess:
letjsonObject:AnyObject!=NSJSONSerialization.JSONObjectWithData(dataFromTwitter, options:NSJSONReadingOptions.MutableContainers, error:nil)iflet userName=(((jsonObjectas?NSArray)?[0]as?NSDictionary)?["user"]as?NSDictionary)?["name"]{ //What A disaster above}
An unreadable mess--for something that should really be simple!
With SwiftyJSON all you have to do is:
letjson=JSON(data: dataFromNetworking)iflet userName=json[0]["user"]["name"].string{ //Now you got your value}
And don't worry about the Optional Wrapping thing. It's done for you automatically
letjson=JSON(data: dataFromNetworking)iflet userName=json[999999]["wrong_key"]["wrong_name"].string{ //Calm down, take it easy, the ".string" property still produces the correct Optional String type with safety}else{ //Print the errorprintln(json[999999]["wrong_key"]["wrong_name"])}
- iOS 7.0+ / Mac OS X 10.9+
- Xcode 6.1
##Integration
You can useCarthage to installSwiftyJSON by addinggithub "SwiftyJSON/SwiftyJSON" >= 2.1.2 to yourCartfile
CocoaPods is now supported for Swift yet. But to use this library in your project manually you should:
- for Projects just drag SwiftyJSON.swift to the project tree
- for Workspaces you may include the whole SwiftyJSON.xcodeproj as suggested by @garnett
####Initialization
letjson=JSON(data: dataFromNetworking)
letjson=JSON(jsonObject)
####Subscript
//With a int from JSON supposed to an Arrayletname=json[0].double
//With a string from JSON supposed to an Dictionaryletname=json["name"].stringValue
//With an array like path to the elementletpath=[1,"list",2,"name"]letname=json[path].string //Just the sameletname=json[1]["list"][2]["name"].string
//With a literal array to the elementletname=json[1,"list",2,"name"].string //Just the sameletname=json[1]["list"][2]["name"].string
//With a Hard Wayletname=json[[1,"list",2,"name"]].string
####Loop
//If json is .Dictionaryfor(key: String, subJson: JSON)in json{ //Do something you want}
The first element is always String, even if the JSON's object is Array
//If json is .Array//The `index` is 0..<json.count's string valuefor(index: String, subJson: JSON)in json{ //Do something you want}
####ErrorUse subscript to get/set value in Array or Dicitonary
- If json is an array, the app may crash with "index out-of-bounds."
- If json is a dictionary, it will get
nilwithout the reason. - If json is not an array or a dictionary, the app may crash with the wrong selector exception.
It will never happen in SwiftyJSON
letjson=JSON(["name","age"])letname=json[999].string{ //Do something you want} else{println(json[999].error) // "Array[999] is out of bounds"}
letjson=JSON(["name":"Jack","age":25])letname=json["address"].string{ //Do something you want} else{println(json["address"].error) // "Dictionary["address"] does not exist"}
letjson=JSON(12345)letage=json[0].string{ //Do something you want} else{println(json[0]) // "Array[0] failure, It is not an array"println(json[0].error) // "Array[0] failure, It is not an array"}letname=json["name"].string{ //Do something you want} else{println(json["name"]) // "Dictionary[\"name"] failure, It is not an dictionary"println(json["name"].error) // "Dictionary[\"name"] failure, It is not an dictionary"}
####Optional getter
//NSNumberiflet id=json["user"]["favourites_count"].number{ //Do something you want}else{ //Print the errorprintln(json["user"]["favourites_count"].error)}
//Stringiflet id=json["user"]["name"].string{ //Do something you want}else{ //Print the errorprintln(json["user"]["name"])}
//Booliflet id=json["user"]["is_translator"].bool{ //Do something you want}else{ //Print the errorprintln(json["user"]["is_translator"])}
//Intiflet id=json["user"]["id"].int{ //Do something you want}else{ //Print the errorprintln(json["user"]["id"])}...
####Non-optional getterNon-optional getter is namedxxxValue
//If not a Number or nil, return 0letid:Int=json["id"].intValue
//If not a String or nil, return ""letname:String=json["name"].stringValue
//If not a Array or nil, return []letlist:Array<JSON>=json["list"].arrayValue
//If not a Dictionary or nil, return [:]letuser:Dictionary<String,JSON>=json["user"].dictionaryValue
####Setter
json["name"]=JSON("new-name")json[0]=JSON(1)
json["id"].int=1234567890json["coordinate"].double=8766.766json["name"].string="Jack"json.array=[1,2,3,4]json.dictionary=["name":"Jack","age":25]
####Raw object
letjsonObject:AnyObject= json.object
iflet jsonObject:AnyObject= json.rawValue
//convert the JSON to raw NSDataiflet data= json.rawData(){ //Do something you want}
//convert the JSON to raw Stringiflet string= json.rawString(){ //Do something you want}
####Literal convertiblesMore info about the literal convertibles:Swift Literal Convertibles
//StringLiteralConvertibleletjson:JSON="I'm a json"
//IntegerLiteralConvertibleletjson:JSON=12345
//BooleanLiteralConvertibleletjson:JSON=true
//FloatLiteralConvertibleletjson:JSON=2.8765
//DictionaryLiteralConvertibleletjson:JSON=["I":"am","a":"json"]
//ArrayLiteralConvertibleletjson:JSON=["I","am","a","json"]
//NilLiteralConvertibleletjson:JSON=nil
//With subscript in arrayvarjson:JSON=[1,2,3]json[0]=100json[1]=200json[2]=300json[999]=300 //Don't worry, nothing will happen
//With subscript in dictionaryvarjson:JSON=["name":"Jack","age":25]json["name"]="Mike"json["age"]="25" //It's OK to set Stringjson["address"]="L.A." // Add the "address": "L.A." in json
//Array & Dictionaryvarjson:JSON=["name":"Jack","age":25,"list":["a","b","c",["what":"this"]]]json["list"][3]["what"]="that"json["list",3,"what"]="that"letpath=["list",3,"what"]json[path]="that"
##Work with Alamofire
SwiftyJSON nicely wraps the result of the Alamofire JSON response handler:
Alamofire.request(.GET, url, parameters: parameters).responseJSON{(req, res, json, error)inif(error!=nil){NSLog("Error:\(error)")println(req)println(res)}else{NSLog("Success:\(url)")varjson=JSON(json!)}}
About
The better way to deal with JSON data in Swift
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- Swift98.5%
- C++1.1%
- Ruby0.4%