Skip to content

Big performance improvement on JSON setter and getter #1183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
b5i wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Big performance improvement on JSON setter and getter #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2ef7d0
perf: use direct access to rawDictionary and rawArray instead of recu…
b5i May 28, 2025
36fbf53
Merge branch 'master' of https://github.com/b5i/SwiftyJSON
b5i May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
235 changes: 145 additions & 90 deletions Source/SwiftyJSON/SwiftyJSON.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ public enum SwiftyJSONError: Int, Swift.Error {
case wrongType = 901
case notExist = 500
case invalidJSON = 490

fileprivate func getJSON() -> JSON {
var json = JSON.null
json.error = self
return json
}
}

extension SwiftyJSONError: CustomNSError {
Expand Down Expand Up @@ -361,100 +367,72 @@ extension String: JSONSubscriptType {
}

extension JSON {
/**
Find a json in the complex data structures by using array of Int and/or String as path.

Example:

```swift
let json = JSON[data]
let path = [9,"list","person","name"]
let name = json[path]
```

Produce the same result as:
```swift
let name = json[9]["list"]["person"]["name"]
```

/// If `type` is `.array`, return json whose object is `array[index]`, otherwise return null json with error.
fileprivate subscript(index index: Int) -> JSON {
get {
if type != .array {
var r = JSON.null
r.error = self.error ?? SwiftyJSONError.wrongType
return r
} else if rawArray.indices.contains(index) {
return JSON(rawArray[index])
} else {
var r = JSON.null
r.error = SwiftyJSONError.indexOutOfBounds
return r
}
}
set {
if type == .array &&
rawArray.indices.contains(index) &&
newValue.error == nil {
rawArray[index] = newValue.object
}
}
}

/// If `type` is `.dictionary`, return json whose object is `dictionary[key]` , otherwise return null json with error.
fileprivate subscript(key key: String) -> JSON {
But prefer using the first version if you access more than one level at a time.

- parameter path: The target json's path.

- returns: Return a json found by the path or a null json with error
*/
public subscript(path: [JSONSubscriptType]) -> JSON {
get {
var r = JSON.null
if type == .dictionary {
if let o = rawDictionary[key] {
r = JSON(o)
} else {
r.error = SwiftyJSONError.notExist
var currentObject: Any = self.object

for pathElement in path {
switch pathElement.jsonKey {
case .index(let index):
guard let castedCurrentObject = currentObject as? Array<Any> else {
return self.error != nil ? self : SwiftyJSONError.wrongType.getJSON()
}

guard castedCurrentObject.indices.contains(index) else {
return self.error != nil ? self : SwiftyJSONError.indexOutOfBounds.getJSON()
}

currentObject = castedCurrentObject[index]
case .key(let key):
guard let castedCurrentObject = currentObject as? Dictionary<String, Any> else {
return self.error != nil ? self : SwiftyJSONError.wrongType.getJSON()
}

guard let newValue = castedCurrentObject[key] else {
return self.error != nil ? self : SwiftyJSONError.notExist.getJSON()
}

currentObject = newValue
}
} else {
r.error = self.error ?? SwiftyJSONError.wrongType
}
return r
}
set {
if type == .dictionary && newValue.error == nil {
rawDictionary[key] = newValue.object
}
}
}

/// If `sub` is `Int`, return `subscript(index:)`; If `sub` is `String`, return `subscript(key:)`.
fileprivate subscript(sub sub: JSONSubscriptType) -> JSON {
get {
switch sub.jsonKey {
case .index(let index): return self[index: index]
case .key(let key): return self[key: key]
}

return JSON(currentObject)
}
set {
switch sub.jsonKey {
case .index(let index): self[index: index] = newValue
case .key(let key): self[key: key] = newValue
}
}
}

/**
Find a json in the complex data structures by using array of Int and/or String as path.

Example:

```swift
let json = JSON[data]
let path = [9,"list","person","name"]
let name = json[path]
```

The same as: let name = json[9]["list"]["person"]["name"]

- parameter path: The target json's path.

- returns: Return a json found by the path or a null json with error
*/
public subscript(path: [JSONSubscriptType]) -> JSON {
get {
return path.reduce(self) { $0[sub: $1] }
}
set {
switch path.count {
case 0: return
case 1: self[sub:path[0]].object = newValue.object
default:
var aPath = path
aPath.remove(at: 0)
var nextJSON = self[sub: path[0]]
nextJSON[aPath] = newValue
self[sub: path[0]] = nextJSON
guard let head = path.first else { return }

switch head.jsonKey {
case .index(_):
if type == .array && newValue.error == nil {
try? self.rawArray.set(newValue.object, at: path)
}

case .key(_):
if type == .dictionary && newValue.error == nil {
try? self.rawDictionary.set(newValue.object, at: path)
}
}
}
}
Expand All @@ -466,12 +444,14 @@ extension JSON {
```swift
let name = json[9,"list","person","name"]
```
The same as:
Produce the same result as:
```swift
let name = json[9]["list"]["person"]["name"]
```

But prefer using the first version if you access more than one level at a time.

- returns: Return a json found by the path or a null json with error
*/
public subscript(path: JSONSubscriptType...) -> JSON {
Expand All @@ -484,6 +464,81 @@ extension JSON {
}
}

// MARK: - Dictionary and Array recursive setters

extension Dictionary where Key == String, Value == Any {
/// Recursively set `newValue` at the location described by `path`.
///
/// - Parameters:
/// - path: An array like `["user", "entities", "url", "urls", 0, "indices"]`
/// - newValue: The value you want to put there.
internal mutating func set(_ newValue: Any, at path: [JSONSubscriptType]) throws {
guard !path.isEmpty else { return }
var path = path
let head = path.removeFirst()

switch head.jsonKey {
case .key(let k):
if path.isEmpty {
self[k] = newValue
} else {
guard let next: Any = self[k] else { throw SwiftyJSONError.notExist }

switch next {
case var dict as [String: Any]:
try dict.set(newValue, at: path)
self[k] = dict
case var array as [Any]:
try array.set(newValue, at: path)
self[k] = array
default:
throw SwiftyJSONError.wrongType
}

}
default:
throw SwiftyJSONError.wrongType
}
}
}

extension Array where Element == Any {
/// Recursively set `newValue` at the location described by `path`.
///
/// - Parameters:
/// - path: An array like `[0, "entities", "url", "urls", 0, "indices"]`
/// - newValue: The value you want to put there.
internal mutating func set(_ newValue: Any, at path: [JSONSubscriptType]) throws {
guard !path.isEmpty else { return }
var path = path
let head = path.removeFirst()

switch head.jsonKey {
case .index(let i):
guard self.indices.contains(i) else { throw SwiftyJSONError.indexOutOfBounds }

if path.isEmpty {
self[i] = newValue
} else {
let next = self[i]

switch next {
case var dict as [String: Any]:
try dict.set(newValue, at: path)
self[i] = dict
case var array as [Any]:
try array.set(newValue, at: path)
self[i] = array
default:
throw SwiftyJSONError.wrongType
}
}
default:
throw SwiftyJSONError.wrongType
}
}
}

// MARK: - LiteralConvertible

extension JSON: Swift.ExpressibleByStringLiteral {
Expand Down
38 changes: 37 additions & 1 deletion Tests/SwiftJSONTests/ArrayTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
// THE SOFTWARE.

import XCTest
import SwiftyJSON
@testable import SwiftyJSON

class ArrayTests: XCTestCase {

Expand All @@ -42,4 +42,40 @@ class ArrayTests: XCTestCase {
XCTAssertEqual((json.array![0] as JSON).string!, "111")
XCTAssertEqual((json.array![1] as JSON).string!, "222")
}

func testCustomArraySetter() throws {
// top level setter test
var array: [Any] = ["oldValue"]
try array.set("newValue", at: [0])
XCTAssertEqual(array[0] as? String, "newValue")

// nested value test
array = [
["entities": [
"url": [
"urls": [
["indices": [0, 1]]
]
]
]]
]
let newIndices = [7, 14]
let path: [JSONSubscriptType] = [0, "entities", "url", "urls", 0, "indices"]
try array.set(newIndices, at: path)
let extracted = (((array[0] as? [String: Any])?[
"entities"
] as? [String: Any])?["url"] as? [String: Any])?["urls"] as? [[String: Any]]
let result = extracted?[0]["indices"] as? [Int]
XCTAssertEqual(result, newIndices)

array = []
XCTAssertThrowsError(try array.set("value", at: [0])) { error in
XCTAssertEqual(error as? SwiftyJSONError, .indexOutOfBounds)
}

array = ["notAContainer"]
XCTAssertThrowsError(try array.set("value", at: [0, "entities"])) { error in
XCTAssertEqual(error as? SwiftyJSONError, .wrongType)
}
}
}
44 changes: 43 additions & 1 deletion Tests/SwiftJSONTests/DictionaryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
// THE SOFTWARE.

import XCTest
import SwiftyJSON
@testable import SwiftyJSON

class DictionaryTests: XCTestCase {

Expand Down Expand Up @@ -52,4 +52,46 @@ class DictionaryTests: XCTestCase {
json.dictionaryObject = ["name": "NAME"]
XCTAssertEqual(json.dictionaryObject! as! [String: String], ["name": "NAME"])
}

func testCustomRecursiveSetter() throws {
var dict: [String: Any] = [
"user": [
"entities": [
"url": [
"urls": [
[ "url": "http://example.com", "indices": [0, 23] ]
]
]
]
]
]

// top setter test
try dict.set("newValue", at: ["a"])
XCTAssertEqual(dict["a"] as? String, "newValue")

// nested values test
let newIndices = [5, 10]
let path: [JSONSubscriptType] = ["user", "entities", "url", "urls", 0, "indices"]

try dict.set(newIndices, at: path)
let result = (((((dict["user"] as? [String: Any])?["entities"] as? [String: Any])?["url"] as? [String: Any])?["urls"] as? [[String: Any]])?[0]["indices"]) as? [Int]
XCTAssertEqual(result, newIndices)

// missing key test
dict.removeAll()
XCTAssertThrowsError(
try dict.set("value", at: ["doesNotExist", "doesNotExist2"])
) { error in
XCTAssertEqual(error as? SwiftyJSONError, .notExist)
}

// wrong type test
dict = ["user": "notADictionary"]
XCTAssertThrowsError(
try dict.set("value", at: ["user", "entities"])
) { error in
XCTAssertEqual(error as? SwiftyJSONError, .wrongType)
}
}
}
Loading