TouchJSON, dealing with NSNull

Question

Hi I am using TouchJSON to deserialize some JSON. I have been using it in the past and on those occasions I dealt with occurrences of NSNull manually. I would think the author had to deal with this as well, so me doing that again would just be overhead. I then found this in the documentation:

Avoiding NSNull values in output.

NSData *theJSONData = /* some JSON data */
CJSONDeserializer *theDeserializer = [CJSONDeserializer deserializer];
theDeserializer.nullObject = NULL;
NSError *theError = nil;
id theObject = [theDeserializer deserialize:theJSONData error:&theError];}

The way I understand it the user of the class can pass a C-style null pointer to the deserializer and when it encounters a NSNull it will insert the values (NULL) passed to it. So later on when I use the values I won't get NSNull, but NULL.

This seems strange, the return value is an NSDictionary which can only contain Objects, shouldn't the value default to 'nil' instead?

If it is NULL can I check the values like this?

if([jsonDataDict objectForKey:someKey] == NULL)

It would seem more logically to be able to do this:

if(![jsonDataDict objectForKey:someKey])

No to mention all the cases where passing nil is allowed but passing NULL causes a crash.

Or can I just pass 'nil' to the deserializer?

Much of this stems from me still struggling with nil, NULL, [NSNULL null], maybe I am failing to see the potential caveats in using nil.

I commented below, but for the sake of posterity on this question, NSDictionary *cannot* contain nil as a key OR a value. From the Cocoa docs: "Neither a key nor a value can be nil; if you need to represent a null value in a dictionary, you should use NSNull." — Erik, Aug 10 '12 at 03:51

Wolfgang Schreurs · Answer 1 · 2011-04-19T17:31:10.093

48

For another JSON library, but with the same issues, I've created the following category on NSDictionary:

@implementation NSDictionary (Utility)

// in case of [NSNull null] values a nil is returned ...
- (id)objectForKeyNotNull:(id)key {
   id object = [self objectForKey:key];
   if (object == [NSNull null])
      return nil;

   return object;
}

@end

Whenever I deal with JSON data from said library, I retrieve values like this:

NSString *someString = [jsonDictionary objectForKeyNotNull:@"SomeString"];

This way the code in my projects become a lot cleaner and at the same time I don't have to think about dealing with [NSNull null] values and the like.

edited Apr 19 '11 at 17:31

answered Apr 19 '11 at 16:14

Wolfgang Schreurs

11,779
7
51
92

Thanks Wolfgang. I can see the need for that category if your JSON library of choice does not offer the "nullObject". It is a mess dealing with NSNull every time you have to access your +15 properties Model Entity:) – RickiG Apr 19 '11 at 18:15
This is a good way to do it (and in fact how I do it in my own apps). The advantage of this is that you can still check if a key exists in a dictionary with a null value; with TouchJSON's `nullObject` set to nil, you can't distinguish between a null value and a missing key. – Daniel Dickison Apr 19 '11 at 19:26
Key value coding will translate between NSNull and nil in collections for you. https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/KeyValueCoding/Articles/BasicPrinciples.html#//apple_ref/doc/uid/20002170-178726 – quellish Aug 02 '14 at 07:41

score 15 · Accepted Answer · answered Apr 19 '11 at 16:02

nil and NULL are actually both equal to zero, so they are, in practice, interchangeable. But you're right, for consistency, the documentation for TouchJSON should have used theDeserializer.nullObject = nil instead of NULL.

Now, when you do that, your second predicate actually works fine:

if (![jsonDataDict objectForKey:someKey])

because TouchJSON omits the key from the dictionary when you have nullObject set to nil (or NULL). When the key doesn't exist in the dictionary, NSDictionary returns nil, which is zero so your if condition works as you expect.

If you don't specify nullObject as nil, you can instead check for null like so:

if ([jsonDataDict objectForKey:someKey] == [NSNull null])

Thanks, that answers it perfectly, as long as I can consistently expect a nil value to be returned I'll be fine. — RickiG, Apr 19 '11 at 18:13

score 0 · Answer 3 · answered Apr 13 '17 at 15:24

There are libraries which deal with it. One of them is SwiftyJSON in Swift, another one is NSTEasyJSON in Objective-C. With this library (NSTEasyJSON) it will be easy to deal with such problems. In your case you can just check values you need:

NSTEasyJSON *JSON = [NSTEasyJSON withData:JSONData];
NSString *someValue = JSON[someKey].string;

This value will be NSString or nil and you should not check it for NSNull, NULL yourself.

TouchJSON, dealing with NSNull

3 Answers3

Linked