Validace a chyby, a jedna hezká vazba... - MujMAC.cz - Apple, Mac OS X, Apple iPod

22. června 2006, 00.00 | V předcházejícím dílu našeho seriálku o programování v Cocoa jsme si ukázali základy validování atributů modelu při jejich vazbě na editory v grafickém uživatelském rozhraní. Slíbili jsme si ale pro dnešek, že se ještě naučíme při validaci rozpoznat (a ohlásit) chybu, již nelze napravit automaticky.

V předcházejícím dílu našeho seriálku o programování v Cocoa jsme si ukázali základy validování atributů modelu při jejich vazbě na editory v grafickém uživatelském rozhraní. Slíbili jsme si ale pro dnešek, že se ještě naučíme při validaci rozpoznat (a ohlásit) chybu, již nelze napravit automaticky.

Třída NSError

My jsme se již s třídou NSError zběžně setkali; vzhledem k tomu, že se řadě programátorů poněkud plete určení a smysl tříd NSError a NSException, vyplatí se dnes – kdy budeme instance třídy NSError prvně programově vytvářet – si znovu zopakovat, co jsme o ní uvedli v dílu, věnovaném výjimkám:

Ačkoli bychom v principu mohli použít rozšiřující údaje uložené v instancích třídy NSException k předávání podrobných informací o běhových chybách (např. "nelze otevřít požadovaný soubor", nebo "XML, načtené ze zadaného URL, neobsahuje potřebné údaje"), to není účelem výjimek! Výjimky slouží k ošetření výjimečných situací, jež jsou zaviněny nesprávným použitím objektu – zcela typickým případem je třeba pokus o získání čtvrtého objektu z pole, jež obsahuje pouze tři objekty. Čistě teoreticky by při běhu správně napsaného a bezchybného programu nemělo nikdy k výjimce dojít: jistě, šedá je teorie, a zelený je strom života – přesto je vhodné se k tomuto stavu alespoň blížit.

Pro zpracování běhových chyb, k nimž může na základě akcí uživatele a stavu systému docházet kdykoli, nejsou výjimky vhodné. Cocoa pro tyto případy nabízí velmi bohatý systém služeb, postavený kolem jiné standardní třídy, NSError.

Instance této třídy je generována ve chvíli, kdy k chybě dojde; jejím obsahem je popis chyby, její bližší identifikace, a návrh postupu pro její odstranění; to vše ve formátu vhodném pro zobrazení v grafickém uživatelském rozhraní – speciálně tedy také lokalizované. Instance třídy NSError mohou dokonce obsahovat i přímo odkaz na konkrétní objekt, který se o nápravu může podle uživatelových požadavků postarat; tuto "vyšší dívčí" si ale necháme na jindy.

Prozatím postačí vědět následující:

• součástí instancí třídy NSError je tzv. chybová doména (určená obecným textovým řetězcem) a chybový kód, který blíže identifikuje chybu v rámci domény. Tyto údaje se nezobrazují v GUI; naopak jsou určeny pro programovou identifikaci chyby, je-li to zapotřebí;
• pro GUI jsou naopak určeny položky v userDictionary, jenž je součástí objektu NSError. Z nich jsou nejdůležitější dvě: NSLocalizedDescriptionKey obsahuje nadpis, který se zobrazí v záhlaví standardního chybového panelu, zatímco NSLocalizedRecoverySuggestionErrorKey obsahuje text, který se zobrazí uvnitř tohoto panelu.

Validace, vracející chybu

Už minule jsme se zmínili o tom, že validační metoda může rozeznat zadanou hodnotu atributu jako nevalidní a neopravitelnou, a v takovém případě vrátí referencí objekt NSError (a přímo hodnotu NO). My si ukážeme jednoduchou implementaci takové validace pro atribut "surname", jež zakáže některá konkrétní příjmení:

-(BOOL)validateSurname:(id*)value error:(NSError**)error {
    static NSSet *forbidden=nil;
    if (!forbidden) forbidden=[[NSSet alloc] initWithObjects:
        @"lenin",@"stalin",@"mao",@"castro",@"paroubek",nil];
    if (![forbidden containsObject:[*value lowercaseString]]) return YES;
    *error=[NSError errorWithDomain:@"parliament" code:0 userInfo:
        [NSDictionary dictionaryWithObjectsAndKeys:
            @"Fie! A bolshevik!",NSLocalizedDescriptionKey,
            [NSString stringWithFormat:
                @"Do not ever vote for anybody like %@.\n\n"
                @"Just use any other name.",
                [*value capitalizedString]],
            NSLocalizedRecoverySuggestionErrorKey,
            nil]];
    return NO;
}

