您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 訊息 >> iOS 相關資訊

iOS 歸檔自訂物件:實作 NSCoding 協議的完整流程

編輯:iOS 相關資訊

在 Cocoa 中,要把資料歸檔到檔案,用的是 NSKeyedArchiver 的 archiveRootObject:toFile: 方法。對於一般資料類型,這個步驟非常簡單。Apple 官方文件中列出的可直接歸檔類型包括:

NSData
NSString
NSNumber
NSDate
NSArray
NSDictionary

很顯然,像 UIImage 這樣的複雜物件無法直接歸檔。變通做法是先將 UIImage 轉為 NSData,再對 NSData 進行歸檔。

註:準確地說,這與 iOS 版本有關。在 iOS 4 中 UIImage 尚未實作 NSCoding 協議,到了 iOS 5 才實作。

自訂類型也可以參考同樣的思路:先把自訂物件轉為 NSData,再歸檔。但問題來了——NSKeyedArchiver 在歸檔一個自訂物件時,怎麼知道該如何把它編碼成 NSData?而從檔案反歸檔時,NSKeyedUnarchiver 又怎麼知道該把 NSData 還原成哪個自訂類別?

NSCoding 協議的角色

這正是 NSCoding 協議要解決的問題。協議規定的兩個方法分別對應上述兩個問題:

  • NSKeyedArchiver 歸檔物件時,會呼叫物件的 encodeWithCoder:,把物件轉為 NSData(或 NSString 等其他五種類型)。
  • NSKeyedUnarchiver 反歸檔時,會呼叫物件的 initWithCoder:,把 NSData 等類型轉回指定的物件型別。

那六種類型之所以顯得簡單,是因為 Apple 已經幫我們實作了 NSCoding;自訂物件則必須由程式設計師自行實作。

定義自訂類別

@interface MyClass : NSObject <NSCoding>
@property (strong, nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (assign, nonatomic) BOOL sex;
@end

實作 NSCoding

@implementation MyClass
@synthesize name, age, sex;

-(void)encodeWithCoder:(NSCoder *)encoder {
    [encoder encodeObject:self.name forKey:@"name"];
    [encoder encodeObject:[NSNumber numberWithInt:self.age]  forKey:@"age"];
    [encoder encodeObject:[NSNumber numberWithBool:self.sex] forKey:@"sex"];
}

- (id)initWithCoder:(NSCoder *)decoder {
    if (self = [super init]) {
        self.name = [decoder decodeObjectForKey:@"name"];
        self.age  = ((NSNumber *)[decoder decodeObjectForKey:@"age"]).intValue;
        self.sex  = ((NSNumber *)[decoder decodeObjectForKey:@"sex"]).boolValue;
    }
    return self;
}
@end

encodeWithCoder: 中這兩行乍看有點多餘:

[encoder encodeObject:[NSNumber numberWithInt:self.age]  forKey:@"age"];
[encoder encodeObject:[NSNumber numberWithBool:self.sex] forKey:@"sex"];

但事實並非如此。encoder 只能對已實作 NSCoding 的物件進行編碼(也就是那六種類型之一),對 int、BOOL 這樣的純量類型無效。因此必須先把 age 與 sex 轉為 NSNumber。

同樣地,initWithCoder: 中解碼後也必須做型別轉換,才能賦值給原本屬性的類型:

self.age = ((NSNumber *)[decoder decodeObjectForKey:@"age"]).intValue;
self.sex = ((NSNumber *)[decoder decodeObjectForKey:@"sex"]).boolValue;

建立測試介面

接著用 NSKeyedArchiver / NSKeyedUnarchiver 對 MyClass 進行歸檔與反歸檔。打開 ViewController.xib 設計如下介面:

使用 Assistant Editor 建立必要的连线,此時 ViewController.h 如下:

#import "MyClass.h"

#define AppDocuments [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0]

@interface ViewController : UIViewController
@property (retain, nonatomic) IBOutlet UITextField *tfName;
@property (retain, nonatomic) IBOutlet UITextField *tfAge;
@property (retain, nonatomic) IBOutlet UISegmentedControl *segSex;
@property (retain, nonatomic) IBOutlet UIButton *button;
- (IBAction)archiveUnarchive:(id)sender;
@end

在 viewDidLoad 中呼叫 [self initUI:nil];,其中 initUI: 定義如下:

-(void)initUI:(MyClass *)obj {
    if (obj == nil) {
        tfName.text = nil;
        tfAge.text  = nil;
        segSex.selectedSegmentIndex = 0;
    } else {
        tfName.text = obj.name;
        tfAge.text  = [NSString stringWithFormat:@"%d", obj.age];
        segSex.selectedSegmentIndex = obj.sex;
    }
}

// 依介面上輸入的內容建立 MyClass 實例
-(MyClass *)makeMyClassInstance {
    MyClass *obj = [[MyClass alloc] init];
    obj.name = tfName.text;
    obj.age  = [tfAge.text intValue];
    obj.sex  = [segSex selectedSegmentIndex] != 0;
    return [obj autorelease];
}

按鈕事件

- (IBAction)archiveUnarchive:(id)sender {
    button.enabled = NO;
    NSString *filePath = [AppDocuments stringByAppendingPathComponent:@"customobject.txt"];

    if (button.tag == 0) {   // 歸檔
        if (tfName && tfName.text.length > 0 && tfAge && tfAge.text.length > 0) {
            button.tag = 1;
            MyClass *obj = [self makeMyClassInstance];
            [NSKeyedArchiver archiveRootObject:obj toFile:filePath];
            [self initUI:nil];
        }
    } else {                 // 反歸檔
        button.tag = 0;
        MyClass *obj = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
        [self initUI:obj];
    }
    button.enabled = YES;
}

執行後在介面輸入一些資訊並點擊「歸檔」。歸檔完成後輸入內容會被清空,按鈕文字變為「反歸檔」,此時在 app 的 Documents 目錄下可以找到 customobject.txt。再點一次「反歸檔」,就會從檔案中取回 MyClass 物件並把屬性填回 UI 控件。

兩種進階用法

1. 歸檔集合而非單一物件:除了把 MyClass 當作 rootObject 直接歸檔,更常見的做法是把它放進 Array 或 Dictionary,再對集合進行歸檔。

2. 遞歸歸檔:MyClass 可以遞歸,也就是它的屬性可以是另一個 MyClass 物件,且該屬性同樣能被歸檔與反歸檔。加入 parent 屬性後,在 encodeWithCoder: 中加上:

if (self.parent) [encoder encodeObject:self.parent forKey:@"parent"];

在 initWithCoder: 中加上:

self.parent = [decoder decodeObjectForKey:@"parent"];

這樣就能在 makeMyClassInstance 中為 obj 建構另一個 MyClass 作為它的 parent:

MyClass *parent = [[MyClass alloc] init];
parent.name = @"dad";
parent.age  = obj.age + 20;
parent.sex  = 0;
parent.parent = nil;
obj.parent = parent;

反歸檔之後,在 initUI 方法中即可顯示 parent 的資訊:

lbParent.text = obj.parent.name;

程式執行結果如下:

最後提醒一個實務細節:encodeObject:forKey: 的 key 一旦上線就不能更改,否則舊資料會讀不回來。若真的需要調整結構,做法是保留舊 key 作為讀取相容、新 key 用於寫入,並在解碼時兩者都試一次。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved