Laděnka je užitečnou každodenní pomocnicí PHP programátora. Její oficiální jméno zní Tracy, dříve Nette\Debug.
Každý ladič je dobrým kamarádem s funkcí var_dump, která podrobně vypíše obsah
proměnné. Bohužel v prostředí HTML výpis pozbude formátování a slije
se do jednoho řádku, o sanitizaci HTML kódu ani nemluvě. V praxi je
nezbytné var_dump
nahradit šikovnější funkcí. Tou je
právě Debug::dump()
$arr = array(10, 20.2, true, null, 'hello');
Debug::dump($arr);
// včetně jmenného prostoru Nette\Debug::dump($arr);
vygeneruje výstup:
<pre><span style="color:gray">array</span>(5) {
[0] => <span style="color:gray">int</span>(10)
[1] => <span style="color:gray">float</span>(20.2)
[2] => <span style="color:gray">bool</span>(true)
[3] => <span style="color:gray">null</span>
[4] => <span style="color:gray">string</span>(5) "hello"
}
</pre>
Dalším užitečným nástrojem ladiče jsou stopky s přesností na mikrosekundy:
Debug::timer();
// princi můj malinký spi, ptáčkové sladce již sní...
sleep(2);
$elapsed = Debug::timer();
// $elapsed ≈ 2
Tohle všechno jsou sice užitečné drobnosti, skutečným killerem je však
jiná Laděnčina vlastnost.
Zpráva o nezachycené výjimce nebo chybě poskytuje vývojáři důležité
informace o tom, kde a proč k ní došlo. Standardní výstup v PHP vypadá
asi takto:
Pusťme však ke slovu Laděnku. Po aktivaci příkazem
Debug::enable()
nám předvede svou nejvíce sexy polohu:
Takto vypadá výjimka, takto vypadá vygenerovaná chyba. To je pak jiné ladění, co?
Snad nemusím dodávat, že vypisování chyb se nesmí nikdy dostat na produkční server. Je to výborná společnice na pracovišti, ale nikdy ji nesmíme brát sebou ven. Je totiž děsně ukecaná a vyzradí na vás úplně všechno (nicméně kdyby k tomu náhodou došlo, má integrovaný systém pro skrytí citlivých políček, např. hesel). Na produkčním serveru je však možné nechat výpisy ukládat do adresáře nebo odesílat administrátorovi emailem.
Komentáře
Hrach #1
Miluju laděnku :-* Ty krásné tvary, vnady, ta barva očí, rozevíratelné oblasti, jej, až sem se ztoho celý okouzlil.
enoice #2
Tak to je bomba, Dave! Dokonalost 🙂
papi #3
Vypadá to velmi, velmi dobře. Jak dlouho si s ní už užíváš?
Tom #4
Vypadá dobře, pro potření prvně zmi=novaných problémů používám xdebug, neškodí si navzájem?
Pixy #5
Gratuluji ke krásné holčičce. Laděnka vypadá moc mile a chytře. Radost.
Littlemaple #6
Opravdu sexy! :)
v6ak #7
Dobrý. ukecaností mi to připomíná ASP.NET. Taky jsem narazil na server se zapnutým debugem…
Já mám vlastní debug nástroj, ale laděnka je patrně lepší. Ale:
tark #8
Mě by se spíš líbilo něco jiného. Přesměrovat výstup laděnky (tedy NDebug.template) do souboru a navázat na NDebug vlastní nástroj pro zachytávání výjimek. Šlo by to? :)
džidžir #9
Moc pěkné. Umí to rozumně odchytnout i Fatal Errory?
David Grudl #10
#7 v6aku, zapíná se přes
NDebug::enable()
, vypíná přesNDebug::disable()
. Je možné zapnout i textový výstupNDebug::$html = true
, respektive v CLI režimu se zapne automaticky. Ale ten není zdaleka tak ukecený, spíš odpovídá standardnímu PHP výstupu.Textový režim existuje hlavně hlavně kvůli tomu, že změní chování
NDebug::dump()
. Hodí se mi to k testování kódu – z příkazové řádky spouštím sadu malých testovacích příkladů, zachytávám výstup a porovnávám s referenčním.#8 tarku, zachytávát můžeš i vlastním nástrojem a k vykreslení použít
NDebug::exceptionHandler()
. I když asi by to vyžadovalo drobnou úpravu kódu.#9 džidžire, systémové fatal errory v PHP bohužel nijak odchytit nelze, na to už jsem si stěžoval dříve. Jen
E_USER_ERROR a E_RECOVERABLE_ERROR.
džidžir #11
#10 Davide Grudle,
Jo, už jsem na to taky došel. Velký problém, pokud ladím na serveru a server má vypnuté v konfigu z pochopitelných důvodů vypisování chyb. Zend sliboval před časem odchytávatelnost některých FE, myslím že těch, při kterých zůstane stabilní jádro.
V Perlu jde třeba zachytit a zpracovat jakákoli chyba, dokonce i chyby při parsování skriptu. Ale Perl koneckonců také není určen pro psaní skriptů pro web.
Ondra #12
#1 Hrachu, Řekl bych, že by si spíš potřeboval na chvíli vyměnit klávesnici a myš za pořádnou ženskou :)
Jinak NDebug je super ;)
v6ak #13
#10 Davide Grudle, Já jsem dělal přímo možnost použití šablon, ale v praxi to stačí. Automatické zapínání textového režimu nemám. Jde mi taky pochopitelně hlavně o komandlajnu.
K vypínání: Jo, to jsem si přečet, ale jde mi hlavně o debugování.
[smazáno] Ještě jeden návrh převzatý z mé víceméně staré primitivní debugovací knihovničky: Velké plus (oproti var_dump a print_r) je v tom, že umožňuje výpis části výrazu:
Případně lze dodat komentář:
Vtip je pochopitelně v tom, že zadaný parametr 1 je zároveň návratovou hodnotou.
paranoiq #14
davide, gratuluji. udělal jsi nádherné udělátko :)
sám používám něco podobného jako NDebug::dump() ve formě jedinné funkce dump(). výstup je trochu méně ukecaný, zato ale hraje všemi barvami :), umí vypsat pole a objekty povolných tříd† rekurzivně do zvolené hloubky, přičemž defaultně censoruje hodnoty jistých názvů (kdybych ji přeci jen někde zapoměl)
† povolná třída obsahuje:
public function _dump() {
return (array)$this;
}
bratr ekim #15
#12 Ondro, asi tak no
#1 Hrach jo něco takového sem potřeboval už dlouho :D
Littlemaple #16
Mno, tak první dojmy: Nemohla by mít Laděnka cestu k oné úžasné šabloně modifikovatelnou? Rád bych si ji dal jinam než do stejného adresáře jako třídu.
Jistě, stačí si to tam přepsat nebo ručně přidat jednu public vlastnost, ale tím se připravuji o dopřednou kompatibilitu s možnými dalšími verzemi Laděnky :) .
Věroš #17
Jo, tohle mi v PHP chybělo. 😉
<hr>
Nechca být za rejpala, ale podobný nástroj máme v Pythonu už pár let ve vlajkové knihovně .
Když jsem na cgitb poprvé narazil, tak jsem myslel, že nemůže být nic lepšího.
Rychle jsem ale zjistil, že může – jen jsem tomu nekrofilnímu vrtání se v zemřelém kódu ještě nepřišel na chuť. Ano, post-mortem inspector v okně prohlížeče v Pylons mne opravdu překvapil.
PS: Jo a to že tracebacky mohou správcům chodit e-mailem včetně session, parametrů dotazu, cookies, hlaviček, identifikace prohlížeče a čísla bot uživatele, to jsem už říkal?
Oswald #18
Něco podobného je v symfony frameworku, jenom to není tak přehledné a navíc tam jsou vypsány i globální proměnné, což je také užitečné.
veena #19
#10 Davide Grudle, Nelze ten fatal error odchytnout pomocí output_bufferingu?
https://www.php.net/…rror_handler
Laděnka pěkná!
golf #20
#18 Oswalde, Symfony je tak dokonale, az je problem tu dokonalost pochopit 🙂 A ja z toho mam jen schizofrenii, pouzivat dokonale Symfony, nebo pouzivat skvele Nette. A dokonce se zda, ze i Zend ve verzi 1.5 zacina byt pouzitelny. No co vcil???????
David Grudl #21
#17 Věroši, #18 Oswald narovinu, chtěl jsem vidět, jak vypadá taková obrazovka v jiných systémech, ale pokud si jej nestáhneš, nenainstaluješ, nepochopíš, nerozchodíš a nevyhodíš výjimku, tak to nemáš šanci zjistit. Ani tvůj odkaz mi v tom nepomohl.
Takže mám prosbu pro všechny uživatele různých frameworků: hoďte sem odkaz na „blue screen“, pokud je něčím zajímavý, Nemusí být „živý“, stačí htmlshot.
ad odesílání emailem: odesílání nebo ukládání do adresáře řeším přes jinou třídu, k tomu se dostaneme.
David Grudl #22
#19 veeno, obecně není problém
ad a) při normálním ukončení skriptu se ještě zavolají handlery pro
PHP garantuje (od verze 5.0.5), že session se uzavře až po zavolání všech destruktorů, jinak pořadí ovlivňuje garbage collector.
Při vzniku fatální chyby se destruktory zřejmě vynechají. Stále tu však máme tři momenty, kde na ni můžeme reagovat. Klíčová je tedy otázka b), jak chybu od korektního ukončení detekovat?
To netuším. Bohužel ani novinka error_get_last nepomůže. Ovšem skenování output bufferu na řetězec
<b>... error</b>
k rozumným obecně použitelným řešením podle mého nepatří ;)Oswald #23
#21 Davide Grudle, tady je htmlshot ze symfony
Symfony kromě toho v debug módu zobrazuje nad stránkou toolbar, kde jsou informace o prováděných SQL dotazech, konfiguraci, délce trvání jednotlivých úkonů apod., považuji to za velmi užitečné a myslím, že by to mohlo být celkem inspirativní:
https://web.archive.org/…gement-Tools
v6ak #24
#21 Davide Grudle, To se asi mě netýká, že?
Věroš #25
#21 Davide Grudle, Odpovídám soukromě.
SodaE #26
Fakt super,duper 🙂 , tohle využiju
Tarmaq #27
Poslusne hlasim ze ve Firefoxu 2.0.0.11@OpenSUSE 10.3 Gnome se zobrazi vse jak ma, v Konqueroru 3.5.7 nelze rozbalovat Call Stack, Source File, atd. tyto polozky lze pouze zabalit.. Samozrejme mam Konqueror pod Gnome, takze je mozne ze v KDE to pobezi v pohode, ale IMHO by to nemelo mit vliv.. Nevim jestli to nejak pomohlo, ale snad jo ;]
JS #28
Hmm, nějak se mi nepovedlo ji rozběhat pro vyjímky ☹
Zobrazování všech vyjímek sice funguje v závislosti na tom, jakou úroveň reportování nastavím, ale zobrazí se v klasickým (hnusným) PHPkovským hávu.
Errory naopak zobrazuje správně tak, jak ukazuje příklad.
Mohl by mi prosím někdo poradit, co by mohlo být špatně? Díky.
Kamil #29
Ahoj Davide: error a výjimka hodí chybu, dump logicky ne, server běží na linuxu:
Fatal error: Maximum execution time of 60 seconds exceeded in /home/localhost/www2/class/NDebug/Nette/NDebug.php on line 158
Info: Red Hat 2.6.18–53.1.4.el5xen, PHP Version 5.1.6, safe_mode Off, … ?
David Grudl #30
#27 Tarmaqu, to mi moc nepomůže, potřeboval bych konkrétní opravu kódu.
#28 JSi, výjimky s úrovní reportování nijak nesouvisí. Prostě vyhoď výjimku
throw new Exception;
a nezachycuj ji.#29 Kamile, zajímavá chyba v
ob_get_level
, vyřešíme přes email.Vrtak-CZ #31
Czus tak jsem si s ladenkou trochu hral a vzniklo z toho nakonec docela zajimava hracicka… 🙂 Ladenka vs. DiBi a taky sem si trochu pohral s dumpem Ladenka vs. Dump
Jinak dekuju DGX za sqvelou vecicku… 🙂
Patrik Bóna #32
Cau Dgx,
Qcodo ma podobny error handler, ale nieje vnom tolko info ako v tvojom, len tak dalej ;)
#31 Vrtak-CZi, Ladenka vs. DiBi je tiez super ;)
David Grudl #33
Přidal jsem experimentální podporu pro logování chyb (via NDebug::$logDir), odesílání chyb na email (NDebug::$email a NDebug::$emailSubject). Na produkčním serveru je pak nutné vypnout vypisování chyb (NDebug::$display = false).
Inza #34
Perfektní, naprosto dokonalé Davide!:-)
tajo #35
skvělý nástroj! dík
lordfrikk #36
Když jsem viděl slovo „laděnka“, tak moje první reakce byla, jak se anglicky říká: „I lol'd.“ 🙂
Neph04 #37
To propojeni DIBI-Ladenka… neslo by implementovat do Ladenky neco jako udelal Vrtak?
Nasel sem dibi nedavno, a sem z nej nadsenej :) Dneska sem tu narazil na Ladenku a je to genialni vec…
David Grudl #38
#31 Vrtak-CZi, #37 Neph04 jo, udělal to pěkně a určitě něco podobného implementovat (přes obecný interface) plánuju.
Tento článek byl uzavřen. Už není možné k němu přidávat komentáře.