Как хранить пользовательские объекты в NSUserDefaults

268

Хорошо, я немного покопался и понял свою проблему, но не знаю, как ее исправить. Я сделал пользовательский класс для хранения некоторых данных. Я делаю объекты для этого класса, и мне нужно, чтобы они длились между сессиями. До того, как я положил всю свою информацию NSUserDefaults, но это не работает.

-[NSUserDefaults setObject:forKey:]: Attempt to insert non-property value '<Player: 0x3b0cc90>' of class 'Player'.

Это сообщение об ошибке, которое я получаю, когда помещаю свой пользовательский класс "Player" в NSUserDefaults. Теперь я прочитал, что, по-видимому, NSUserDefaultsхранит только некоторые виды информации. Так как же мне получить мои объекты NSUSerDefaults?

Я прочитал, что должен быть способ «кодировать» мой пользовательский объект, а затем вставить его, но я не уверен, как его реализовать, помощь будет принята! Спасибо!

****РЕДАКТИРОВАТЬ****

Хорошо, поэтому я работал с кодом, приведенным ниже (спасибо!), Но у меня все еще есть некоторые проблемы. По сути, сейчас происходит сбой кода, и я не уверен почему, потому что он не дает никаких ошибок. Возможно, мне не хватает чего-то простого, и я слишком устал, но посмотрим. Вот реализация моего пользовательского класса «Player»:

@interface Player : NSObject {
    NSString *name;
    NSNumber *life;
    //Log of player's life
}
//Getting functions, return the info
- (NSString *)name;
- (int)life;


- (id)init;

//These are the setters
- (void)setName:(NSString *)input; //string
- (void)setLife:(NSNumber *)input; //number    

@end

Файл реализации:

#import "Player.h"
@implementation Player
- (id)init {
    if (self = [super init]) {
        [self setName:@"Player Name"];
        [self setLife:[NSNumber numberWithInt:20]];
        [self setPsnCounters:[NSNumber numberWithInt:0]];
    }
    return self;
}

- (NSString *)name {return name;}
- (int)life {return [life intValue];}
- (void)setName:(NSString *)input {
    [input retain];
    if (name != nil) {
        [name release];
    }
    name = input;
}
- (void)setLife:(NSNumber *)input {
    [input retain];
    if (life != nil) {
        [life release];
    }
    life = input;
}
/* This code has been added to support encoding and decoding my objecst */

-(void)encodeWithCoder:(NSCoder *)encoder
{
    //Encode the properties of the object
    [encoder encodeObject:self.name forKey:@"name"];
    [encoder encodeObject:self.life forKey:@"life"];
}

-(id)initWithCoder:(NSCoder *)decoder
{
    self = [super init];
    if ( self != nil )
    {
        //decode the properties
        self.name = [decoder decodeObjectForKey:@"name"];
        self.life = [decoder decodeObjectForKey:@"life"];
    }
    return self;
}
-(void)dealloc {
    [name release];
    [life release];
    [super dealloc];
}
@end

Так что это мой класс, довольно прямолинейный, я знаю, что он помогает создавать мои объекты. Итак, вот соответствующие части файла AppDelegate (где я вызываю функции шифрования и дешифрования):

@class MainViewController;

@interface MagicApp201AppDelegate : NSObject <UIApplicationDelegate> {
    UIWindow *window;
    MainViewController *mainViewController;
}

@property (nonatomic, retain) IBOutlet UIWindow *window;
@property (nonatomic, retain) MainViewController *mainViewController;

-(void)saveCustomObject:(Player *)obj;
-(Player *)loadCustomObjectWithKey:(NSString*)key;


@end

А затем важные части файла реализации:

    #import "MagicApp201AppDelegate.h"
    #import "MainViewController.h"
    #import "Player.h"

    @implementation MagicApp201AppDelegate


    @synthesize window;
    @synthesize mainViewController;


    - (void)applicationDidFinishLaunching:(UIApplication *)application {
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
        //First check to see if some things exist
        int startup = [prefs integerForKey:@"appHasLaunched"];
        if (startup == nil) {
//Make the single player 
        Player *singlePlayer = [[Player alloc] init];
        NSLog([[NSString alloc] initWithFormat:@"%@\n%d\n%d",[singlePlayer name], [singlePlayer life], [singlePlayer psnCounters]]); //  test
        //Encode the single player so it can be stored in UserDefaults
        id test = [MagicApp201AppDelegate new];
        [test saveCustomObject:singlePlayer];
        [test release];
}
[prefs synchronize];
}

