# SwiftyJSON
[![Travis CI](https://travis-ci.org/SwiftyJSON/SwiftyJSON.svg?branch=master)](https://travis-ci.org/SwiftyJSON/SwiftyJSON) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) ![CocoaPods](https://img.shields.io/cocoapods/v/SwiftyJSON.svg) ![Platform](https://img.shields.io/badge/platforms-iOS%208.0+%20%7C%20macOS%2010.10+%20%7C%20tvOS%209.0+%20%7C%20watchOS%202.0+-333333.svg)
SwiftyJSON makes it easy to deal with JSON data in Swift.
1. [Why is the typical JSON handling in Swift NOT good](#why-is-the-typical-json-handling-in-swift-not-good)
2. [Requirements](#requirements)
3. [Integration](#integration)
4. [Usage](#usage)
- [Initialization](#initialization)
- [Subscript](#subscript)
- [Loop](#loop)
- [Error](#error)
- [Optional getter](#optional-getter)
- [Non-optional getter](#non-optional-getter)
- [Setter](#setter)
- [Raw object](#raw-object)
- [Literal convertibles](#literal-convertibles)
- [Merging](#merging)
5. [Work with Alamofire](#work-with-alamofire)
> For Legacy Swift support, take a look at the [swift2 branch](https://github.com/SwiftyJSON/SwiftyJSON/tree/swift2)
> [中文介绍](http://tangplin.github.io/swiftyjson/)
## 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 https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline).
The code would look like this:
```swift
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:
```swift
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:
```swift
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.
```swift
let json = JSON(data: dataFromNetworking)
if let 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 error
print(json[999999]["wrong_key"]["wrong_name"])
}
```
## 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](http://cocoapods.org/) to install `SwiftyJSON`by adding it to your `Podfile`:
```ruby
platform :ios, '8.0'
use_frameworks!
target 'MyApp' do
pod 'SwiftyJSON'
end
```
Note that this requires CocoaPods version 36, and your iOS deployment target to be at least 8.0:
#### Carthage (iOS 8+, OS X 10.9+)
You can use [Carthage](https://github.com/Carthage/Carthage) to install `SwiftyJSON` by adding it to your `Cartfile`:
```
github "SwiftyJSON/SwiftyJSON"
```
#### Swift Package Manager
You can use [The Swift Package Manager](https://swift.org/package-manager) to install `SwiftyJSON` by adding the proper description to your `Package.swift` file:
```swift
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.Package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", versions: Version(1,0,0)..<Version(3, .max, .max)),
]
)
```
Note that the [Swift Package Manager](https://swift.org/package-manager) is still in early design and development, for more information checkout its [GitHub Page](https://github.com/apple/swift-package-manager)
#### 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
```swift
import SwiftyJSON
```
```swift
let json = JSON(data: dataFromNetworking)
```
```swift
let json = JSON(jsonObject)
```
```swift
if let dataFromString = jsonString.data(using: .utf8, allowLossyConversion: false) {
let json = JSON(data: dataFromString)
}
```
#### Subscript
```swift
//Getting a double from a JSON Array
let name = json[0].double
```
```swift
//Getting an array of string from a JSON Array
let arrayNames = json["users"].arrayValue.map({$0["name"].stringValue})
```
```swift
//Getting a string from a JSON Dictionary
let name = json["name"].stringValue
```
```swift
//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"].string
```
```swift
//With a hard way
let name = json[].string
```
```swift
//With a custom way
let keys:[SubscriptType] = [1,"list",2,"name"]
let name = json[keys].string
```
#### Loop
```swift
//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*
```swift
//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
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 `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.
```swift
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"
}
```
```swift
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"
}
```
```swift
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
```swift
//NSNumber
if let id = json["user"]["favourites_count"].number {
//Do something you want
} else {
//Print the error
print(json["user"]["favourites_count"].error)
}
```
```swift
//String
if let id = json["user"]["name"].string {
//Do something you want
} else {
//Print the error
print(json["user"]["name"])
}
```
```swift
//Bool
if let id = json["user"]["is_translator"].bool {
//Do something you want
} else {
//Print the error
print(json["user"]["is_translator"])
}
```
```swift
//Int
if let id = json["user"]["id"].int {
//Do something you want
} else {
//Print the error
print(json["user"]["id"])
}
...
```
#### Non-optional getter
Non-optional getter is named `xxxValue`
```swift
//If not a Number or nil, return 0
let id: Int = json["id"].intValue
```
```swift
//If not a String or nil, return
没有合适的资源?快使用搜索试试~ 我知道了~
安浪个人工作站:与企业员工OA系统不同,本系统完全面向个人,创建一个属于自己的完全的云端空间.zip
共840个文件
js:111个
ts:103个
xml:88个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 160 浏览量
2024-04-29
23:44:22
上传
评论
收藏 17.44MB ZIP 举报
温馨提示
【博客个人资源】 包含前端、后端、移动开发、操作系统、人工智能、物联网、信息化管理、数据库、硬件开发、大数据、课程资源、音视频、网站开发等各种技术项目的源码。包括STM32、ESP8266、PHP、QT、Linux、iOS、C++、Java、python、web、C#、EDA、proteus、RTOS等项目的源码。 【技术】 Java、Python、Node.js、Spring Boot、Django、Express、MySQL、PostgreSQL、MongoDB、React、Angular、Vue、Bootstrap、Material-UI、Redis、Docker、Kubernetes
资源推荐
资源详情
资源评论
收起资源包目录
安浪个人工作站:与企业员工OA系统不同,本系统完全面向个人,创建一个属于自己的完全的云端空间.zip (840个子文件)
.babelrc 402B
gradlew.bat 2KB
routes.conf 110B
style.bundle.css 1.49MB
style.bundle.css 1.48MB
vendors.bundle.css 413KB
fullcalendar.bundle.css 33KB
jquery-ui.bundle.css 19KB
jqvmap.bundle.css 779B
.editorconfig 147B
fontawesome-webfont.eot 162KB
line-awesome.eot 110KB
Flaticon.eot 59KB
socicon.eot 51KB
summernote.eot 16KB
Metronic_fda1334c35d0f5fe2afb3afebbb6774a.eot 2KB
.eslintignore 51B
.eslintrc 58B
android_v0.1.1.gif 3.14MB
throbber.gif 2KB
.gitattributes 56B
.gitignore 506B
.gitignore 213B
.gitignore 169B
.gitignore 118B
.gitignore 7B
.gitkeep 0B
build.gradle 5KB
build.gradle 1KB
settings.gradle 15B
gradlew 5KB
Pods-AnnZone-iOSUITests-umbrella.h 338B
Pods-AnnZone-iOSTests-umbrella.h 334B
Pods-AnnZone-iOS-umbrella.h 324B
SwiftyJSON-umbrella.h 312B
index.component.html 50KB
header-nav.component.html 36KB
aside-nav.component.html 28KB
profile.component.html 22KB
ng-bootstrap.component.html 21KB
quick-sidebar.component.html 19KB
primeng-panel.component.html 18KB
profile.component.html 16KB
primeng-input.component.html 13KB
publish.component.html 9KB
user-register-protocol.component.html 8KB
login-1.component.html 7KB
list.component.html 7KB
list.component.html 6KB
primeng-button.component.html 6KB
login-5.component.html 6KB
login-3.component.html 6KB
login-2.component.html 6KB
login-4.component.html 5KB
publish.component.html 5KB
add.component.html 3KB
list.component.html 3KB
list.component.html 3KB
add.component.html 3KB
list.component.html 3KB
draft.component.html 3KB
recycle.component.html 3KB
draft.component.html 3KB
recycle.component.html 3KB
recycle.component.html 3KB
add.component.html 3KB
comment.component.html 3KB
inner.component.html 3KB
comment.component.html 3KB
publish.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
list.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
inner.component.html 3KB
index.html 3KB
footer.component.html 2KB
tooltips.component.html 878B
app.component.html 852B
not-found.component.html 692B
blank.component.html 686B
index.html 307B
index.html 270B
alert.component.html 239B
scroll-top.component.html 233B
index.html 163B
theme.component.html 133B
subheader--type-search.component.html 129B
default.component.html 129B
index.html 120B
primeng.component.html 31B
logout.component.html 0B
favicon.ico 16KB
favicon.ico 1KB
AnnZone-Console.iml 513B
共 840 条
- 1
- 2
- 3
- 4
- 5
- 6
- 9
资源评论
枫蜜柚子茶
- 粉丝: 6242
- 资源: 4607
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功