Nastal čas na kakao - Aplikace RSS: implementace datového modelu - MujMAC.cz - Apple, Mac OS X, Apple iPod

13. října 2004, 00.00 | Minule jsme si ukázali návrh a interface datového modelu pro naši vylepšenou aplikaci; dnes využijeme toho, co jsme se o programování v Cocoa naučili v minulých dílech (a také něčeho, co jsme zatím neprobírali, totiž znalosti standardních knihovních tříd Foundation) k odpovídající implementaci.

Minule jsme si ukázali návrh a interface datového modelu pro naši vylepšenou aplikaci; dnes využijeme toho, co jsme se o programování v Cocoa naučili v minulých dílech (a také něčeho, co jsme zatím neprobírali, totiž znalosti standardních knihovních tříd Foundation) k odpovídající implementaci.

Inicializace

Psát metody init už umíme. Pro naši třídu RSS by bylo přirozené připravit metodu initWithURL:, jejímž argumentem by bylo právě URL, z nějž chceme stream RSS načíst; my to tak ale tentokrát neuděláme. Na začátku jsme si totiž slíbili, že naše aplikace bude natolik chytrá, aby si pamatovala naposledy použitý zdroj novinek do dalšího spuštění: využijeme proto standardní uživatelská nastavení a URL načteme z nich: zvolíme třeba klíč "LastURL". Později, až budeme připravovat kontroler, se postaráme i o to, aby aplikace automaticky poslední použité URL pod tímto klíčem do předvoleb ukládala. Pro přístup k předvolbám slouží standardní třída NSUserDefaults. Celá metoda init tedy bude vypadat nějak takto:

00 -init {
01    if ((self=[super init])==nil) return nil;
02    [created=[[NSCalendarDate date] retain] setCalendarFormat:@"%d.%m.%y %H:%M:%S"];
03    URLString=[[[NSUserDefaults standardUserDefaults] stringForKey:@"LastURL"] copy];
04    if (![URLString length]) error=@"Empty URL";
05    else {
06        NSURL *url=[NSURL URLWithString:URLString];
07        if (!url) error=@"Bad URL";
08        else {
09            NS_DURING
10                NSXMLParser *xml=[[[NSXMLParser alloc] initWithContentsOfURL:url] autorelease];
11                [xml setDelegate:self];
12                rss=md=[[NSMutableDictionary alloc] init];
13                [xml parse];
14            NS_HANDLER
15                error=@"Bad URL contents, improper XML";
16            NS_ENDHANDLER
17        }
18    }
19    if ([[self news] count]==0) error=@"No news in the stream";
20    return self;
21 }

Proberme si postupně jednotlivé kroky:

• řádek 01 obsahuje standardní volání inicializátoru nadtřídy – to píšeme do (designovaných) inicializátorů vlastně mechanicky ☺;
• na druhém zjistíme aktuální datum ([NSCalendarDate date]), zajistíme, abychom o něj nepřišli (retain), uložíme jej do proměnné created a nastavíme formát pro jeho zobrazování;
• třetí řádek "vytáhne" z uživatelských předvoleb ([NSUserDefaults standardUserDefaults]) hodnotu, odpovídající klíči "LastURL" (stringForKey:), a její kopii (copy) uloží do proměnné URLString. Proč kopii, proč nepoužijeme retain? Inu, co kdyby nám náhodou metoda stringForKey: vrátila nějaký sdílený objekt, nota bene třeba měnitelný? Použitím copy se proti takovému případu zabezpečíme (vzpomeňte si na díl "Kopírování objektů");
• na čtvrtém řádku si jen ověříme, zda v uživatelských předvolbách něco bylo – ne-li, nastavíme chybové hlášení a to je vše;
• šestý řádek převede URL v textové formě na speciální objekt třídy NSURL; ta ověří, je-li URL korektní – pokud by tomu tak nebylo, žádný objekt nedostaneme, a na sedmém řádku skončíme nastavením chybového hlášení;
• devátý, čtrnáctý a šestnáctý řádek formují standardní zpracování výjimky: pokud by snad někde na řádcích 10-13 došlo k chybě, řízení se automaticky předá na řádek 15, jinak se řádek 15 přeskočí;
• řádky 10 a 11 už vlastně známe z prvního dílu: vytvoříme objekt třídy NSXMLParser, připojíme jej k získanému URL pomocí inicializátoru initWithContentsOfURL:, a určíme instanci třídy RSS jako delegáta (vlastním parsováním streamu XML se budeme zabývat příště). Na řádku 12 už jen připravíme prázdný objekt NSMutableDictionary, do nějž budeme parsovat – a na řádku 13 parsování spustíme. Za zmínku stojí jen ukládání nového objektu do dvou proměnných rss a md: to proto, že rss objekt obsahuje "navždy", jejím prostřednictvím budeme k datům později přistupovat; md slouží jako pomocná proměnná při parsování, a vždy obsahuje právě aktuální NSMutableDictionary. Na samém začátku je ovšem aktuální právě kořenový objekt, proto jsou hodnoty rss i md stejné;
• řádek 19 jen ověří, zda jsme vůbec nějaké novinky dostali – povšimněte si, že k tomu využíváme accesoru, abychom nemuseli na více různých místech řešit, jak vlastně dostat ze struktury rss seznam novinek (a ohlásí chybu pokud tomu tak není);
• na řádku 20 standardně vrátíme self: to také děláme automaticky, je tomu tak v každém (designovaném) inicializátoru.