-(void)saveCustomObject:(Player *)object
{ 
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
    NSData *myEncodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];
    [prefs setObject:myEncodedObject forKey:@"testing"];
}

-(Player *)loadCustomObjectWithKey:(NSString*)key
{
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
    NSData *myEncodedObject = [prefs objectForKey:key ];
    Player *obj = (Player *)[NSKeyedUnarchiver unarchiveObjectWithData: myEncodedObject];
    return obj;
}

Ээээ, извините за весь код. Просто пытаюсь помочь. По сути, приложение запустится, а затем сразу же выйдет из строя. Я сузил его до части приложения с шифрованием, где он и падает, так что я делаю что-то не так, но я не уверен, что именно. Помощь будет оценена еще раз, спасибо!

(Я еще не дошел до дешифрования, так как пока не работал шифрование.)

Итан Мик
источник
Есть ли у вас трассировка стека или дополнительная информация о сбое, например, какой номер строки вызывает сбой? Я не сразу вижу что-то не так с кодом, поэтому будет полезна отправная точка.
chrissr
В приведенном выше примере вы использовали encodeObject для хранения self.life, который является int. Вместо этого вы должны использовать encodeInt.
Broot

Ответы:

516

В своем классе Player реализуйте следующие два метода (заменив вызовы encodeObject чем-то соответствующим вашему собственному объекту):

- (void)encodeWithCoder:(NSCoder *)encoder {
    //Encode properties, other class variables, etc
    [encoder encodeObject:self.question forKey:@"question"];
    [encoder encodeObject:self.categoryName forKey:@"category"];
    [encoder encodeObject:self.subCategoryName forKey:@"subcategory"];
}

- (id)initWithCoder:(NSCoder *)decoder {
    if((self = [super init])) {
        //decode properties, other class vars
        self.question = [decoder decodeObjectForKey:@"question"];
        self.categoryName = [decoder decodeObjectForKey:@"category"];
        self.subCategoryName = [decoder decodeObjectForKey:@"subcategory"];
    }
    return self;
}

Чтение и запись от NSUserDefaults:

- (void)saveCustomObject:(MyObject *)object key:(NSString *)key {
    NSData *encodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    [defaults setObject:encodedObject forKey:key];
    [defaults synchronize];

}

- (MyObject *)loadCustomObjectWithKey:(NSString *)key {
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    NSData *encodedObject = [defaults objectForKey:key];
    MyObject *object = [NSKeyedUnarchiver unarchiveObjectWithData:encodedObject];
    return object;
}

Код безбожно заимствован из: сохранение класса в nsuserdefaults

chrissr
источник
Отредактировал мой пост выше, чтобы отразить мои изменения.
Итан Мик
@chrissr у вас есть ошибка в NSUserDefaults defaults = [NSUserDefaults standardUserDefaults]; ... должно быть NSUserDefaults * по умолчанию.
Мэгги
2
NSKeyedArchiver качается ... кажется, он даже автоматически спускается в объекты NSArray или NSDictionary и кодирует любые кодируемые пользовательские объекты внутри.
BadPirate
2
Я не педантичен, просто настоящий вопрос, разве это не противоречит правилам Apple по использованию синтезированных сеттеров, то есть self.property в методах init?
Самхан Салахуддин
2
@chrissr Пожалуйста, измените NSData *myEncodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];на NSData *encodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];. Переменные не совпадают.
GoRoS
36

