SwiftyJSON - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #golang #android #deep-learning #linux #docker #macos #nodejs #awesome-list #security #ios

SwiftyJSON

(★ 22,950)

Swift에서 JSON 데이터를 다루는 더 나은 방법.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- ISSUE_TEMPLATE
- PULL_REQUEST_TEMPLATE
- - AppDelegate.swift
  - Info.plist
  - SwiftyJSONTests.json
  - ViewController.swift
- - project.pbxproj
- - Contents.swift
  - contents.xcplayground
- - PrivacyInfo.xcprivacy
  - SwiftyJSON.h
  - SwiftyJSON.swift
- Info-iOS.plist
- Info-macOS.plist
- Info-tvOS.plist
- Info-watchOS.plist
- - contents.xcworkspacedata
- project.pbxproj
- - IDEWorkspaceChecks.plist
  - WorkspaceSettings.xcsettings
- contents.xcworkspacedata
- - ArrayTests.swift
  - BaseTests.swift
  - CodableTests.swift
  - ComparableTests.swift
  - ConcurrencyTests.swift
  - DictionaryTests.swift
  - LiteralConvertibleTests.swift
  - MergeTests.swift
  - MutabilityTests.swift
  - NestedJSONTests.swift
  - NumberTests.swift
  - PerformanceTests.swift
  - PrintableTests.swift
  - RawRepresentableTests.swift
  - RawTests.swift
  - SequenceTypeTests.swift
  - StringTests.swift
  - SubscriptTests.swift
  - Tests.json
