共用方式為


追蹤和檢測應用程式 (機器翻譯)

注意

本文專屬於 .NET Framework。 其不適用於較新的 .NET 實作,包括 .NET 6 和更新版本。

追蹤可讓您在應用程式執行時,監視應用程式的執行。 您可以在開發 .NET Framework 應用程式時,加入追蹤和偵錯檢測,當您在開發應用程式時,以及將其部署之後,都可以使用該檢測。 您可以使用 System.Diagnostics.TraceSystem.Diagnostics.DebugSystem.Diagnostics.TraceSource 類別,將錯誤和應用程式執行的相關資訊,記錄在記錄檔、文字檔案或其他裝置中,以供稍後進行分析。

「檢測」一詞是指監視或測量產品效能層級,以及診斷錯誤的能力。 在程式設計中,這表示應用程式納入下列項目的能力:

  • 程式碼追蹤 - 接收在執行階段有關應用程式執行的參考訊息。

  • 偵錯 - 追蹤並修正開發中之應用程式的程式設計錯誤。 如需詳細資訊,請參閱偵錯

  • 效能計數器 - 可讓您追蹤應用程式效能的元件。 如需相關資訊,請參閱 Performance Counters

  • 事件記錄檔 - 這些元件可讓您接收和追蹤應用程式執行時的主要事件。 如需詳細資訊,請參閱 EventLog 類別。

在程式碼的策略性位置上放置追蹤陳述式來檢測應用程式,特別適用於分散式應用程式。 使用追蹤陳述式可讓您檢測應用程式,不僅可以在發生錯誤時顯示資訊,還可以監視應用程式執行的效能。

TraceSource 類別提供增強的追蹤功能,並可用來取代較舊之 TraceDebug 追蹤類別的靜態方法。 熟悉的 TraceDebug 類別仍廣為使用,但是建議將 TraceSource 類別用於新的追蹤命令,例如 TraceEventTraceData

TraceDebug 類別相同,只是根據預設,Trace 類別的程序和函式會編譯成發行組建,但 Debug 類別的程序和函式並不會編譯成發行組建。

TraceDebug 類別提供方法來監視及檢查開發期間或部署後的應用程式效能。 例如,您可使用 Trace 類別來追蹤出現於部署應用程式中的特定動作類型 (例如,建立新的資料庫連接),並藉此監視應用程式的效率。

程式碼追蹤和偵錯

在開發期間,您可以使用 Debug 類別的輸出方法,在 Visual Studio 整合式開發環境 (IDE) 的 [輸出] 視窗中顯示訊息。 例如:

Trace.WriteLine("Hello World!")
Debug.WriteLine("Hello World!")
System.Diagnostics.Trace.WriteLine("Hello World!");
System.Diagnostics.Debug.WriteLine("Hello World!");

在偵錯工具中執行應用程式時,每個範例都會在 [輸出] 視窗中顯示「Hello World!」。

這可讓您偵錯應用程式,並依據其於測試環境中的的行為,將其效能最佳化。 您可在已啟動 Debug 條件屬性的偵錯組建中進行應用程式偵錯,以接收所有的偵錯輸出。 當您準備發行應用程式時,可以在不啟動 Debug 條件屬性的情況下編譯發行組建,如此編譯器就不會將偵錯程式碼納入最終可執行檔中。 如需詳細資訊,請參閱如何:使用追蹤和偵錯進行條件式編譯。 如需您的應用程式適用之不同組建組態的詳細資訊,請參閱編譯和建置

您還可以使用 Trace 類別的方法,追蹤已安裝應用程式中程式碼執行的情形。 將追蹤參數放在您的程式碼中,可控制是否進行追蹤及其廣泛程度。 這可讓您監視應用程式在生產環境中的狀態。 這很重要,特別是在有多個元件在多部電腦上執行的商務應用程式中。 您可以透過組態檔來控制部署之後如何使用參數。 如需詳細資訊,請參閱如何:建立、初始化和設定追蹤參數

在開發要使用追蹤的應用程式時,您通常會將追蹤和偵錯訊息都包含在應用程式程式碼中。 當您準備好要部署應用程式時,可以編譯發行組建,而不需開啟偵錯條件屬性。 不過,您可以開啟追蹤條件屬性,讓編譯器在可執行檔中包含您的追蹤程式碼。 如需詳細資訊,請參閱如何:使用追蹤和偵錯進行條件式編譯

程式碼追蹤的階段

程式碼追蹤分為三個階段:

  1. 檢測 — 您將追蹤程式碼新增到您的應用程式。

  2. 追蹤 — 追蹤程式碼將資訊寫入指定的目標。

  3. 分析 — 您評估追蹤資訊,以識別並了解應用程式中的問題。

根據預設,在開發期間,所有偵錯和追蹤輸出方法都會將資訊寫入 Visual Studio 中的 [輸出] 視窗。 在已部署的應用程式中,這些方法會將追蹤資訊寫入您指定的目標。 若要了解如何指定追蹤或偵錯的輸出目標,請參閱追蹤接聽項

以下是在已部署的應用程式中,使用追蹤來分析及更正潛在問題時,常用的主要步驟整體概觀。 如需有關如何執行這些步驟的詳細資訊,請參閱適當的連結。

