PHP (64) - Ladění kódu

Aplikace v PHP (jako kdekoli jinde) se musejí po napsání odladit. Podívejme se jak na to.

8.11.2004 15:00 | Petr Zajíc | přečteno 33775×

Přestože dobří vývojáři dokáží napsat i dlouhé části kódu bez syntaktických chyb, prakticky vždy je potřeba kód odladit, dříve než se na něj můžeme spolehnout. Dnes si ukážeme na některé běžnější metody, jak ladění provádět a podíváme se, jak takové věci lze provozovat s přihlédnutím k programování v PHP.

Obecné zásady

Při ladění kódu byste měli pamatovat na několik jednoduchých zásad. Je až s podivem, kolik vývojářů na ně nedbá, takže si uveďme alespoň ty nejdůležitější:

Velikost kódu
Měli byste psát jen takové celky kódu (pod výrazem "celky" myslím třeba funkce nebo objekty), které se dají odladit samostatně. Nemá smysl naskládat celou aplikační logiku do jednoho dlouhatánského skriptu a pak v něm hledat chyby. Mě osobně kratší kusy kódu i lépe působí na psychiku, když mám hledat chybu v hotové aplikaci.

Předpokládejte co nejméně
Murphyho zákon říká, že každý program obsahuje nejméně jednu chybu. Kéž by to byla pravda; většina programů obsahuje desítky chyb. Snažte se, aby vaše malinkaté kousky kódu (třeba funkce) obsahovaly co nejméně chyb, nebo aby chyby v nich pokud možno nepoškodily zbytek kódu. Pište tak, aby byly skripty co možná nejspolehlivější a pamatujte na to, že spolehlivost celku závisí jednak na spolehlivosti dílů, a jednak na jejich počtu.

Metoda simulovaného průšvihu
Tohle je selský rozum - každé testované jednotce (tak třeba funkci) předhoďte nejprve správná data, a potom ta špatná. Zatímco v prvním případě byste měli dostat správný výsledek, ve druhém případě se může stát hodně věcí. Tak například funkce dělící nějaké číslo vstupním parametrem by neměla přijímat nulu. Co se stane, když ji nulu předáte? Budou následky tak hrozné, že vaši aplikaci odešlou do věčných lovišť, nebo se uživatel "jen" dozví, že došlo k chybě "Division by zero"?

Pozn.:Ačkoli se Vám uvedené pravidlo může zdát jako samozřejmé, divili byste se, kolik vývojářů se ani nepokusí shodit svůj vlastní kód podstrčením nějakých nevhodných parametrů. Jak potom mohou vědět, co to udělá, když to za ně vyzkouší někdo jiný?

Podívejme se teď, jak konkrétně můžeme kód v PHP testovat. Možností je mnoho a volit byste měli podle toho, jak důležitá vaše aplikace bude a také podle toho, jak moc máte chyby v kódu rádi (já je moc rád nemám).

Vypisování proměnných

Následující metodu pravděpodobně budete tak či tak znát a používat. Na podezřelé místo v kódu lze vložit příkaz echo (případně print_r) a vypsat si proměnné, které se v kódu používají. Mějme například následující funkci pro převod řetězce představujícího datum na český formát:

<?
function datum ($datum)
{
  return
strftime("%d.%m.%Y",strtotime($datum));
}
?>

Můžete si myslet, že té funkci vůbec nic není, a můžete mít pravdu. Potíž může spočívat v parametru $datum. Možná, že v nějaké složitější části kódu nebude na první pohled zřejmé, co se předává. Takže pro účely ladění pravděpodobně každý rozumný programátor přepíše funkci ve smyslu:

<?
function datum ($datum)
{
  echo
$datum;
  return
strftime("%d.%m.%Y",strtotime($datum));
}
?>

A v prohlížeči hned uvidí, co že se to do funkce vlastně dostává v parametru $datum. Celá ta taškařice s vypisováním proměnných se rovněž dá udělat daleko inteligentněji - například lze v úvodu skriptu definovat konstantu DEBUGGING a podle toho, zda ji nastavíte na hodnotu TRUE nebo FALSE ve funkcích vypisovat ladící údaje. Náš jednoduchoučký příklad by potom mohl vypadat následovně:

<?
define
("DEBUGGING", FALSE);
function
datum ($datum)
{
  if (
DEBUGGING) echo $datum;
  return
strftime("%d.%m.%Y",strtotime($datum));
}

?>

Pozn.: Tento nápad samozřejmě není můj. Používá se to například v projektu PhP BB a pokud chcete nahlédnout do zdrojových kódů této aplikace, můžete se podívat na soubory constants.php a functions.php ve složce includes.

Pozn.: Studium cizích otevřených kódů vůbec není špatná věc, protože je jasné, že mnoho problémů, třeba zrovna to ladění, se tam již nějak řešilo.

Debug_backtrace

Tato užitečná PHP funkce nám může ušetřit mnoho času při zjišťování, kde se při ladění nacházíme, protože poskytuje informace o aktuálním názvu zpracovávaného souboru, funkci, řádku, vstupních parametrech a o několika dalších věcech. Její typické použití může být ve spojení s funkcí var_dump následující (tento kód by mohl být použit namísto výpisu prostřednictvím echo):

<?
  
if (DEBUGGING) var_dump(debug_backtrace());
  
// atd.
?>

Mít jistotu, že kód obsahuje málo chyb a že bude dělat to, co očekáváme je pochopitelně velmi důležité. Proto se budeme laděním kódu zabývat i v následujících dvou dílech našeho seriálu, kde se postupně dotkneme takových témat, jako jsou aserce, logování, testovací skripty a PHP debuggery. Takže, máte se na co těšit.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=502