掌握C++ builder的除錯(cuò)藝術(shù)(1)
2019-09-06 23:33:47
供稿：網(wǎng)友
第一篇－正確書寫代碼
1./t簡介
2./t書寫干凈的代碼
3./t使用異常及異常處理能力
4./t使用記錄（logging）機(jī)制
5./t結(jié)合使用記錄機(jī)制與類的異常處理機(jī)制
6./t處理您代碼外產(chǎn)生的異常
7./t你的回合
8./t版權(quán)說明
簡介
這篇文章，我將從最基本的開始談起。但希望可以涉及更廣的層面，而不僅僅是為你的程序除錯(cuò)(debug)。你將會(huì)看到，我認(rèn)為除錯(cuò)(debugging)這個(gè)字的全部意義，并不只是通過ide的內(nèi)建機(jī)制來運(yùn)行的。我希望在這篇小小的文章結(jié)束時(shí)，幾乎每個(gè)讀者都可以學(xué)到至少是一件新東西，并把它藏到你的兵器庫中。記住，你程序中的錯(cuò)誤(bug)越少，你的最終用戶對(duì)你的程序的感覺就越好；你對(duì)錯(cuò)誤(bug)的處理越好，用戶們發(fā)現(xiàn)錯(cuò)誤(bug)時(shí)就越樂于告訴你以便你改正錯(cuò)誤。好了，現(xiàn)在系好安全帶，戴上護(hù)目鏡，讓我們開始一段瘋狂的路程！
書寫干凈的代碼
首先而且也許是最重要的一點(diǎn)是書寫干凈、可讀的代碼是極其重要的。能夠在寫完一段代碼后回顧一下并給它加上注釋來說明這段代碼用來做什么和為什么這么做，將會(huì)省去你以后跟蹤代碼的無數(shù)個(gè)痛苦的小時(shí)。也許你會(huì)多花一點(diǎn)時(shí)間來書寫，但當(dāng)你花過n小時(shí)來跟蹤那些難以捉摸的bug時(shí)，你就會(huì)同意多花點(diǎn)時(shí)間來讓程序代碼可讀是多么值得了。(你本可以很容易完成除錯(cuò)的)。如果沒有這么做過，我建議你停下來，讀讀另一篇scott的精彩文章－代碼的風(fēng)格(大家需要的話，將會(huì)盡快翻譯)。
使用異常及異常處理能力
現(xiàn)在進(jìn)入下一步，這仍然是基于代碼的步驟。（除了在極少數(shù)的情況下，你不能老是使用系統(tǒng)內(nèi)建的除錯(cuò)器，所以知道其他可以找出這些麻煩的蟲子的辦法總是個(gè)好主意）。本步驟完全是關(guān)于如何做到，更重要的是處理好在你的窗體出現(xiàn)異常時(shí)系統(tǒng)扔給你的（產(chǎn)生的）錯(cuò)誤。在c++標(biāo)準(zhǔn)得到認(rèn)可前黑暗的舊日子里，應(yīng)用程序通常會(huì)通過返回值來發(fā)出錯(cuò)誤信號(hào)（這種方法在ole和一些winapi函數(shù)中仍在使用）。很顯然，你可以很輕易的忽略這些（事實(shí)上也是經(jīng)常的，我的意思是你經(jīng)常檢查一個(gè)winapi函數(shù)的返回值嗎？）。
所以他們決定….，okay,我們需要一個(gè)新的機(jī)制，一個(gè)你不能忽略的。但你可以處理，定制（自定義 customize）。異常就此出現(xiàn)了。想要一個(gè)特殊的錯(cuò)誤類型標(biāo)志？容易的很，定義一個(gè)新的異常類型（不過是一個(gè)類，沒別的），拋出來（產(chǎn)生這個(gè)異常）。完了。
例子：
class myexception
{
public:
/t ansistring imessage;
/t myexception(ansistring message) { imessage=message;}
};
throw new myexception(“test exception message”);
就這么簡單?。ó?dāng)然不是很完全，我會(huì)很快加上的）。漂亮而又簡單，并且非常容易定制來滿足您的需要。okey，你會(huì)問到：“我能產(chǎn)生異常了，但如何處理它們？我的意思是，我想在第一時(shí)間（位置）從我的代碼中排除異常！”這當(dāng)然很容易做到，實(shí)際上還很容易定制呢！標(biāo)準(zhǔn)委員會(huì)為我們定義了try {/* code */} catch (...) {/* code */ }機(jī)制，跟異常機(jī)制一樣，它完全可以定制來滿足您的需要！只需把您的執(zhí)行代碼段放在try模塊中就行了，您還需要一個(gè)catch( ) 或 __finally 模塊來告訴程序（如果）得到一個(gè)異常的時(shí)候作什么。現(xiàn)在就是你這么做的好處，你定義了一個(gè)類class類型并且輸入變量來捕捉異常－通過聲明catch( )。（在前面的例子中，應(yīng)該是這樣－catch(myexception &e) { /*在這里書寫捕捉到異常后的處理代碼*/}）為了讓這個(gè)系統(tǒng)更有力，你可以建立完整的子類繼承樹。這樣當(dāng)你捕捉基類時(shí)你可以捕捉所有從這個(gè)基類繼承的異常類型（vcl中一個(gè)很好的例子就是所有的異常都是從exception類繼承而來的，所以catch(exception& e) 將捕捉所有的vcl異常，當(dāng)然包也括您所產(chǎn)生的。但esocketerror除外，見xiphias在http://www.bytamin-c.com/ 的howto (若你不喜歡e文的話，我會(huì)盡快翻譯)。記住這個(gè)想法，我會(huì)在以后另一個(gè)步驟詳細(xì)說明）。要讓它再有力一些的話，標(biāo)準(zhǔn)委員會(huì)決定包括如下的聲明catch(…) ，沒錯(cuò)括號(hào)中就是三個(gè)點(diǎn)。此聲明允許我們捕捉任何異常，我的意思是所有的異常。還想再有力一些？當(dāng)然可以，你可以用附加的catch( )聲明，跟if..else if…的樣子差不多。這里要牢牢記住！如果你捕捉到了一個(gè)異常類型，那么以后就它不會(huì)被再次捕捉到了！所以先看下面的代碼…
try
{
/t // 程序的正常運(yùn)行代碼
}
catch(edbengineerror &e)
{
/t // 處理基于數(shù)據(jù)庫引擎的錯(cuò)誤
}
catch(eexternalerror &e)
{
/t //通常處理基于windows的錯(cuò)誤
}
catch(exception &e)
{
/t // 處理所有其他的vcl錯(cuò)誤
}
你可以看到，這里按照 "是edbengineerror嗎? 是->處理，不是?->繼續(xù)捕捉" "是eexternalerror嗎? 是-> 處理， 不是?-> 繼續(xù)下一次捕捉" 等等… 這樣的順序排列。
接著還有更多的內(nèi)容。如果你希望對(duì)某個(gè)異常做些什么，又不希望異常就此消失，你可以重新拋出（產(chǎn)生）這個(gè)異常。它將繼續(xù)向后尋找新的catch（）過程來處理它。我不能說我經(jīng)常這么做。但最好應(yīng)該知道，就象“拋出”一樣簡單。就是這樣，throw將帶著已經(jīng)被你處理過的異常繼向后尋找另一個(gè)catch來處理它。
最后而不是最不重要的 （這部分不包括在標(biāo)準(zhǔn)規(guī)范中，倒更象是borland專有的增加版）就是 __finally 聲明,使用一個(gè) __finally{ } 模塊,你可以指定不管有否異常產(chǎn)生都將運(yùn)行的代碼。這里是清除你通過new方法分配的局部變量及將所有應(yīng)該設(shè)定回正常狀態(tài)的標(biāo)志復(fù)位（例如將一個(gè)等待狀態(tài)的鼠標(biāo)指針復(fù)位成正常狀態(tài)）的最方便的地方。
呸，太多了！休息一下吧，有空可以看一看c++builder幫助中的exception類, (所有e開頭的,你會(huì)注意到它們都是從exception類繼承來的。這也是定制你自己的異常類的好練習(xí)！) 當(dāng)你回來時(shí)，我們將進(jìn)入下一步旅程。
使用記錄（logging）機(jī)制
您不可能總是使用除錯(cuò)器來除蟲，有時(shí)你沒法依靠內(nèi)建除錯(cuò)器的力量，所以有時(shí)你將不得不求助于其他的除錯(cuò)手段來調(diào)試程序。（典型例子如：nt服務(wù)、isapi/cgi程序、實(shí)時(shí)應(yīng)用程序…等等）此時(shí)您將不得不求助于我們這樣經(jīng)驗(yàn)豐富的程序員才會(huì)談到的老式的除錯(cuò)/調(diào)試技術(shù)。例如產(chǎn)生使用某種記錄（logging）機(jī)制來看看程序的頭巾下面到底發(fā)生了什么的念頭。幸運(yùn)的是，有許許多多的現(xiàn)成的機(jī)制可以讓我們的這項(xiàng)工作變得容易些。這里我將談到我所偏愛的三種方法，你也可以將您自己的方法email給我，我會(huì)考慮加入這一部分。
okay 先說第一種，（調(diào)試/除錯(cuò)輸出字串）outputdebugstring。幸運(yùn)的是microsoft已經(jīng)為我們實(shí)現(xiàn)了一個(gè)非常廣泛的調(diào)試/除錯(cuò)子系統(tǒng)。包括實(shí)現(xiàn)您自己的調(diào)試/除錯(cuò)記錄系統(tǒng)的機(jī)制。程序在一個(gè)調(diào)試/除錯(cuò)進(jìn)程內(nèi)運(yùn)行的時(shí)候，outputdebugstring將它的參數(shù)（一個(gè)c string）輸出到調(diào)試/除錯(cuò)器的輸出上下文，若調(diào)試/除錯(cuò)器沒有運(yùn)行，outputdebugstring就被忽略。如果沒有彈出消息的時(shí)候，outputdebugstring在終端上也可以很好的運(yùn)行，當(dāng)你分發(fā)給客戶前別忘了移去它（通過 #ifdef debug…#endif’），程序可以運(yùn)行的更快一點(diǎn)?！皐ow，又好又容易！”你也許會(huì)說“但當(dāng)程序不能在調(diào)試/除錯(cuò)器內(nèi)運(yùn)行時(shí)，該怎么辦？”
請(qǐng)牢記，這只是我的觀點(diǎn)，基于一種觀念的評(píng)價(jià)，我個(gè)人使用gexperts的dbugint.pas界面來調(diào)試/除錯(cuò)。這是個(gè)非常優(yōu)秀的獨(dú)立的小程序。如果愿意，您可以將它分發(fā)給你的客戶們。如果沒有這么做，象outputdebugstring一樣，如果沒有安裝，它實(shí)際上就什么也不做：）（它將注意終端是否已經(jīng)安裝在機(jī)器上）。要使用dbugint.pas的話很容易，將它加入你的工程并加上 #include "dbugintf.hpp"（因?yàn)槭莗ascal文件，你必須將它加入你的工程以便c++builder編譯器生成hpp頭文件。）然后你只需使用senddebug(“要送到記錄中的字串”)；或者你也許想更靈活些，還有senddebugex－增加一個(gè)消息類型參數(shù)來調(diào)用tmsgdlgtype（詳細(xì)說明參考vcl在線幫助），sendmethodenter, sendmethodexit, and sendseparator 等等(十分自解釋的名字)。只是別忘記加入必須的package包，若你打算將此終端（gdebug.exe）其給你的一些最終用戶的話。gexpert可以從http://www.gexperts.org/ 獲得并且是免費(fèi)的。
第三種我要指出的是，這也許是最難的選擇－實(shí)現(xiàn)你自己的記錄控制臺(tái)。可沒有你想的那么簡單！你也許首先會(huì)想到“扔個(gè)richedit控件在form上，將它設(shè)為只讀的，然后開始記錄，對(duì)嗎？” 錯(cuò)！理論上挺好，但實(shí)踐呢，使用richedit控件來記錄將降低程序的運(yùn)行速度、使內(nèi)存破碎，丟失、通常會(huì)在10分鐘內(nèi)使整個(gè)機(jī)器慢下來?。。ㄒf明白為什么得花上點(diǎn)時(shí)間才行，但我向你可以保證）。所以你所需要的是計(jì)劃好你的記錄機(jī)制的需要，并開始計(jì)劃一個(gè)定制控件若你想要個(gè)彩色的圖標(biāo)的話。還有一個(gè)選擇，需要做點(diǎn)工作，但可是非常有效。就是使用一個(gè)listbox控制來記錄，并將style屬性設(shè)為lbownerdrawfixed，這樣句柄將會(huì)自繪。（這也是gexperts和它的gdebug console所做的）。要做許多工作，但哈哈，如果你想做…
結(jié)合使用記錄機(jī)制與類的異常處理機(jī)制
現(xiàn)在進(jìn)入下一步：）（跟你打賭你從未意識(shí)到設(shè)置一個(gè)優(yōu)秀的調(diào)試/除錯(cuò)系統(tǒng)需要做如此多的工作?。┠悴挥每偸穷A(yù)料各種偶然的異常會(huì)發(fā)生什么，而且絕大多數(shù)時(shí)候當(dāng)程序經(jīng)過大量的除蟲測試（盡量攻擊程序，試圖讓它崩潰）后，你根本不用擔(dān)心這些。下面這個(gè)技術(shù)，我建議任何組件開發(fā)者第一次在ide中測試一個(gè)新組件/新代碼時(shí)應(yīng)該完全遵照。因?yàn)樵趇de中一個(gè)異常會(huì)帶來很多問題，有時(shí)甚至重啟ide也無濟(jì)于事（我自己已經(jīng)這么做了）。其實(shí)也很簡單。在您代碼的每個(gè)函數(shù)前，或者至少在所有主要的函數(shù)前后加上：
try
{
前端代碼
}
catch(exception &e)
{
senddebugmessage(“exception caught in classname::functionname of type:” +e.classname()
+” with the message:”+e.message);
};
（并用函數(shù)的類名及函數(shù)名代替字串中的classname和functionname）。這樣你很快很快就知道異常發(fā)生在何處，也不用你強(qiáng)行關(guān)閉ide啦。
okay,是時(shí)候回顧一下了。classname()方法是如何幫助我們的？不想每次都只得到一個(gè)“exception“串就完了吧？難道是因?yàn)閷聲明為一個(gè)異常？不對(duì)。這是vcl比較酷的部分，任何從tobject繼承來的類能夠自動(dòng)知道其自身的類型、其基類的類型、等等許多有趣的信息，你可以察看tobject的幫助。所以盡管我們使用的是exception &e，e.classname()將會(huì)找出我們得到的異常的實(shí)際的類名（譯者注：c++的多態(tài)性）。這些好處的代價(jià)就是可執(zhí)行文件的體積更大了，幾乎所有的c++builder/delphi程序員都會(huì)發(fā)現(xiàn)這一點(diǎn)。(no pain, no gain)沒有痛苦，就沒有收獲.他們說….
xiphias增加了tstringlist的addingline方法，savetofile方法是另一種記錄（logging）的有效形式。最后應(yīng)該保證你的應(yīng)用程序總是寫記錄文件（logfile），或這每次捕捉到異常時(shí)重寫記錄文件。
處理您代碼外產(chǎn)生的異常
現(xiàn)在的步驟是我們開始學(xué)習(xí)基于ide的除錯(cuò)器之前的最后一個(gè)基于代碼的步驟。但也許在有嚴(yán)重錯(cuò)誤發(fā)生時(shí)，對(duì)裝飾應(yīng)用程序來說這是最重要的步驟。舉例來說，這是顯示一個(gè)包含錯(cuò)誤詳細(xì)內(nèi)容的對(duì)話框理想的時(shí)機(jī)。這時(shí)彈出在屏幕上的對(duì)話框可以方便最終用戶能夠向您報(bào)告錯(cuò)誤。我敢保證您痛恨“oh，有個(gè)什么框子上說在什么地址發(fā)生了個(gè)什么異常錯(cuò)誤”這樣的報(bào)告。其實(shí)完全可以很容易的實(shí)現(xiàn)更好的情況，也不會(huì)限制你打算如何處理它。第一步是在你的主窗體（例如：工程的自動(dòng)創(chuàng)建窗體列表中的第一個(gè)form）中創(chuàng)建一個(gè)象如下這樣的函數(shù)：
void __fastcall applevelexceptionhandler(tobject *sender, exception *e)
{
}
然后加入合適的代碼來顯示錯(cuò)誤（e->message），錯(cuò)誤類型（記住e.classname()，只有此時(shí)才是它的e.classname()），和聯(lián)系您的詳細(xì)方法及其他你想加上的任何東西。第二步當(dāng)然是將它與系統(tǒng)掛鉤，這在c++builder里很容易實(shí)現(xiàn)：
application->onexception=applevelexceptionhandler;
將上一行代碼加到form的 oncreate 事件中。不要吝嗇！你加了這一行后幾乎可以保證不會(huì)錯(cuò)過任何異常,而且無論哪里異常處理失敗時(shí)它都會(huì)出現(xiàn)在你的眼前！
你的回合
現(xiàn)在你已經(jīng)得到所有你剛才學(xué)習(xí)的有用的信息了。是時(shí)候開始把它們加到你現(xiàn)在的工程里去了，否則就忘掉吧，要不然，就把它變成編程習(xí)慣的一部分。這是你的自由！
在這個(gè)系列的下個(gè)部分，我將討論內(nèi)建除錯(cuò)器的使用，來看看你的程序運(yùn)行時(shí)都干些什么，如何單步跟蹤代碼、設(shè)置斷點(diǎn)、察看變量、和會(huì)把新手們嚇的人事不醒的所有其他有趣的工具。直到這里，您的bugs也許只是小蟲子了吧。
原著：bill king
翻譯：史平洋 － cker
版權(quán)說明：
國內(nèi)的網(wǎng)站上，有許多關(guān)于c＋＋builder的內(nèi)容，但多以軟件、組件為主。論壇里也大都不能令人滿意，很空虛的感覺。書籍又都昂貴，內(nèi)容卻有搶錢之嫌。對(duì)銀子不足的初學(xué)者、自學(xué)者關(guān)愛不夠，因而想盡自己的綿薄之力。
文中的所有資料都是從國外網(wǎng)站上收集而來。因?yàn)閑文不方便，所以翻成中文。因?yàn)閑nglish和計(jì)算機(jī)都不是非常好，文中的錯(cuò)誤在所難免。若大家覺得有用的話，我計(jì)劃不斷搜集翻譯一些有用的東西。
有任何意見和建議請(qǐng)mailto：cker@sina.com
您可以隨意復(fù)制、分發(fā)、下載此文檔。但未經(jīng)本人同意，您不可以截取、改動(dòng)本文片斷，或用本文謀取任何形式的利益。
