NSUserDefaults removeObjectForKey vs. setObject:nil

Question

Are the following two lines equivalent?

1. [[NSUserDefaults standardUserDefaults] removeObjectForKey:@\"example key\"]

2. [[NSUserDefa

Answer 1

Swift 5.0 + iOS 11 and up

Both methods remove the value. Tried this in a playground:

import Foundation

let key = "Test"
let value = "test"
let defaults = UserDefaults.standard

func printUD() {
    print("UserDefaults after modification:\n")
    defaults.dictionaryRepresentation().forEach { print("\($0): \($1)\n") }
    print("-------------\n\n")
}

defaults.set(value, forKey: key); printUD()
defaults.set(nil, forKey: key); printUD()
defaults.set(value, forKey: key); printUD()
defaults.removeObject(forKey: key); printUD()

Prior to iOS 11 this will result in serializing nil into Data and throw an error.

Answer 2

Swift 3.0

The below answer is no longer the case when I tested this. When set to nil the result is NSCFData being stored. Possibly an NSNull object reference, but I am not positive.

To completely remove a value for a key use UserDefaults.standard.removeObject(forKey: "YourDefault")

I tested with the following code:

UserDefaults.standard.set(["a", "b", "c"], forKey: "MyDefaults")
print("Test A: My saved defaults \(UserDefaults.standard.object(forKey: "MyDefaults"))")

UserDefaults.standard.set(nil, forKey: "MyDefaults")
print("Test B: My defaults set to nil \(UserDefaults.standard.object(forKey: "MyDefaults"))")

UserDefaults.standard.removeObject(forKey: "MyDefaults")
print("Test C: My defaults removed \(UserDefaults.standard.object(forKey: "MyDefaults"))")

Answer 3

Yes, both lines of code are equivalent, both will result in nil read

id obj = [[NSUserDefaults standardUserDefaults] objectForKey:@"example key"];

NSUserDefaults will return nil if the key was not found. I would recommend to use the removeObjectForKey instead of setting it to nil.

here is how to test if setting key value to nil removed the key entry from NSUserDefaults standardUserDefaults.

NSArray *keys = [[[NSUserDefaults standardUserDefaults] dictionaryRepresentation] allKeys] copy];
   for(NSString *key in keys) {
       NSLog(@"Key Name: %@", key);
}
[keys release];

or simply dump the key/value dictionary of NSUserDefaults standardUserDefaults

NSLog(@"All contents of NSUserDefaults: %@", [[NSUserDefaults standardUserDefaults] dictionaryRepresentation]);