SwiftyJSON下载 - Swift JSON类库

19371 2019-04-15 Swift MIT 官方网站

Swift JSON类库,SwiftyJSON可以轻松地在Swift中处理JSON格式数据。

SwiftyJSON下载

4.3.0.zip(4.3.0) 下载

4.2.0.zip(4.2.0) 下载

4.1.0.zip(4.1.0) 下载

5.0.0.zip(5.0.0) 下载

SwiftyJSON.framework.zip(3.1.3) 下载

4.0.0.zip(4.0.0) 下载

4.0.0-alpha.1.zip(4.0.0-alpha.1) 下载

3.1.4.zip(3.1.4) 下载

3.1.3.zip(3.1.3) 下载

SwiftyJSON.framework.zip(3.1.2) 下载

SwiftyJSON.framework.zip(3.1.1) 下载

3.1.2.zip(3.1.2) 下载

3.1.1.zip(3.1.1) 下载

SwiftyJSON趋势

SwiftyJSON介绍

Carthage compatible CocoaPods Platform Reviewed by Hound

SwiftyJSON makes it easy to deal with JSON data in Swift.

Platform Build Status
*OS Travis CI
Linux Build Status
  1. Why is the typical JSON handling in Swift NOT good

  2. Requirements

  3. Integration

  4. Usage

  5. Work with Alamofire

  6. Work with Moya

  7. SwiftyJSON Model Generator

中文介绍

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 API).

The code would look like this:


if let statusesArray = try? JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [[String: Any]],
    let user = statusesArray[0]["user"] as? [String: Any],
    let username = user["name"] as? String {
    // Finally we got the username
}

It's not good.

Even if we use optional chaining, it would be messy:


if let JSONObject = try JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [[String: Any]],
    let username = (JSONObject[0]["user"] as? [String: Any])?["name"] as? String {
        // There's our username
}

An unreadable mess--for something that should really be simple!

With SwiftyJSON all you have to do is:


let json = JSON(data: dataFromNetworking)
if let 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.


let json = JSON(data: dataFromNetworking)
let result = json[999999]["wrong_key"]["wrong_name"]
if let userName = result.string {
    //Calm down, take it easy, the ".string" property still produces the correct Optional String type with safety
} else {
    //Print the error
    print(result.error)
}

Requirements

  • iOS 8.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+

  • Xcode 8

Integration

CocoaPods (iOS 8+, OS X 10.9+)

You can use CocoaPods to install SwiftyJSON by adding it to your Podfile:


platform :ios, '8.0'use_frameworks!

target 'MyApp' do
    pod 'SwiftyJSON', '~> 4.0'end

Carthage (iOS 8+, OS X 10.9+)

You can use Carthage to install SwiftyJSON by adding it to your Cartfile:


github "SwiftyJSON/SwiftyJSON" ~> 4.0

If you use Carthage to build your dependencies, make sure you have added SwiftyJSON.framework to the "Linked Frameworks and Libraries" section of your target, and have included them in your Carthage framework copying build phase.

Swift Package Manager

You can use The Swift Package Manager to install SwiftyJSON by adding the proper description to your Package.swift file:


// swift-tools-version:4.0
import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    dependencies: [
        .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "4.0.0"),
    ]
)

Then run swift build whenever you get prepared.

Manually (iOS 7+, OS X 10.9+)

To use this library in your project manually you may:

  1. for Projects, just drag SwiftyJSON.swift to the project tree

  2. for Workspaces, include the whole SwiftyJSON.xcodeproj

Usage

Initialization


import SwiftyJSON

let json = JSON(data: dataFromNetworking)

Or


let json = JSON(jsonObject)

Or


if let dataFromString = jsonString.data(using: .utf8, allowLossyConversion: false) {
    let json = JSON(data: dataFromString)
}

Subscript


// Getting a double from a JSON Arraylet name = json[0].double

// Getting an array of string from a JSON Arraylet arrayNames =  json["users"].arrayValue.map {$0["name"].stringValue}

// Getting a string from a JSON Dictionarylet name = json["name"].stringValue

// Getting a string using a path to the element
let path: [JSONSubscriptType] = [1,"list",2,"name"]
let name = json[path].string
// Just the same
let name = json[1]["list"][2]["name"].string
// Alternatively
let name = json[1,"list",2,"name"].strin

// With a hard waylet name = json[].string

// With a custom way
let keys:[JSONSubscriptType] = [1,"list",2,"name"]
let name = json[keys].string

Loop


// If json is .Dictionary
for (key,subJson):(String, JSON) in json {
   // Do something you want
}

The first element is always a String, even if the JSON is an Array


//
// If json is .Array
// The `index` is 0..<json.count's string value
for (index,subJson):(String, JSON) in json {
    // Do something you want
}

Error

SwiftyJSON 4.x

SwiftyJSON 4.x introduces an enum type called SwiftyJSONError, which includes unsupportedType, indexOutOfBounds, elementTooDeep, wrongType, notExist and invalidJSON, at the same time, ErrorDomain are being replaced by SwiftyJSONError.errorDomain. Note: Those old error types are deprecated in SwiftyJSON 4.x and will be removed in the future release.

SwiftyJSON 3.x

Use a subscript to get/set a value in an Array or Dictionary

If the JSON is:

  • an array, the app may crash with "index out-of-bounds."

  • a dictionary, it will be assigned to nil without a reason.

  • not an array or a dictionary, the app may crash with an "unrecognised selector" exception.

This will never happen in SwiftyJSON.


let json = JSON(["name", "age"])
if let name = json[999].string {
    // Do something you want
} else {
    print(json[999].error!) // "Array[999] is out of bounds"
}

let json = JSON(["name":"Jack", "age": 25])
if let name = json["address"].string {
    // Do something you want
} else {
    print(json["address"].error!) // "Dictionary["address"] does not exist"
}

let json = JSON(12345)
if let age = json[0].string {
    // Do something you want
} else {
    print(json[0])       // "Array[0] failure, It is not an array"
    print(json[0].error!) // "Array[0] failure, It is not an array"
}

if let name = json["name"].string {
    // Do something you want
} else {
    print(json["name"])       // "Dictionary[\"name"] failure, It is not an dictionary"
    print(json["name"].error!) // "Dictionary[\"name"] failure, It is not an dictionary"
}

Optional getter


// NSNumber
if let id = json["user"]["favourites_count"].number {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["favourites_count"].error!)
}

// String
if let id = json["user"]["name"].string {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["name"].error!)
}

// Bool
if let id = json["user"]["is_translator"].bool {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["is_translator"].error!)
}

// Int
if let id = json["user"]["id"].int {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["id"].error!)
}
...