Nastal čas na kakao - Archivace objektů - MujMAC.cz - Apple, Mac OS X, Apple iPod

10. března 2005, 00.00 | Minule jsme se seznámili s objekty třídy NSData a řekli jsme si, že se velmi často užívají pro ukládání a representaci obsahu obecných souborů. To je pravda; existuje ale ještě druhý typ využití těchto objektů, který je – alespoň u složitějších aplikací – velmi častý, a to je archivace a dearchivace objektů.

Minule jsme se seznámili s objekty třídy NSData a řekli jsme si, že se velmi často užívají pro ukládání a representaci obsahu obecných souborů. To je pravda; existuje ale ještě druhý typ využití těchto objektů, který je – alespoň u složitějších aplikací – velmi častý, a to je archivace a dearchivace objektů: libovolnou objektovou síť můžeme "zmrazit" a archivovat do instance třídy NSData; později – nebo třeba na docela jiném počítači – zase můžeme naopak obsah tohoto objektu dearchivovat a přeměnit v původní objektovou síť.

Ukázka

Podívejme se nejprve na jednoduchoučký praktický příklad: zatím jsme se sice příliš podrobně nebavili o třídě NSUserDefaults, ovšem z předchozích dílů už tolik víme, že umožňuje ukládat obecné údaje do aplikačních předvoleb, a opět je odtud načítat.

Vzhledem k tomu, že uživatelské předvolby jsou ukládány do souborů ve standardním formátu XML, mají však služby třídy NSUserDefaults jedno omezení: můžeme jimi ukládat a načítat obecné datové objekty jako NSNumber, NSString, NSData či kontejnery NSArray a NSDictionary, avšak nelze přímo pracovat s ostatními objekty. Velmi často bychom třeba chtěli do aplikačních předvoleb uložit nastavení barvy (NSColor); ta ovšem není primitivním datovým objektem a přímo se do XML prostřednictvím NSUserDefaults zapsat nedá.

Můžeme ji ovšem archivovat do objektu třídy NSData, a ten uložit – odpovídající kategorie, rozšiřující vhodným způsobem služby třídy NSUserDefaults, by mohla vypadat kupříkladu takto:

@implementation NSUserDefaults (OCSColourCategory)
-(NSColor*)colorForKey:(NSString*)key {
  return [NSKeyedUnarchiver unarchiveObjectWithData:[self objectForKey:key]];
}
-(void)setColor:(NSColor*)color forKey:(NSString*)key {
  [self setObject:[NSKeyedArchiver archivedDataWithRootObject:color] forKey:key];
}
@end

Princip je tedy asi jasný; podívejme se nyní na služby a možnosti archivace a dearchivace trochu blíž.

Podpora archivace v nových třídách

Vraťme se k přehledu tříd v úvodním článku: minule jsme si ukázali NSData; třídu NSBundle prozatím přeskočíme, neboť, ačkoli je z technických důvodů součástí Foundation Kitu, její služby většinou a nejvíc využíváme v aplikacích postavených nad AppKitem, třídy NSCharacterSet, NSMutableCharacterSet ra NSScanner jsme si již ukázali zpočátku, v dílech věnovaných kontejnerům – takže na řadě je NSCoder.

A je to právě třída NSCoder, na níž je archivace v API Cocoa založena (samy třídy NS(Keyed)Archiver, NS(Keyed)Unarchiver jsou jejími dědici). Kdykoli chceme archivovat nějakou objektovou síť, vytvoří se nějaký objekt třídy NSCoder (či některé z jejích podtříd), jež se o archivaci stará; archivace vždy začíná od kořenového objektu sítě, a ten dostane automaticky zprávu encodeWithCoder:, v jejím rámci do kodéru (jenž je argumentem zprávy) zapíše svůj obsah. Obsahuje-li sám další objekty (jako tomu je třeba u kontejnerů), zapíše je do kodéru také, a celý postup se rekursivně opakuje, dokud není zapsána celá objektová síť.

Načítá-li se naopak objektová síť z archivu, slouží k inicializaci metoda initWithCoder: – v ní objekt z kodéru načte svá uložená data (a případně i vnořené objekty).

Všechny standardní třídy Cocoa archivaci podporují. Implementujeme-li ovšem třídy vlastní, musíme se o archivaci také postarat (pokud chceme, aby instance našich tříd byly korektně archivovatelné) – to je jednoduché; prostě stačí korektně implementovat obě zmíněné metody. Dejme tomu, že implementujeme třídu Xyz, jež obsahuje číslo, string, a také může obsahovat odkaz na pomocný objekt téže třídy:

@interface Xxx:NSObject {
  int number;
  NSString *string;
  Xxx *object;
}
...
@end

Podívejme se nejprve na jednodušší z obou archivačních metod:

@implementation Xxx
...
-initWithCoder:(NSCoder*)coder {
  if (!(self=[super initWithCoder:coder])) return nil;
  if (![coder allowsKeyedCoding]) return nil;
  number=[coder decodeIntForKey:@"Xxx Number"];
  string=[[coder decodeObjectForKey:@"Xxx String"] retain];
  object=[[coder decodeObjectForKey:@"Xxx Obj"] retain];
  return self;
}
...