Implementace metody je jednoduchá: je-li to zapotřebí, nejprve se vytvoří statická sdílená množina zakázaných jmen. Pak metoda jen ověří, zda náhodou zadaný textový řetězec (bez ohledu na velikost písmen) není v množině uveden; ne-li, vrátí YES a vše je v pořádku. Ano-li, sestaví objekt NSError obsahující popis chyby, a vrátí NO. Hned můžeme vyzkoušet, jak to funguje:

Ještě je ovšem vhodné upravit i validaci odvozeného atributu "fullName", aby se ověření uplatnilo i v něm:

-(BOOL)validateFullName:(id*)value error:(NSError**)error {
    NSArray *a=[*value componentsSeparatedByString:@" "];
    NSString *f=[a objectAtIndex:0],*s=[a lastObject];
    if (![self validateFirstname:&f error:error]) return NO;
    if (![self validateSurname:&s error:error]) return NO;
    *value=[NSString stringWithFormat:@"%@ %@",f,s];
    return YES;
}

Přepínač "Application Modal Alerts"

Podíváme-li se v Interface Builderu do panelu pro nastavení vazeb (v našem případě samozřejmě vazby "value", již používáme, avšak u ostatních vazeb jež jsou validovány tomu není jinak), uvidíme zde přepínač "Always Presents Application Modal Alerts".

Jeho prostřednictvím můžeme řídit typ chybového panelu, který se pro ohlášení nezdařené validace použije. Je-li přepínač vypnutý, bude to standardní lístek ("sheet"), stejně jako na minulém obrázku; pokud bychom však přepínač zapnuli, editor by pro ohlášení chyby namísto lístku použil staromódní "alert", který zablokuje všechna okna aplikace dokud jej neuzavřeme (lístek blokuje, jak známo, pouze to okno, k němuž je připojen).

Nastavení nekorektních hodnot a vazba "target"

To, že validace nejsou volány automaticky při programovém nastavení atributů, ale jen při jejich změně prostřednictvím editorů grafického uživatelského rozhraní, se nám může hodit – někdy můžeme chtít z jakýchkoli důvodů programově nastavit "nekorektní" hodnoty.

Jednoduchým příkladem by mohla být třeba (poněkud umělá) metoda, jež vloží zadaný textový řetězec jako křestní jméno s malými písmeny včetně prvého, a doplní je příjmením "Mao":

-(void)goChinaWith:(NSString*)name {
    [self setFirstname:[name lowercaseString]];
    [self setValue:@"Mao" forKey:@"surname"];
}

Abychom ji však mohli vyzkoušet, musíme najít nějaký postup, jak posílat zprávy opatřené argumenty modelovému objektu. Zajisté, mohli bychom to naprogramovat v aplikačním kontroléru (který bychom museli vytvořit) s použitím odkazu na datový kontrolér pomocí jeho metody selectedObjects... bylo by to poměrně komplikované, a zcela zbytečné. To proto, že objekt NSButton nabízí vazbu "target", jejímž prostřednictvím dokáže poslat libovolnému objektu, přístupnému prostřednictvím vazeb kontroléru, libovolnou zprávu s libovolnými argumenty (jež jsou samy přístupné prostřednictvím vazeb).

Přidáme do okna tlačítko a jeho vazbu "target" nastavíme na samotný modelový objekt – tedy na atribut "selection" kontroléru; do textového pole "Selector Name" zapíšeme jméno požadované zprávy – v našem případě tedy goChinaWith:. Pak přepneme na vazbu "argument", jejímž prostřednictvím určíme argument, který se zprávě při zaslání předá – použijeme prostě stávající hodnotu atributu "firstname":

Podobně jako tomu bylo u nastavování vazby pro obecný formát, můžeme atributů zadat libovolně mnoho – po sestavení vazby pro první se automaticky objeví vazba "argument2", kdybychom ji zaplnili, objevila by se vazba "argument3", a tak dále; nám ovšem pro naši zprávu postačí argument jediné. Také podobně, jako tomu bylo ve zmíněném případě s formátem, je nyní atribut "Selector Name" sdílený mezi vazbou "target" a všemi vazbami "argumentN", a stačí jej určit pouze jednou.

A to je vlastně vše: pokud nyní stiskneme tlačítko "Go China", tlačítko automaticky pošle (prostřednictvím kontroléru) datovému objektu zprávu goChinaWith:, a jako její argument použije stávající hodnotu atributu "firstname".

Mimochodem, možná jste si při zkoušení povšimli, že tlačítko není k dispozici, dokud atribut "firstname" není nastaven (tedy dokud je pole "First name" prázdné). To platí díky zapnutému přepínači "Conditionally Sets Enabled"; na tyto přepínače a jejich možnosti, spolu s některými dalšími službami systému vazeb, se ale podíváme až zase příště.

Pokud by se snad někomu nedařilo, hotový projekt obsahující všechny popsané služby nalezne na www.ocs.cz/apps/KVOTest1.zip.