Я создаю библиотеку RMMapper ( https://github.com/roomorama/RMMapper ), чтобы легче и удобнее сохранять пользовательский объект в NSUserDefaults, потому что реализация encodeWithCoder и initWithCoder супер скучна!

Чтобы пометить класс как архивируемый, просто используйте: #import "NSObject+RMArchivable.h"

Чтобы сохранить пользовательский объект в NSUserDefaults:

#import "NSUserDefaults+RMSaveCustomObject.h"
NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
[defaults rm_setCustomObject:user forKey:@"SAVED_DATA"];

Чтобы получить пользовательский объект из NSUserDefaults:

user = [defaults rm_customObjectForKey:@"SAVED_DATA"]; 
thomasdao
источник
Ваша библиотека предполагает, что у вас есть свойства для всего, что вы хотите сохранить, и что вы хотите сохранить все, для чего у вас есть свойства. Если это правда, ваша библиотека может быть полезна, но я думаю, вы обнаружите, что во многих случаях это не так.
Эрик Б
Полезно сохранять только простой объект, я бы сказал, что его использование очень похоже на Gson в Java. В каких случаях вы смотрите?
Томасдао
7
Это было действительно полезно, рад, что я продолжал читать ответы; D
Альбара
как насчет того, когда мой пользовательский объект имеет в свойстве другой пользовательский объект?
Шиал
@Shial: если вы сделаете другой пользовательский объект архивируемым, он тоже будет сохранен
thomasdao
35

Swift 4

Введен протокол Codable , который делает всю магию для подобных задач. Просто приведите в соответствие вашу пользовательскую структуру / класс:

struct Player: Codable {
  let name: String
  let life: Double
}

А для хранения по умолчанию вы можете использовать PropertyListEncoder / Decoder :

let player = Player(name: "Jim", life: 3.14)
UserDefaults.standard.set(try! PropertyListEncoder().encode(player), forKey: kPlayerDefaultsKey)

let storedObject: Data = UserDefaults.standard.object(forKey: kPlayerDefaultsKey) as! Data
let storedPlayer: Player = try! PropertyListDecoder().decode(Player.self, from: storedObject)

Так будет работать и для массивов и других контейнерных классов таких объектов:

try! PropertyListDecoder().decode([Player].self, from: storedArray)
Серджиу Тодираску
источник
1
Работает как шарм
Натан Баррето
Обратите внимание, что вы получаете Codableповедение бесплатно только тогда, когда все члены экземпляра сами Codable- иначе вы должны написать код самостоятельно,
BallpointBen
1
Или, скорее, просто соотнесите эти типы членов Codableтоже. И так далее, рекурсивно. Только в очень нестандартных случаях вам потребуется написать код кодировки.
Сергей Тодираску
Самый простой способ с Swift 4.
Alstr
31

Если кто-то ищет быструю версию:

1) Создайте собственный класс для ваших данных

class customData: NSObject, NSCoding {
let name : String
let url : String
let desc : String

init(tuple : (String,String,String)){
    self.name = tuple.0
    self.url = tuple.1
    self.desc = tuple.2
}
func getName() -> String {
    return name
}
func getURL() -> String{
    return url
}
func getDescription() -> String {
    return desc
}
func getTuple() -> (String,String,String) {
    return (self.name,self.url,self.desc)
}

required init(coder aDecoder: NSCoder) {
    self.name = aDecoder.decodeObjectForKey("name") as! String
    self.url = aDecoder.decodeObjectForKey("url") as! String
    self.desc = aDecoder.decodeObjectForKey("desc") as! String
}

func encodeWithCoder(aCoder: NSCoder) {
    aCoder.encodeObject(self.name, forKey: "name")
    aCoder.encodeObject(self.url, forKey: "url")
    aCoder.encodeObject(self.desc, forKey: "desc")
} 
}

2) Для сохранения данных используйте следующую функцию:

func saveData()
    {
        let data  = NSKeyedArchiver.archivedDataWithRootObject(custom)
        let defaults = NSUserDefaults.standardUserDefaults()
        defaults.setObject(data, forKey:"customArray" )
    }

3) Извлечь:

if let data = NSUserDefaults.standardUserDefaults().objectForKey("customArray") as? NSData
        {
             custom = NSKeyedUnarchiver.unarchiveObjectWithData(data) as! [customData]
        }