若要在應用程式中使用追蹤
  1. 請考慮您在部署應用程式之後,會想要在現場接收哪些追蹤輸出。

  2. 建立一組參數。 如需詳細資訊,請參閱如何:設定追蹤參數

  3. 將追蹤陳述式加入應用程式程式碼

  4. 決定您想要讓追蹤輸出出現在哪裡,並加入適當的接聽程式。 如需詳細資訊,請參閱建立和初始化追蹤接聽項

  5. 測試和偵錯您的應用程式,以及其包含的追蹤程式碼。

  6. 使用下列其中一個程序,將應用程式編譯為可執行的程式碼:

    • 使用 [建置] 功能表,以及方案總管中 [屬性頁] 對話方塊的 [偵錯] 頁面。 在 Visual Studio 中進行編譯時,請使用此選項。

      - 或 -

    • 使用追蹤偵錯編譯器指示詞來進行命令列方法的編譯。 如需詳細資訊,請參閱使用追蹤和偵錯進行條件式編譯。 從命令列編譯時,請使用此選項。

  7. 如果在執行階段期間發生問題,請開啟適當的追蹤參數。 如需詳細資訊,請參閱設定追蹤參數

    追蹤程式碼會將追蹤訊息寫入指定的目標,例如畫面、文字檔或事件記錄檔。 您包含在 Trace.Listeners 集合中的接聽項型別會決定目標。

  8. 分析追蹤訊息,以識別並了解應用程式中的問題。

追蹤檢測和分散式應用程式

當您建立分散式應用程式時,可能會發現很難以將要使用應用程式的方式來測試應用程式。 很少有開發小組能夠測試所有可能的作業系統或 Web 瀏覽器的組合 (包括所有當地語系化的語言選項),或是模擬將會同時存取應用程式的大量使用者。 在這些情況下,您無法測試分散式應用程式將如何回應龐大的數量、不同的設定,以及獨特的終端使用者行為。 此外,分散式應用程式的許多部分都沒有使用者介面可讓您直接互動或檢視的那些部分的活動。

不過,為了彌補這一點,您可以「檢測」應用程式,也就是將追蹤陳述式放在程式碼的策略性位置上,讓分散式應用程式向系統管理員描述所感興趣的特定事件,尤其是出差錯的事情。 然後如果在執行階段時發生非預期的事件 (例如,回應時間極慢),您就可以判斷可能的原因。

利用追蹤陳述式,您可以避免掉一些困難的工作,例如,檢查原始來源程式碼、加以修改、重新編譯,以及嘗試在偵錯環境內產生執行階段錯誤。 請記住,檢測應用程式不但可以顯示錯誤,還能監視效能。

追蹤陳述式的策略位置

在放置追蹤陳述式,以在執行階段使用時,您必須特別小心。 您必須考量,在所部署的應用程式中,可能會需要哪些追蹤資訊,以充分涵蓋所有可能的追蹤案例。 使用追蹤的應用程式差異甚大,但是並沒有追蹤策略位置的一般方針。 如需有關放置追蹤陳述式的詳細資訊,請參閱如何:將追蹤陳述式新增到應用程式程式碼

追蹤的輸出

追蹤輸出是由稱為「接聽項」的物件來收集。 接聽程式是會接收追蹤輸出,並將其寫入輸出裝置 (通常是視窗、記錄檔或文字檔) 的物件。 建立追蹤接聽程式時,通常會將它加入至 Trace.Listeners 集合,讓接聽程式能夠接收所有的追蹤輸出。

追蹤資訊一定至少會寫入至預設的 Trace 輸出目標,也就是 DefaultTraceListener。 如果您因為某種原因而已經刪除了 DefaultTraceListener,而且未將任何其他接聽程式加入至 Listeners 集合,您將不會接收到任何追蹤訊息。 如需詳細資訊,請參閱追蹤接聽項

下表列出寫入追蹤資訊的六個 Debug 成員和 Trace方法。

方法 輸出
Assert 指定的文字;或者如果未指定,則為呼叫堆疊。 唯有在 Assert 陳述式中指定做為引數的條件是 false 時,才會寫入輸出。
Fail 指定的文字;或者如果未指定,則為呼叫堆疊。
Write 指定的文字。
WriteIf 指定的文字 (如果符合在 WriteIf 陳述式中指定作為引數的條件)。
WriteLine 指定的文字和歸位字元。
WriteLineIf 指定的文字和歸位字元 (如果符合在 WriteLineIf 陳述式中指定作為引數的條件)。

Listeners 集合中的所有接聽程式都會接收上表中所述的訊息,但是採取的動作會因接收訊息的接聽程式種類而異。 例如,當 DefaultTraceListener 收到 Fail 或失敗的 Assert 通知時,會顯示判斷提示對話方塊,但 TextWriterTraceListener 僅會將輸出寫入資料流中。

您可以實作自己的接聽程式來產生自訂結果。 比方說,自訂追蹤接聽程式可能會將訊息顯示在訊息方塊,或連接至資料庫,以將訊息加入資料表。 所有自訂接聽程式應該都會支援上述六種方法。 如需有關如何建立開發人員定義之接聽程式的詳細資訊,請參閱 .NET Framework 參考中的 TraceListener

WriteWriteLine 方法一律會寫入您指定的文字。 AssertWriteIfWriteLineIf 需要 Boolean 引數,以控制是否要寫入指定的文字;只有當運算式為 true (針對 WriteIfWriteLineIf) 或 false (針對 Assert) 時,才會寫入指定的文字。 Fail 方法一律會寫入指定的文字。 如需詳細資訊,請參閱如何:將追蹤陳述式新增到應用程式程式碼和 .NET Framework 參考。

安全性考量

如果您在部署 ASP.NET 應用程式之前,沒有先停用追蹤和偵錯,您的應用程式可能會顯示其本身會遭惡意程式利用的相關資訊。 如需詳細資訊,請參閱如何:使用追蹤和偵錯進行條件式編譯編譯和建置,以及如何:建立、初始化和設定追蹤參數。 偵錯也可以透過 Internet Information Services (IIS) 來設定。

另請參閱