.NET中Trace類和Debug類的應用舉例

.NET中的Trace類和Debug類是System.Diagnostics名稱空間下的兩個用於除錯的類，在軟體開發中使用得當，可以幫助我們除錯開發程式，提高效率，很有用。其中，Debug類僅在除錯版本中有效，而Trace類在除錯版本和正式版本中均有效。

（1）下面先介紹下Debug類的使用：

Debug類的宣告原型：public sealed class Debug

從宣告中，我們可以看出，Debug類是無法繼承的。它的成員情況，請參見：

先看一個例子：

TestDebug.cs：

/*

* User: GoGo

* Date: 2007-12-12

* Email:[email protected]

* Blog:http://blog.csdn.net/id_9527

*/

using System;

using System.Collections.Generic;

using System.Text;

using System.Diagnostics; //引入Debug類所在名稱空間

namespace traceanddebug

{

class TestDebug

{

public static void TestDebugMethod()

{

Debug.Listeners.Add(new TextWriterTraceListener

//將Debug類輸出定向到控制檯輸出

Debug.AutoFlush = true;

//設定Debug為自動輸出，即每次寫入後都呼叫Listeners上呼叫Flush

Debug.Indent();

//設定縮排

Debug.WriteLine("Debug WriteLine()");

//用Debug輸出"Debug WriteLine()"

Console.WriteLine("Console.WriteLine()");

//用Console輸出"Console.WriteLine()"

Debug.WriteLine("Debug WriteLine2()");

//用Debug

Debug.Unindent();

//取消縮排

Console.Read();

}

}

}

Program.cs

using System;

using System.Collections.Generic;

using System.Text;

namespace traceanddebug

{

class Program

{

static void Main(string[] args)

{

TestDebug.TestDebugMethod();

}

}

}

結果顯示如下：

Debug WriteLine()

Console.WriteLine()

Debug WriteLine2()

從例子中，我們可以看出，Debug可以向控制檯顯示資訊。需要注意的是，我們在使用Debug時候，需要引入System.Diagnostics名稱空間。同樣，我們也可以把資訊寫入文字中，例如，把TestDebug.cs中

Debug.Listeners.Add(new TextWriterTraceListener(Console.Out));

一句修改為：

Debug.Listeners.Add(new TextWriterTraceListener("c://testdebug2.log","testdebug"));

就可以向c盤的根目錄下的testdebug2.log檔案中寫入資訊了。

給你留個小問題，你能讓debug資訊寫入windows的事件檢視器裡面麼？

（看看下面的Trace類的例子，也許你就有思路了）

值得注意的是，Debug類的程式碼在release版本中是無效的，也就是說，所有的Debug類輸出語句在釋出的時候，是不會輸出的，你不用特意刪除Debug類的程式碼，就能給使用者一個沒有除錯語句的程式了。這個用起來是不是很方便呢？

Debug類除了輸出資訊之外，還有一個靜態成員函式很有用，就是Debug.Assert方法。它有三種過載形式：

Debug.Assert(Boolean)

Debug.Assert(Boolean, String)

Debug.Assert(Boolean, String)

它的作用為：檢查條件，如果該條件為 false，則顯示訊息。此函式會顯示相關堆疊資訊。

例如，我們在上面的TestDebug.cs中TestDebugMethod函式中加入一下語句：

Debug.Assert(false,"test assert");

那麼執行時，就會停在Debug.Assert呼叫的地方，彈出一個對話方塊，顯示資訊及堆疊資訊。我們在實際應用的時候，需要講例子中的false換成條件判斷，如果不滿足條件，就會停止。

（2）下面介紹Trace類的使用：

Trace類的宣告原型為：public sealed class Trace，其成員情況，請參加網址：

同樣，我們先從小例子來認識Trace類：

TestTrace.cs

/*

* User: GoGo

* Date: 2007-12-12

* Email:[email protected]

* Blog:http://blog.csdn.net/id_9527

*/

using System;

using System.Diagnostics;

namespace traceanddebug

{

public class TestTrace

{

public static void TheTrace()

{

Trace.Listeners.Add(new TextWriterTraceListener(Console.Out));

Trace.WriteLine("Trace !!!");

Console.ReadKey();

}

}

}

Program.cs

using System;

using System.Collections.Generic;

using System.Text;

namespace traceanddebug

{

class Program

{

static void Main(string[] args)

{

TestTrace.TheTrace();

}

}

}

編譯執行程式，輸出結果如下：

Trace !!!

從這個例子中，我們可以看出，Trace類可以像Debug類一樣輸出資訊到控制檯。同樣，Trace類可以設定輸出定向到文字檔案或者日誌中。可以新增一下程式碼測試：

Trace.Listeners.Add(new TextWriterTraceListener("testtrace.log"));

Trace.Listeners.Add(new EventLogTraceListener("testtrace"));

Trace.AutoFlush = true;

這樣就同時把Trace!!這個字串寫入testtrace.log檔案和事件檢視器中應用程式裡面了。

除了在程式中設定資訊輸出位置外，還可以在配置檔案中設定跟蹤除錯資訊的輸出位置。預設是在控制檯輸出。我們可以通過新增配置引數，修改輸出位置。例如：

假設我們的執行程式為traceanddebug.exe，我們在相同目錄下建立traceanddebug.exe.config配置檔案，輸入如下內容：

<configuration>

<system.diagnostics>

<trace autoflush="true" indentsize="1">

<listeners>

<remove name="Default"></remove>

<add type="System.Diagnostics.EventLogTraceListener" name="myEventLog" initializeData="application">

</add>

</listeners>

</trace>

</system.diagnostics>

</configuration>

這樣我們可以修改程式TheTrace()為：

//Trace.Listeners.Add(new TextWriterTraceListener(Console.Out));

Trace.WriteLine("Trace !!!");

Console.ReadKey();

這樣就可以把結果直接寫入事件檢視器中。

由於Trace類可以在釋出版本中起作用，所以，在做Trace輸出資訊的時候，可能有些資訊是除錯的時候需要，釋出的時候又不需要了，那怎麼才能保證資訊不在釋出的時候輸出呢？.NET為我們提供了五個控制Trace的跟蹤級別，使用它們不必重新編譯，他們跟別是：

是否顯示訊息，由TraceSwich開關類決定。即如果設定開關為4，那麼所有的Trace訊息都將顯示；如果設定為3，那麼設定為Verbose的Trace訊息就不顯示了，其餘的都顯示；如果設定為0，所有的訊息都不顯示了。這裡設定的開關，可以在配置檔案中設定，也可以在程式中設定，下面就舉例說明。

TestTrace.cs

/*

* User: GoGo

* Date: 2007-12-12

* Email:[email protected]

* Blog:http://blog.csdn.net/id_9527

*/

using System;

using System.Diagnostics;

namespace traceanddebug

{

public class TestTrace

{

public static TraceSwitch ts = new TraceSwitch("mySwitch", "in the Config file");

public static void TheTrace()

{

Trace.WriteLineIf(ts.TraceError,"Error!!!");

Trace.WriteLineIf(ts.TraceWarning,"Warning!!!");

Trace.WriteLineIf(ts.TraceInfo,"Info!!!");

Trace.WriteLineIf(ts.TraceVerbose,"Verbose!!!");

Console.ReadKey();

}

}

}

Program.cs

using System;

using System.Collections.Generic;

using System.Text;

namespace traceanddebug

{

class Program

{

static void Main(string[] args)

{

TestTrace.TheTrace();

}

}

}

編譯出的可執行檔名為：traceanddebug.exe

我們在相同目錄下，新增配置檔案traceanddebug.exe.config，並輸入內容為：

traceanddebug.exe.config

<configuration>

<system.diagnostics>

<switches>

<add name="mySwitch" value="0" />

</switches>

</system.diagnostics>

</configuration>

編譯執行，沒有顯示資訊。我們將traceanddebug.exe.config用記事本開啟，修改mySwitch的值為1，儲存，編譯執行，結果顯示”Error!!!”；同理，我們依次，將值修改為2，3，4檢視結果，分別為Warning!!!，Info!!!，Verbose!!!。

有此，我們可以看出，通過控制開關級別，就可以顯示不同的級別的資訊，而不用重新編譯，那麼及時在軟體已經發布的時候，我們也可以通過修改配置檔案，而檢視相關資訊。

通過以上的內容，我們可以對Trace和Debug類有個大概的瞭解，那麼如果你需要除錯程式，不妨用一下這兩個類。