První a poslední řádek implementace jsou zřejmé – nejprve samozřejmě musíme zavolat inicializátor nadřízené třídy; na konci vždy vracíme self. Druhý řádek se týká starších versí systému – dříve byly k dispozici kodéry, jež nabízely pouze omezené služby; my prostě nedovolíme takový kodér využít, ovšem pokud bychom požadovali kompatibilitu se starším kódem, museli bychom se o ni postarat.

Zbývající trojice řádků prostě z kodéru načte hodnoty, jež tam byly uloženy pod danými jmény. U objektů je samozřejmě zapotřebí použít zprávu retain, neboť kodér – jak je v prostředí Cocoa obecným standardem – vrací objekty "autoreleasované".

Zajímavější bude kódování zprávou encodeWithCoder:; zkomplikujeme si totiž trochu život požadavkem, že pomocný objekt object nemusí být součástí sítě; pokud ale v síti objektů je, musí být odkaz na něj korektně uložen. Uvědomme si, že takový požadavek dává v praxi velmi často smysl: můžeme mít třeba seznam firem a jejich poboček: archivujeme-li jen jedinou pobočku, nebudeme chtít asi do archivu zapisovat její mateřskou firmu (podmíněný odkaz). Archivujeme-li však mateřskou firmu, chceme asi zapsat i všechny její pobočky (běžné odkazy); a také chceme, aby zpětné odkazy z poboček na mateřskou firmu byly v archivu uloženy správně. To v Cocoa zajistí dosti často užívaný příkaz encodeConditionalObject:forKey: – celá implementace by tedy mohla vypadat nějak takto:

-(void)encodeWithCoder:(NSCoder*)coder {
  if (![coder allowsKeyedCoding]) return;
  [super encodeWithCoder:coder];
  [coder encodeConditionalObject:object forKey:@"Xxx Obj"];
  [coder encodeInt:number forKey:@"Xxx Number"];
  [coder encodeObject:string forKey:@"Xxx String"];
}
...
@end

Cocoa automaticky zajistí, že pokud je do archivu uložen objekt object, bude odkaz zapsán a obnoven korektně; pokud ale tento objekt součástí archivu není, příkaz encodeConditionalObject:forKey: jeho archivaci nezajistí, a po načtení metodou initWithCoder: bude v proměnné object prostě hodnota nil.

Jen pro úplnost se zmíníme o tom, že služby třídy NSCoder jsou velmi bohaté a zajišťují kupříkladu i možnost automatického nahrazování objektů objekty odlišné třídy během načítání z archivu; v praxi to však příliš často nepotřebujeme a vystačíme si s metodami encodeObject:forKey:, encodeConditionalObject:forKey: a encodeTyp:forKey: (a s inversními metodami decodeObjectForKey: a decodeTypForKey:).

Přímé ukládání a načtení, ukládání více objektů

Podobně třídy NSKeyedArchiver a NSKeyedUnarchiver nabízejí bohatší služby, než pouhé zapsání objektové sítě do objektu třídy NSData a její znovunačtení, jak jsme si je ukázali hned v prvém odstavci. My se zde opět zmíníme jen o těch nejčastěji využívaných službách.

Prvá z nich je příjemná v jednodušších případech, kdy bychom datový objekt rovnou uložili do (respektive načtli ze) souboru – archivační třídy to dokáží za nás, a nabízejí přímo pohodlné kombinované metody archiveRootObject:toFile: a unarchiveObjectWithFile:. Argumentem obou je přímo jméno souboru; prvá z nich vrací hodnotu YES po úspěšném ukončení práce, NO jinak.

Naopak pro složitější případy nabízí Foundation Kit možnost do jediného datového objektu uložit více archivovaných objektových sítí pod různými jmény. To je velmi praktické v případech, kdy do jediného datového objektu ukládáme několik jen volně souvisejících datových bloků – např. seznam stylů a vlastní dokument, nebo text a v něm vložené obrázky. Při načítání pak lze z archivu podle potřeby načíst vše, nebo třeba jen zvolené objekty (dejme tomu text bez obrázků při exportu do ASCII). Archivace pak vypadá nějak takto:

...
NSMutableData *archivedObjects=[NSMutableData data];
NSKeyedArchiver *archiver=[[[NSKeyedArchiver alloc]
  initForWritingWithMutableData:archivedObjects] autorelease];
[archiver encodeObject:text forKey:@"Plain text"];
[archiver encodeObject:styles forKey:@"Styles"];
...
[archiver finishEncoding];
...

Nyní objekt archivedObjects obsahuje archivovanou podobu všech zapsaných dat, a můžeme jej třeba zapsat do souboru (writeToFile:atomically:, to již umíme od minula).

Pro načtení pak použijeme inversní postup:

...
NSKeyedUnarchiver *unarchiver=[[[NSKeyedUnarchiver alloc]
  initForReadingWithData:archivedObjects] autorelease];
text=[unarchiver decodeObjectForKey:@"Plain text"];
[unarchiver finishDecoding];
...