Tím jsme s inicializací hotovi. Odpovídající metoda dealloc je ještě mnohem jednodušší – prostě uvolní vše, co je třeba uvolnit:

00 -(void)dealloc {
01    [created release];
02    [URLString release];
03    [rss release];
04    [super dealloc];
05 }

Snad jen někomu není na první pohled jasné, proč neuvolňujeme také proměnné error a md: to proto, že error obsahuje pouze konstantní stringy, jež jsme "neretainovali", takže také není třeba je uvolňovat – pokud by ovšem chybové texty měly být generované programem (nebo třeba načítané z tabulek s lokalizovanými stringy), pak již by to zapotřebí bylo. Proměnná md pak slouží jen jako pomocný ukazatel na právě aktivní instanci třídy NSMutableDictionary – všimněme si již v inicializaci, že obsahuje týž objekt, jako rss.

Accesory

Pro správné pochopení accesorů musíme znát strukturu, do které se rozparsují XML data, representující novinky ze zdroje RSS. Vlastní parsování si ukážeme příště; hned si však můžeme říci, že prostě každý tag XML, obsahující pouze text, se převede na NSString; každý tag, obsahující vnořené tagy, se převede buď na NSDictionary (pokud jsou vnořené tagy různé), nebo na NSArray (jsou-li vnořené tagy stejné).

Známe-li pak strukturu XML pro RSS, víme, že titulek bude uložen jako NSString s klíčem "title" uvnitř NSDictionary, který bude s klíčem "channel" uložen uvnitř NSDictionary, který bude na nejvyšší úrovni a bude mít klíč "rss". Podobně pak samotné novinky budou uloženy jako NSDictionaries obsahující klíče "title", "description" a "link" v NSArray, jež bude s klíčem "item" uloženo v NSDictionary "channel".

Chceme-li pak pro případ, že by náhodou data titulek neobsahovala, na jeho místě zobrazit výchozí URL, a pokud je náhodou i to prázdné, zobrazit titulek "Unknown", je následující implementace accesoru title již samozřejmá:

00 -(NSString*)title {
01    NSString *ttl=[[[rss objectForKey:@"rss"] objectForKey:@"channel"] objectForKey:@"title"];
02    if (![ttl length]) ttl=URLString;
03    return ttl?:@"Unknown";
04 }

Jediné, co zde stojí za samostatnou zmínku, je binární podmíněný výraz na řádku 3: standardní jazyk C (bohužel) tuto nesmírně šikovnou variantu nezná, avšak v GNU C, jež je v Mac OS X standardním překladačem, je (spolu s řadou dalších velmi šikovných rozšíření) k dispozici: je-li podmínkový výraz pravdivý (tedy nenulový), použije se; jinak se použije druhý výraz. Náš výraz je tedy ekvivalentní ttl?ttl:@"Unknown"; je ovšem mnohem přehlednější (zvláště pak pokud bychom na místě "ttl" měli delší a složitější výraz).

Accesor timedTitle jen předřadí čas vytvoření objektu:

00 -(NSString*)timedTitle {
01    return [NSString stringWithFormat:@"%@: %@",created,[self title]];
02 }

Accesor news nejprve ověří, nedošlo-li při vytváření objektu k chybě; je-li tomu tak, vrátí uměle vytvořený seznam novinek, obsahující pouze chybové hlášení na místě titulku. Jinak vrátí seznam novinek z rozparsovaného XML:

00 -(NSArray*)news {
01    if (error) // fake a news of one-line only
02        return [NSArray arrayWithObject:[NSDictionary dictionaryWithObject:error forKey:@"title"]];
03    return [[[rss objectForKey:@"rss"] objectForKey:@"channel"] objectForKey:@"item"];
04 }

Zdrojový text ještě obsahuje metody delegáta objektu NSXMLParser; ty si však ukážeme až příště, v rámci celého parsování XML.