如何在 NSUserDefaults 中存储自定义对象

How to store custom objects in NSUserDefaults

提问人:Ethan Mick 提问时间:2/23/2010 最后编辑:TheNeilEthan Mick 更新时间:7/9/2020 访问量:143180

问:

好吧,所以我一直在做一些闲逛,我意识到我的问题,但我不知道如何解决它。我做了一个自定义类来保存一些数据。我为这个班级制作了对象,我需要它们在会话之间持续存在。在我把我所有的信息都放进去之前,但这不起作用。NSUserDefaults

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

这是我将自定义类“Player”放在 .现在,我已经读到它显然只存储某些类型的信息。那么我如何让我的对象进入呢?NSUserDefaultsNSUserDefaultsNSUSerDefaults

我读到应该有一种方法可以“编码”我的自定义对象,然后将其放入其中,但我不确定如何实现它,将不胜感激!谢谢!

编辑****

好的,所以我使用了下面给出的代码(谢谢!),但我仍然遇到一些问题。基本上,代码现在崩溃了,我不知道为什么,因为它不会给出任何错误。也许我错过了一些基本的东西,我只是太累了,但我们会看到的。这是我的自定义类“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 文件的相关部分(我调用了 encryption 和 decrypt 函数):

@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;
}

哎呀,对不起所有的代码。只是想帮忙。基本上,该应用程序将启动,然后立即崩溃。我已经将范围缩小到应用程序的加密部分,这就是它崩溃的地方,所以我做错了什么,但我不确定是什么。再次感谢您的帮助,谢谢!

(我还没有开始解密,因为我还没有开始加密工作。

iOS Objective-C iPhone 编码 nsuserdefaults

评论

0赞 chrissr 2/24/2010
您是否有堆栈跟踪或有关崩溃的更多信息,例如导致崩溃的行号?我没有立即看到代码有任何问题,所以一个起点会有所帮助。
0赞 broot 1/28/2011
在上面的示例中,您使用了 encodeObject 来存储 self.life,这是一个 int。应改用 encodeInt。

答:

522赞 chrissr 2/23/2010 #1

在 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 中保存类

评论

0赞 Ethan Mick 2/24/2010
编辑了我上面的帖子以反映我的更改。
0赞 Maggie 11/6/2011
@chrissr NSUserDefaults defaults = [NSUserDefaults standardUserDefaults];...应为 NSUserDefaults *defaults。
2赞 BadPirate 5/1/2012
NSKeyedArchiver 摇滚...似乎它甚至会自动下降到 NSArray 或 NSDictionary 对象中,并对其中任何可编码的自定义对象进行编码。
2赞 Samhan Salahuddin 10/16/2012
我不是迂腐,只是一个真正的问题,在 init 方法中使用合成的 setter,即 self.property 不是违反苹果准则吗?
0赞 Erik B 10/30/2013
@eddardstark developer.apple.com/library/mac/documentation/Cocoa/Conceptual/......所以是的,你不应该这样做,但它通常是安全的。我认为我从未遇到过由init/dealloc中调用访问器方法引起的错误,并且我曾在几个项目中经常这样做。
0赞 Samhan Salahuddin 10/31/2013
@Erik B :- 我认为这与 KVO 有关。如果没有KVO参与,则其保险箱。
2赞 GoRoS 6/24/2014
@chrissr 请更改为 .变量不匹配。NSData *myEncodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];NSData *encodedObject = [NSKeyedArchiver archivedDataWithRootObject:object];
6赞 Muhammad Aamir Ali 3/1/2013 #2

同步已保存到 NSUserDefaults 中的数据/对象

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

希望这对你有所帮助。谢谢

评论

0赞 Hedylove 11/26/2016
请注意,从 Swift 3 开始,你根本不应该调用“synchronize”。
0赞 code4latte 6/8/2017
@JozemiteApps为什么呢?或者你能发布一个链接来解释这个主题吗?
0赞 Hedylove 6/8/2017
@code4latte我不知道它是否被更改了,但 Apple 的文档指出“synchronize() 方法定期自动调用,使内存缓存与用户的默认数据库保持同步。之前,它说只有在您确定需要立即保存数据时才应该调用它。我已经读过几次用户不应该再调用它了。
36赞 thomasdao 7/4/2013 #3

我创建了一个库 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 获取自定义 obj,请执行以下操作:

user = [defaults rm_customObjectForKey:@"SAVED_DATA"]; 

评论

0赞 Erik B 11/6/2013
库假定您具有要保留的所有内容的属性,并且希望保留具有属性的所有内容。如果这是真的,你的图书馆肯定会有所帮助,但我认为你会发现在很多情况下并非如此。
0赞 thomasdao 11/7/2013
仅持久化普通对象很有用,我想说它的用法与 Java 中的 Gson 非常相似。您正在研究哪些案例?
7赞 Albara 12/2/2013
这真的很有帮助,很高兴我一直在阅读答案;D
0赞 Shial 8/16/2014
当我的自定义对象在属性中具有其他自定义对象时怎么办?
0赞 thomasdao 8/18/2014
@Shial:如果将其他自定义对象设置为可存档,它也会被保存
0赞 Lean-Juc Dicarp 12/7/2015
如我所见,您的库 RMMapper 向 NSObject 添加了类别,以便每个 NSObject 都实现了“encodeWithCoder”和“initWithCoder”方法。复制类别将“copyWithZone”添加到每个 NSObject 实例。请注意,已经实现这些方法的现有类(也来自 Apple)可能会遇到麻烦。不应“覆盖”类别中的现有方法。如果我错了,请纠正我。
9赞 Carlos P 9/3/2014 #4

获取@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"];
31赞 Ankit Goel 1/29/2016 #5

如果有人正在寻找 swift 版本:

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]
        }

注意:在这里,我将保存和检索自定义类对象的数组。

7赞 Vyacheslav 4/13/2017 #6

斯威夫特 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
        }

评论

0赞 Tamás Sengel 10/17/2017
只是提醒一下:在 和 中的变量之前不是强制性的。selfinitencode
0赞 Abhishek Thapliyal 2/8/2018
您能否展示如何使用 NSCoder 初始化对象
0赞 Vyacheslav 2/8/2018
@AbhishekThapliyal,我不理解你。init(coder aDecoder: NSCoder) 初始化它
37赞 Sergiu Todirascu 1/2/2018 #7

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赞 Nathan Barreto 1/30/2018
像魅力一样工作
0赞 BallpointBen 6/7/2018
请注意,只有当所有实例成员都是自己时,您才能免费获得该行为 - 否则,您必须自己编写一些编码代码,CodableCodable
1赞 Sergiu Todirascu 6/8/2018
或者更确切地说,只是使这些成员类型也符合。依此类推,递归。只有在非常自定义的情况下,您才需要编写编码代码。Codable
0赞 alstr 1/21/2019
使用 Swift 4 的最简单方法。