NSTEasyJSON
Inpired by SwiftyJSON. NSTEasyJSON makes it easy to deal with JSON data in Objective-C.
Why is the typical JSON handling in Objective-C NOT good?
Objective-C is not very strict about types, but even without strictness we cannot save time because we have to check types ourselves for safety.
Take the Twitter API for example. Say we want to retrieve a user's "name" value of some tweet in Objective-C (according to Twitter's API https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline).
The code would look like this:
NSDictionary *dictionary = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingAllowFragments error:&error];
NSString *user = dictionary[@"user"];
// Now we got the username
// But is it NSString for sure?
We got the username in 2 lines, but will JSON always be NSDictionary? Can API send null as value for user key? To be safe we need to add some lines:
NSDictionary *dictionary = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingAllowFragments error:&error];
if (![dictionary isKindOfClass:[NSDictionary class]]) {
// Print the error
}
NSString *user = dictionary[@"user"];
if (![user isKindOfClass:[NSString class]]) {
// Print the error
}
// There's our username
It's simple, but it boilerplate for sure!
With NSTEasyJSON all you have to do is:
NSTEasyJSON *JSON = [NSTEasyJSON withData:dataFromNetworking];
NSString *userName = JSON[0]["user"]["name"].string;
// Now you got your value
And don't worry about the NSNull, out of bounds or other unexpected things. It's done for you automatically.
Requirements
- iOS 7.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+
- Xcode 7
Integration
CocoaPods (iOS 7+, OS X 10.9+)
You can use CocoaPods to install NSTEasyJSON by adding it to your Podfile:
platform :ios, '7.0'
target 'MyApp' do
pod 'NSTEasyJSON'
end
Manually (iOS 7+, OS X 10.9+)
To use this library in your project manually you may:
- for Projects, just drag NSTEasyJSON.{h,m} to the project tree
- for Workspaces, include the whole NSTEasyJSON.xcodeproj
Usage
Initialization
#import "NSTEasyJSON.h"
NSTEasyJSON *JSON = [NSTEasyJSON withData:dataFromNetworking];
NSTEasyJSON *JSON = [NSTEasyJSON withObject:jsonObjectArrayOrMaybeDictionary];
Subscript
// Getting a double from a JSON Array
double name = JSON[0].doubleValue;
// Getting a string from a JSON Dictionary
NSString *name = json["name"].stringValue;
Optional getter
// NSNumber
NSNumber *number = JSON[@"user"][@"favourites_count"].number;
// NSString
NSString *string = JSON[@"user"][@"name"].string;
...
Non-optional getter
Non-optional getters are named xxxValue
// If not a Number or nil, return 0
NSNumber *number = JSON[@"user"][@"favourites_count"].numberValue;
// If not a String or nil, return ""
NSString *string = JSON[@"user"][@"name"].stringValue;
// If not an Array or nil, return @[]
NSArray *list = JSON[@"list"].arrayValue;
// If not a Dictionary or nil, return @{}
NSDictionary *dictionary = JSON[@"user"].dictionaryValue;
117 Sep 9, 2022
376 Nov 8, 2022
611 Oct 23, 2022
964 Dec 14, 2022
1.1k Jan 1, 2023
![[Deprecated] A shiny JSON parsing library in Swift :sparkles: Loved by many from 2015-2021](https://github.com/hkellaway/Gloss/raw/main/img/Gloss_Logo_Word_Tagline.png){kind=logo}
1.6k Nov 24, 2022
4.1k Dec 29, 2022
799 Dec 6, 2022
1k Oct 15, 2022
2 Aug 10, 2022
454 Oct 30, 2022
8 Nov 22, 2022
0 Oct 29, 2021
43 Dec 15, 2022
31 Nov 22, 2021
3.8k Jan 5, 2023
3.5k Dec 20, 2022
2.6k Dec 29, 2022