ARCHIV

PHP (65) - Ladění kódu 2.

Další techniky ladění kódu PHP. Aserce, testovací skripty.

10.11.2004 15:00 | Petr Zajíc | Články autora | přečteno 25557×

Pokračujme dnes tím, co jsme načali v minulém díle - a sice postupy a metodami, které mohou zbavit náš kód chyb. Ladit kód můžeme i jinak než jen vypisováním proměnných a nastavováním příznaků pro ladění. Podívejme se nejprve třeba na aserce.

Aserce

Tento výraz souvisí s asertivním chováním. Když to hodně zjednodušíme (psychlogové prominou) tak bychom mohli aserce definovat jako "ozvi se, když není po tvém". V programování se aserce používají jakožto ladící nástroj a PHP aserce realizuje pomocí příkazu assert(). Následuje primitivní ukázka, jak by se mohly aserce použít, jestliže předpokládáme, že proměnná $denvmesici označuje pořadové číslo dne v měsíci:

Je jasné, že když proměnná $denvmesici nebude celé číslo nebo když nebude v rozsahu od 1 do 31, že se PHP ozve. K asercím bych chtěl připojit dvě důležitá varování, která je potřeba brát vážně:

1. Aserce nejsou nástroj na programování, ale nástroj na ladění. Takže byste jimi neměli kontrolovat vstupní parametry, k tomu slouží jiné nástroje (třeba konstrukce case, switch nebo if). Aserce by vám pouze měly pomoci v ladění kódu. Skript by měl fungovat jak se zapnutými asercemi, tak s vypnutými (o zapínání a vypínaní asercí bude řeč za chvíli).
   
2. PHP zachází s asercemi jinak než kompilované jazyky. Kompilované jazyky mají většinou jako výchozí nastavení to, že aserce jsu zapnuty ve vývojovém prostředí a vypnuty ve spustitelném (přeloženém, binárním) souboru. V PHP, jelikož není kompilovaný ale interpretovaný se aserce vypínají, zapínají a nastavují z kódu.

Uvedl jsem, že když podmínka v aserci splněna nebude, PHP "se ozve". Co PHP udělá, to se dá nastavit pomocí funkce assert_options(). Přičemž možnosti josu poměrně pestré a může to být jedna nebo více z následujících akcí:

• Zobrazit varovaní (ASSERT_WARNING)
• Přerušit běh skriptu (ASSERT_BAIL)
• Zavolat uživatelem definovanou funkci (ASSERT_CALLBACK)

Assert_options dělá ještě jednu dosti podstatnou věc, a to tu, že aserce vypíná a zapíná (dělá se to voláním funkce s parametrem ASSERT_ACTIVE). Vhodnou kombinací voleb aserce a zejména vhodným napsáním funkce, která aserce ošetřuje můžete získat poměrně mocný ladící nástroj. Znovu ale opakuji, že pokud používáte aserce, měli byste je ve finálním kódu VYPNOUT.

Pozn.: Aserce Vám rovněž mohou připomenout, co se v kódu děje. V uvedeném příkladu sice bylo z názvu proměnné vidět, co asi obsahuje, ale to nemusí platit vždy. Takže z vhodně napsané aserce můžete poznat, že při psaní kódu jste počítali s tím, že určitá pravidla BUDOU platit. Tento fakt může být neocenitelný, zejména když kód ladíte po delší době.

Logování

Kromě možnosti vypisovat údaje z běžícího skriptu pro účely ladění do prohlížeče máme samozřejmě možnost vypisovat je do souborů. To může být velmi mocná zbraň. Soubor s protokolem může být odeslán na vzdálené místo, nebo se dá průběžně monitorovat a o případných chybách tak víte prakticky okamžitě. PHP obsahuje vetavěnou podporu pro odesílání chybových stavů do protokolu pomocí funkce error_log().

Error_log může při chybě odeslat informace do systémového logu, e-mailem nebo  může spolupracovat s debuggery. Ačkoli je to funkce velmi mocná, není samospasitelná. Její hlavní nevýhodou je fakt, že protokoluje pouze chyby. Přitom čas od času budete potřebovat něco jiného - například můžete pro účely ladění chtít vědět, kolikrát za den se ta která část kódu spouští, nebo prostě budete chtít logovat něco jiného (hodnoty proměnných, například). Ukažme si, jak využít  třídu Log, kterou byste našli v odpovídajícím balíčku na serveru pear.php.net:

Celý skript by, po nahlédnutí do souboru protokolu, způsobil v logu zhruba následující záznam:

Tím možnosti logovací třídy nekončí - lze zapisovat do databáze, nastavovat příznaky logovaných událostí a podobně. Podstatné přitom je, že můžete vlastní logování zařídit jedním řádkem kódu - a přitom má výstup do souboru profesionální úroveň.

Pozn.: Jelikož patří třída log na serveru PEAR k těm jednodušším, mohli by ji rovněž využít pro vlastní zkoumáni lidé, zajímající se do hloubky o objektové programování v PHP. Najdete tam pár zajímavých věcí, které se vám mohou hodit.

Testovací skripty

Nakolik se to může zdát na první pohlad nesmysl, lze někdy odladit část kódu tak, že vyzkoušíme kombinaci všech možných hodnot vstupních parametrů. Pochopitelně to nebudeme dělat ručně, napíšeme si "skript testující skript". To může být zdlouhavá a úmorná práce, ale může se to bohatě vyplatit. Otestováním všech vstupních hodnot totiž získáte téměř stoprocentní jistotu, že skript běhá tak, jak má.

Pokud si vzpomínáte na díl, v němž jsme programovali kalendář, bylo jeho těžiště ve funkci, která přijímala jako argument měsíc a rok:

To je příklad funkce, která by se dala otestovat skriptem. Mohl by vypadat nějak následovně:

Vidíme, že v tom nejsou žádné záludnosti a že se tak poměrně jednoduše lze propracovat k uspokojivým výsledkům. V praxi nebudou všechny příklady ani zdaleka tak jednoduché, a v podobných případech jistě stojí za to si to odzkoušet.

Verze pro tisk