語言
備註
本文專指 .NET 框架。 此規定不適用於較新的 .NET 實作,包括 .NET 6 及更新版本。
追蹤開關讓你能啟用、停用並過濾追蹤輸出。
建立與初始化追蹤交換器
要使用追蹤開關,你必須先建立它們並放入程式碼中。 有兩個預設類別可以建立 switch 物件:類別(class System.Diagnostics.BooleanSwitch )和類別(class System.Diagnostics.TraceSwitch )。 如果你只在意追蹤訊息是否出現,你會使用 BooleanSwitch ;如果你想區分追蹤層級,則會使用 TraceSwitch 。 如果你使用TraceSwitch,你可以定義自己的除錯訊息,並將其與不同的追蹤層級關聯起來。 你可以將這兩種開關與追蹤或除錯搭配使用。 預設情況下,a BooleanSwitch 被禁用,a TraceSwitch 被設定為 level TraceLevel.Off。 追蹤開關可以建立並放置在程式碼中任何可能會使用它們的部分。
雖然你可以在程式碼中設定追蹤等級及其他設定選項,但我們建議使用設定檔來管理交換器的狀態。 這是因為在配置系統中管理交換器的設定,能讓你有更大的彈性——你可以在不重新編譯應用程式的情況下,開關各種開關並更改音量。
建立並初始化追蹤交換器
將交換器定義為類型 System.Diagnostics.BooleanSwitch 或類型 System.Diagnostics.TraceSwitch ,並設定交換器的名稱與描述。
配置你的追蹤開關。 欲了解更多資訊,請參閱 「配置追蹤交換器」。
以下程式碼會產生兩個開關,分別對應一種類型:
Dim dataSwitch As New BooleanSwitch("Data", "DataAccess module") Dim generalSwitch As New TraceSwitch("General", "Entire application")System.Diagnostics.BooleanSwitch dataSwitch = new System.Diagnostics.BooleanSwitch("Data", "DataAccess module"); System.Diagnostics.TraceSwitch generalSwitch = new System.Diagnostics.TraceSwitch("General", "Entire application");
配置追蹤開關
應用程式已散布後,你仍可透過設定應用程式中的追蹤開關來啟用或停用追蹤輸出。 配置交換器是指在初始化後,從外部來源更改其值。 你可以用設定檔更改開關物件的值。 你可以將追蹤開關設定為開啟或關閉,或設定其層級,以決定傳遞給監聽器的訊息數量和類型。
你的交換器是用 .config 檔案來設定的。 對於網頁應用程式而言,這是與專案相關的 Web.config 檔案。 在 Windows 應用程式中,這個檔案命名為(應用程式名稱).exe.config。在已部署的應用程式中,這個檔案必須與執行檔位於同一個資料夾中。
當你的應用程式首次執行建立交換器實例的程式碼時,會檢查設定檔以尋找關於該交換器的追蹤層級資訊。 追蹤系統只檢查一次設定檔,針對特定交換器——也就是你的應用程式第一次建立該交換器時。
在已部署的應用程式中,當應用程式未執行時,透過重新配置交換器物件來啟用追蹤程式碼。 通常這包括開啟或關閉開關物件,或是改變追蹤等級,然後重新啟動應用程式。
當你建立交換器實例時,也會透過指定兩個參數來初始化: displayName 參數和 描述 參數。 建構子的 displayName 參數會設定 Switch.DisplayName 類別 Switch 實例的屬性。 displayName 是用來在 .config 檔案中設定交換器的名稱,描述參數應回傳交換器的簡短描述及其控制的訊息。
除了指定要設定的開關名稱外,你還必須指定該開關的值。 這個值是一個整數。 對於 BooleanSwitch,值為 0 對應於 Off,任何非零值對應 於 On。 對於 TraceSwitch、0、1、2、3 和 4 分別對應 關閉、錯誤、警告、資訊 和 冗長。 任何大於 4 的數字都被視為 冗長,任何小於零的數字都被視為 Off。
備註
在 .NET Framework 2.0 版本中,你可以用文字來指定交換器的值。 例如,true 對於 BooleanSwitch,或代表列舉值的文本的 Error 對於 TraceSwitch。 該直線 <add name="myTraceSwitch" value="Error" /> 等價於 <add name="myTraceSwitch" value="1" />。
為了讓終端使用者能夠配置應用程式的追蹤交換器,您必須提供應用程式中交換器的詳細文件。 你應該詳細說明每個開關的控制功能,以及如何開啟和關閉它們。 你也應該提供最終使用者一個 .config 檔案,並在留言中提供適當的幫助。
設定追蹤交換器
要使用走線開關,你必須先建立它們,並依照 「建立與初始化走線交換器」章節的描述,將其放入程式碼中。
如果您的專案沒有設定檔(app.config 或 Web.config),則在 專案 選單中選擇 新增項目。
視覺基礎: 在 新增項目 對話框中,選擇 應用程式設定檔。
應用程式設定檔會被建立並開啟。 這是一個 XML 文件,其根元素為
<configuration>.視覺 C#: 在 新增項目 對話框中,選擇 XML 檔案。 這個檔案名稱 app.config。在 XML 編輯器中,XML 宣告後,新增以下 XML:
<configuration> </configuration>當專案編譯完成時,app.config 檔案會被複製到專案輸出資料夾,並重新命名 為應用程式名稱.exe.config。
在
<configuration>標籤之後和</configuration>標籤之前,加入適當的 XML 來配置您的開關。 以下範例展示了具有 DisplayName 屬性的DataMessageSwitch以及具有 DisplayName 屬性的TraceLevelSwitch。<system.diagnostics> <switches> <add name="DataMessagesSwitch" value="0" /> <add name="TraceLevelSwitch" value="0" /> </switches> </system.diagnostics>在此配置下,兩個開關皆關閉。
如果你需要開啟布林開關(BooleanSwitch
DataMessagesSwitch),如前述範例所示,請將值改為除 0 以外的任意整數。如果你需要開啟 TraceSwitch,如
TraceLevelSwitch前述範例所示,請將 Value 調整到適當的電平設定(1 到 4)。在 .config 檔案中加入註解,讓終端使用者清楚了解該更改哪些值以適當配置交換器。
以下範例展示了最終程式碼(包括註解)可能的樣貌:
<system.diagnostics> <switches> <!-- This switch controls data messages. In order to receive data trace messages, change value="0" to value="1" --> <add name="DataMessagesSwitch" value="0" /> <!-- This switch controls general messages. In order to receive general trace messages change the value to the appropriate level. "1" gives error messages, "2" gives errors and warnings, "3" gives more detailed error information, and "4" gives verbose trace information --> <add name="TraceLevelSwitch" value="0" /> </switches> </system.diagnostics>