System.Diagnostics命名空間裏的Debug類和Trace類的用途

在 .NET 類庫中有一個 System.Diagnostics 命名空間，該命名空間提供了一些與系統進程、事件日誌、和性能計數器進行交互的類庫。當中包括了兩個對開發人員而言十分有用的類——Debug類和Trace類。本文介紹了這兩個類的一些基本用途，旨在提高廣大開發人員的開發效率。
使用Debug類來幫助調試

調試程序對每個程序員來說是家常便飯。可是我們會經常遇到一些情況讓我們頭疼，例如：

當我們在開發一個界面控件的時候，簡單的設斷點會增加Paint事件的響應次數，而造成的環境參數改變。
斷點設多了，程序常常停在正常運行的地方；這樣一來，調試一個錯誤要花費大量時間去尋找錯誤。
這時，我們就需要利用System.Diagnostics.Debug類來幫助我們調試。我們可以通過調用Debug.WriteLine(String message)函數，將我們所關心的信息打印在Visual Studio IDE的Output窗口中。也可以利用Debug.Assert(bool condition)來讓程序停在錯誤的地方，並且顯示Call stack。

Debug類中所有函數的調用都不會在Release版本里有效。也就是說，我們通過這種方法所加的代碼可以僅用於調試；在發佈的時候無需刪任何代碼，就可以給用戶一個沒有調試指令的程序了。

下面的這個例子演示了這兩個函數來幫助調試的方法：

1、 新建一個Visual Studio C# Project，採用默認的項目名。

2、 往Form1上拖一個label，並採用其缺省ID。

3、 在Form1.cs中的Form1類中添加下面的函數代碼：

private int time=0;
protected override void OnPaint(PaintEventArgs e)
{
time++;
this.label1.Text="OnPain called "+time.ToString()+" Times.";
}

protected override void OnResize(EventArgs e)
{
System.Diagnostics.Debug.Assert(this.Width>200,"Width should be larger than 200.");
System.Diagnostics.Debug.WriteLine(Size.ToString());
}

4、 編譯並運行項目的Debug版本。

5、 切換Visual Studio .NET IDE到Output窗口。

6、 切換到剛纔的程序，改變主窗口的大小，您可以在IDE中看到Form1窗口的實時大小，並在Form1上看到OnPaint被調用的次數。當窗口的寬度小於等於200個像素的時候，系統會彈出一個Assertion Fail的對話框。裏面顯示了當前程序的Call Stack。如果您在OnPaint中設置了斷點，想要調試程序的話，那麼您會進入一個死循環，直到您停止調試。

Debug類和Trace類的區別

您一定發現了在System.Diagnostics命名空間中還有一個名爲Trace的類。它的函數功能和Debug非常相似。爲什麼要有這樣兩個功能類似的類呢？

原因是這樣的，Debug類裏所提供的函數僅在編譯時帶#Debug宏參數才奏效，一旦到了Release版本中，這些函數都會被忽略。也就是說Debug類的功能僅在程序員開發的時候能用。而Trace則不同，它能在Release版本的程序中也被運行，這樣程序員就可以在Release版本的程序中添加一些Debug類提供的功能了。

使用Trace類來做程序日誌

接下來的問題就是：我們程序員能利用Trace類的功能做些什麼呢？我們可以用它來做程序的日誌。

1、 打開剛剛的project。

2、 用下面的代碼覆蓋剛纔第2步的代碼：

private void Calculate()
{
int a=1,b=1;
try
{
System.Random r = new Random();
while (true)
{
a=(int)(r.NextDouble()*10);
b=(int)(r.NextDouble()*10);
System.Diagnostics.Trace.WriteLine(System.DateTime.Now.ToString()+": "+
a.ToString()+"/"+b.ToString()+"="+(a/b).ToString());
}
}
catch (Exception ex)
{
System.Diagnostics.Trace.WriteLine(System.DateTime.Now.ToString()+": "+a.ToString()+
"/"+b.ToString()+"="+" ERROR: "+ex.Message);
MessageBox.Show(ex.Message);
}
}

3、 在構造函數Form1()的最後添加下面的代碼，將Trace的輸出重定向到app.log文件中：

System.Diagnostics.Trace.Listeners.Clear();
System.Diagnostics.Trace.AutoFlush=true;
System.Diagnostics.Trace.Listeners.Add(new System.Diagnostics.TextWriterTraceListener("app.log"));

4、 拖一個按鈕到該Form上，雙擊按鈕，在button1_Click函數中添加如下代碼：

Calculate();
Application.Exit();

5、 運行該程序的Release版本，點擊添加的按鈕，程序便開始執行一位隨機數除法。由於是隨機數，可能會出現出數爲0的情況，這樣程序就會拋出Exception，這是程序會自動中止。

6、 在該程序所在的目錄裏您可以發現出現了一個新的文件app.log，裏面記錄了各個時刻的運算紀錄，並把Exception紀錄在日誌中。

小結

利用 System.Diagnostics.Debug 類和 System.Diagnostics.Trace 類可以幫助程序員方便地進行調試程序並檢測程序運行情況。

Debug類的所有調用僅在程序的Debug版本中有效；而Trace類的調用能在Release版本和Debug版本中都有效。