- Info-iOS.plist
- Info-macOS.plist
- Info-tvOS.plist
.gitignore
.hound.yml
.swiftlint.yml
CHANGELOG.md
LICENSE
Package.swift
README.md
SwiftyJSON.podspec

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SwiftyJSON
[![CI](https://github.com/SwiftyJSON/SwiftyJSON/actions/workflows/ci.yml/badge.svg)](https://github.com/SwiftyJSON/SwiftyJSON/actions/workflows/ci.yml)
[![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%203.0-F28D00.svg) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed\_by-Hound-8E64B0.svg)](https://houndci.com)
SwiftyJSON을 사용하면 Swift에서 JSON 데이터를 매우 쉽게 다룰 수 있습니다.
1. [Swift의 전형적인 JSON 처리가 좋지 않은 이유](#why-is-the-typical-json-handling-in-swift-not-good)
2. [요구 사항](#requirements)
3. [통합](#integration)
4. [사용법](#usage)
- [초기화](#initialization)
- [서브스크립트](#subscript)
- [반복문](#loop)
- [에러](#error)
- [옵셔널 게터](#optional-getter)
- [논옵셔널 게터](#non-optional-getter)
- [세터](#setter)
- [원시 객체](#raw-object)
- [리터럴 변환 가능 타입](#literal-convertibles)
- [병합](#merging)
- [요소 제거](#removing-elements)
5. [Alamofire와 함께 사용하기](#work-with-alamofire)
6. [Moya와 함께 사용하기](#work-with-moya)
7. [SwiftyJSON 모델 제너레이터](#swiftyjson-model-generator)
## Swift의 전형적인 JSON 처리가 좋지 않은 이유?
Swift는 타입에 매우 엄격합니다. 명시적 타이핑은 실수를 방지하는 데 도움을 주지만, 본질적으로 타입이 암시적인 JSON 같은 데이터를 다룰 때는 번거로워집니다.
Twitter API를 예로 들어보겠습니다. Swift에서 어떤 트윗의 사용자 "name" 값을 가져오고 싶다고 가정해 봅시다 ([Twitter API 문서](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home\_timeline) 참고).
코드는 다음과 같을 것입니다:
```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 {
// 드디어 사용자 이름을 얻었습니다
}
```
좋지 않습니다.
옵셔널 체이닝을 사용하더라도 코드가 지저분해집니다:
```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 {
// 여기에 사용자 이름이 있습니다
}
```
정말 간단해야 할 작업인데도 읽기 힘들고 지저분합니다!
SwiftyJSON을 사용하면 다음과 같이 간단하게 작성할 수 있습니다:
```swift
let json = try? JSON(data: dataFromNetworking)
if let userName = json[0]["user"]["name"].string {
// 이제 값을 얻었습니다
}
```
옵셔널 래핑(Optional Wrapping)에 대해 걱정하지 마세요. 자동으로 처리됩니다.
```swift
let json = try? JSON(data: dataFromNetworking)
let result = json[999999]["wrong\_key"]["wrong\_name"]
if let userName = result.string {
// 안심하세요. ".string" 속성은 안전하게 올바른 옵셔널 String 타입을 생성합니다.
} else {
// 에러 출력
print(result.error)
}
```
## 요구 사항
- iOS 8.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+
- Xcode 16+
- Swift 6.0+
## 통합
#### CocoaPods (iOS 8+, OS X 10.9+)
[CocoaPods](http://cocoapods.org/)를 사용하여 `Podfile`에 추가함으로써 `SwiftyJSON`을 설치할 수 있습니다:
```ruby
platform :ios, '8.0'
use\_frameworks!
target 'MyApp' do
pod 'SwiftyJSON', '~> 4.0'
end
```
#### Carthage (iOS 8+, OS X 10.9+)
[Carthage](https://github.com/Carthage/Carthage)를 사용하여 `Cartfile`에 추가함으로써 `SwiftyJSON`을 설치할 수 있습니다:
```
github "SwiftyJSON/SwiftyJSON" ~> 4.0
```
Carthage를 사용하여 의존성을 빌드하는 경우, 타겟의 "Linked Frameworks and Libraries" 섹션에 `SwiftyJSON.framework`를 추가했는지 확인하고, Carthage 프레임워크 복사 빌드 페이즈에 포함시켰는지 확인하세요.
#### Swift Package Manager
[The Swift Package Manager](https://swift.org/package-manager)를 사용하여 올바른 설명을 `Packag

e.swift` 파일:
```swift
// 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"),
]
)
```
그런 다음 준비가 되었을 때 `swift build`를 실행하세요.
#### 수동으로 (iOS 7+, OS X 10.9+)
이 라이브러리를 프로젝트에서 수동으로 사용하려면 다음을 수행할 수 있습니다:
1. 프로젝트의 경우, SwiftyJSON.swift를 프로젝트 트리로 드래그 앤 드롭합니다.
2. 워크스페이스의 경우, SwiftyJSON.xcodeproj 전체를 포함합니다.
## 사용법 (Usage)
#### 초기화 (Initialization)
```swift
import SwiftyJSON
```
```swift
let json = try? 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
// JSON 배열에서 Double 가져오기
let name = json[0].double
```
```swift
// JSON 배열에서 String 배열 가져오기
let arrayNames = json["users"].arrayValue.map {$0["name"].stringValue}
```
```swift
// JSON 딕셔너리에서 String 가져오기
let name = json["name"].stringValue
```
```swift
// 요소에 대한 경로를 사용하여 String 가져오기
let path: [JSONSubscriptType] = [1,"list",2,"name"]
let name = json[path].string
// 완전히 동일함
let name = json[1]["list"][2]["name"].string
// 또는 다음과 같이 표현 가능
let name = json[1,"list",2,"name"].string
```
```swift
// 복잡한 방식
let name = json[].string
```
```swift
// 커스텀 방식
let keys:[JSONSubscriptType] = [1,"list",2,"name"]
let name = json[keys].string
```
#### 반복문 (Loop)
```swift
// json이 .Dictionary인 경우
for (key,subJson):(String, JSON) in json {
// 원하는 작업 수행
}
```
\*JSON이 배열(Array)인 경우에도 첫 번째 요소는 항상 String입니다\*
```swift
// json이 .Array인 경우
// `index`는 0.. = json["list"].arrayValue입니다.
```
```swift
// 딕셔너리가 아니거나 nil인 경우, [:]를 반환합니다.
let user: Dictionary = json["user"].dictionaryValue
```
#### 세터 (Setter)
```swift
json["name"] = JSON("new-name")
json[0] = JSON(1)
```
```swift
json["id"].int = 1234567890
json["coordinate"].double = 8766.766
json["name"].string = "Jack"
json.arrayObject = [1,2,3,4]
json.dictionaryObject = ["name":"Jack", "age":25]
```
#### 원본 객체 (Raw object)
```swift
let rawObject: Any = json.object
```
```swift
let rawValue: Any = json.rawValue
```
```swift
// JSON을 원본 NSData로 변환
do {
let rawData = try json.rawData()
// 원하는 작업 수행
} catch {
print("Error \(error)")
}
```
```swift
// JSON을 원본 String으로 변환
if let rawString = json.rawString() {
// 원하는 작업 수행
} else {
print("json.rawString is nil")
}
```
#### 존재 여부 (Existence)
```swift
// JSON에 값이 지정되어 있는지 여부를 나타냄
if json["name"].exists()
```
#### 리터럴 변환 (Literal convertibles)
리터럴 변환에 대한 자세한 정보: [Swift Literal Convertibles](http://nshipster.com/swift-literal-convertible/)
```swift
// StringLiteralConvertible
let json: JSON = "I'm a json"
```
```swift
// IntegerLiteralConvertible
let json: JSON = 12345
```
```swift
// BooleanLiteralConvertible
let json: JSON = true
```
```swift
// FloatLiteralConvertible
let json: JSON = 2.8765
```
```swift
// DictionaryLiteralConvertible
let json: JSON = ["I":"am", "a":"json"]
```
```swift
// ArrayLiteralConvertible
let json: JSON = ["I", "am", "a", "json"]
```
```swift
// 배열에서의 서브스크립트 사용
var json: JSON = [1,2,3]
json[0] = 100
json[1] = 200
json[2] = 300
json[999] = 300 // 걱정하지 마세요, 아무 일도 일어나지 않습니다.
```
```swift
// 딕셔너리에서의 서브스크립트 사용
var json: JSON = ["name": "Jack", "age": 25]
json["name"] = "Mike"
json["age"] = "25" // String을 설정해도 괜찮습니다.
json["address"] = "L.A." // json에 "address": "L.A."가 추가됩니다.
```
```swift
// 배열 및 딕셔너리
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: [JSONSubscriptType] = ["list",3,"what"]
json[path] = "that"
```
```swift
// 다른 JSON 객체와 함께 사용
let user: JSON = ["username" : "Steve", "password": "sup

ersecurepassword"]
let auth: JSON = [
"user": user.object, // just user 대신 user.object 사용
"apikey": "supersecretapitoken"
]
```
#### 병합 (Merging)
하나의 JSON을 다른 JSON에 병합하는 것이 가능합니다. 어떤 JSON을 다른 JSON에 병합하면, `other` JSON에만 존재하고 원래 JSON에는 존재하지 않는 모든 값이 원래 JSON에 추가됩니다.
두 JSON이 동일한 키에 대한 값을 모두 포함하고 있는 경우, \_대체로\_ 이 값은 원래 JSON에서 덮어쓰여지지만, 다음과 같은 두 가지 특별한 경우가 존재합니다:
- 두 값이 모두 `JSON.Type.array`인 경우, `other` JSON에 있는 배열의 값들이 원래 JSON의 배열 값에 추가됩니다.
- 두 값이 모두 `JSON.Type.dictionary`인 경우, 두 JSON 값이 감싸고 있는 JSON이 병합되는 것과 동일한 방식으로 병합됩니다.
JSON 내의 두 필드 타입이 서로 다른 경우, 값은 항상 덮어쓰여집니다.
병합에는 두 가지 방식이 있습니다. `merge`는 원래 JSON을 직접 수정하며, `merged`는 복사본을 통해 비파괴적으로 작동합니다.
```swift
let original: JSON = [
"first\_name": "John",
"age": 20,
"skills": ["Coding", "Reading"],
"address": [
"street": "Front St",
"zip": "12345",
]
]
let update: JSON = [
"last\_name": "Doe",
"age": 21,
"skills": ["Writing"],
"address": [
"zip": "12342",
"city": "New York City"
]
]
let updated = original.merge(with: update)
// [
// "first\_name": "John",
// "last\_name": "Doe",
// "age": 21,
// "skills": ["Coding", "Reading", "Writing"],
// "address": [
// "street": "Front St",
// "zip": "12342",
// "city": "New York City"
// ]
// ]
```
#### 요소 제거 (Removing elements)
디렉토리(dictionaries)를 저장하는 경우, `dictionaryObject.removeValue(forKey:)`를 사용하여 요소를 제거할 수 있습니다. 이는 JSON 객체를 제자리에서(in place) 변형합니다.
예를 들어:
```swift
var object = JSON([
"one": ["color": "blue"],
"two": ["city": "tokyo",
"country": "japan",
"foods": [
"breakfast": "tea",
"lunch": "sushi"
]
]
])
```
`country` 키를 제거해 보겠습니다:
```swift
object["two"].dictionaryObject?.removeValue(forKey: "country")
```
`print(object)`를 실행하면, `country` 키가 더 이상 존재하지 않는 것을 확인할 수 있습니다.
```json
{
"one" : {
"color" : "blue"
},
"two" : {
"city" : "tokyo",
"foods" : {
"breakfast" : "tea",
"lunch" : "sushi"
}
}
}
```
이는 중첩된 디렉토리에서도 작동합니다:
```swift
object["two"]["foods"].dictionaryObject?.removeValue(forKey: "breakfast")
```
```json
{
"one" : {
"color" : "blue"
},
"two" : {
"city" : "tokyo",
"foods" : {
"lunch" : "sushi"
}
}
}
```
## 문자열 표현 (String representation)
사용 가능한 두 가지 옵션이 있습니다:
- 기본 Swift 방식 사용
- 옵셔널을 잘 처리하고 `nil`을 `"null"`로 표현하는 사용자 정의 방식 사용:
```swift
let dict = ["1":2, "2":"two", "3": nil] as [String: Any?]
let json = JSON(dict)
let representation = json.rawString(options: [.castNilToNSNull: true])
// representation은 "{\"1\":2,\"2\":\"two\",\"3\":null}"이며, 이는 {"1":2,"2":"two","3":null}을 나타냄
```
## [Alamofire](https://github.com/Alamofire/Alamofire)와 함께 사용하기
SwiftyJSON은 Alamofire JSON 응답 핸들러의 결과를 깔끔하게 감싸줍니다:
```swift
Alamofire.request(url, method: .get).validate().responseJSON { response in
switch response.result {
case .success(let value):
let json = JSON(value)
print("JSON: \(json)")
case .failure(let error):
print(error)
}
}
```
또한 NSData를 SwiftyJSON의 JSON으로 직렬화하기 위한 Alamofire 확장(extension)도 제공하고 있습니다.
참조: [Alamofire-SwiftyJSON](https://github.com/SwiftyJSON/Alamofire-SwiftyJSON)
## [Moya](https://github.com/Moya/Moya)와 함께 사용하기
SwiftyJSON은 데이터를 JSON으로 파싱합니다:
```swift
let provider = MoyaProvider()
provider.request(.showProducts) { result in
switch result {
case let .success(moyaResponse):
let data = moyaResponse.data
let json = JSON(data: data) // 네트워크 데이터를 json으로 변환
print(json)
case let .failure(error):
print("error: \(error)")
}
}
```
## SwiftyJSON 모델 생성기 (SwiftyJSON Model Generator)
SwiftyJSON 모델을 생성하기 위한 도구들
\* [JSON Export](https://github.com/Ahmed-Ali/JSONExport)