Примечание. Здесь я сохраняю и извлекаю массив объектов пользовательских классов.

Анкит Гоэль
источник
9

Взяв ответ @ chrissr и выполняя его, этот код можно внедрить в удобную категорию NSUserDefaultsдля сохранения и извлечения пользовательских объектов:

@interface NSUserDefaults (NSUserDefaultsExtensions)

- (void)saveCustomObject:(id<NSCoding>)object
                     key:(NSString *)key;
- (id<NSCoding>)loadCustomObjectWithKey:(NSString *)key;

@end


@implementation NSUserDefaults (NSUserDefaultsExtensions)


- (void)saveCustomObject:(id<NSCoding>)object
                     key:(NSString *)key {
    NSData *encodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];
    [self setObject:encodedObject forKey:key];
    [self synchronize];

}

- (id<NSCoding>)loadCustomObjectWithKey:(NSString *)key {
    NSData *encodedObject = [self objectForKey:key];
    id<NSCoding> object = [NSKeyedUnarchiver unarchiveObjectWithData:encodedObject];
    return object;
}

@end

Использование:

[[NSUserDefaults standardUserDefaults] saveCustomObject:myObject key:@"myKey"];
Карлос П
источник
7

Свифт 3

class MyObject: NSObject, NSCoding  {
    let name : String
    let url : String
    let desc : String

    init(tuple : (String,String,String)){
        self.name = tuple.0
        self.url = tuple.1
        self.desc = tuple.2
    }
    func getName() -> String {
        return name
    }
    func getURL() -> String{
        return url
    }
    func getDescription() -> String {
        return desc
    }
    func getTuple() -> (String, String, String) {
        return (self.name,self.url,self.desc)
    }

    required init(coder aDecoder: NSCoder) {
        self.name = aDecoder.decodeObject(forKey: "name") as? String ?? ""
        self.url = aDecoder.decodeObject(forKey: "url") as? String ?? ""
        self.desc = aDecoder.decodeObject(forKey: "desc") as? String ?? ""
    }

    func encode(with aCoder: NSCoder) {
        aCoder.encode(self.name, forKey: "name")
        aCoder.encode(self.url, forKey: "url")
        aCoder.encode(self.desc, forKey: "desc")
    }
    }

хранить и извлекать:

func save() {
            let data  = NSKeyedArchiver.archivedData(withRootObject: object)
            UserDefaults.standard.set(data, forKey:"customData" )
        }
        func get() -> MyObject? {
            guard let data = UserDefaults.standard.object(forKey: "customData") as? Data else { return nil }
            return NSKeyedUnarchiver.unarchiveObject(with: data) as? MyObject
        }
Вячеслав
источник
Просто напоминание: selfне обязательно перед переменными в initи encode.
Тамас Сенгель
Можете ли вы показать, как вы инициализируете объект с помощью NSCoder
Abhishek Thapliyal
@AbhishekThapliyal, я не понимаю тебя. init (кодировщик aDecoder: NSCoder) инициализирует его
Вячеслав
6

Синхронизируйте данные / объект, который вы сохранили в NSUserDefaults

-(void)saveCustomObject:(Player *)object
{ 
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
    NSData *myEncodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];
    [prefs setObject:myEncodedObject forKey:@"testing"];
    [prefs synchronize];
}

Надеюсь, что это поможет вам. Спасибо

Мухаммед Амир Али
источник
Обратите внимание на людей из будущего, что с Swift 3 «синхронизация» вообще не должна вызываться вами.
Хосе Рамирес
@JozemiteApps почему? или можете выложить ссылку с объяснением по этой теме?
code4latte
@ code4latte Я не знаю, было ли оно изменено, но в документации Apple говорится, что «метод synchronize (), который автоматически вызывается через определенные промежутки времени, синхронизирует кэш в памяти с базой данных пользователя по умолчанию». Ранее говорилось, что вам следует называть его только в том случае, если вы уверены, что данные должны быть сохранены мгновенно. Я прочитал пару раз, что пользователь не должен больше это называть.
Хосе Рамирес