Listener di traccia

  • Articolo

Nota

Questo articolo è specifico per .NET Framework. Non si applica alle implementazioni più recenti di .NET, incluse .NET 6 e versioni successive.

Quando si usa Trace, Debug e TraceSource, è necessario disporre di un meccanismo per la raccolta e la registrazione dei messaggi inviati. I messaggi di traccia vengono ricevuti dai listener. Il compito di un listener è raccogliere, archiviare e inviare messaggi di errore. I listener indirizzano l'output di tracciatura a una destinazione appropriata, ad esempio un file di log, una finestra o un file di testo.

I listener sono disponibili per le classi Debug, Trace e TraceSource, ognuna delle quali può inviare il proprio output a un'ampia gamma di oggetti listener. Di seguito sono riportati i listener predefiniti comunemente usati:

  • TextWriterTraceListener reindirizza l'output a un'istanza della classe TextWriter o a qualsiasi oggetto che sia una classe Stream. Può anche scrivere nella console o in un file, perché si tratta di classi Stream.

  • EventLogTraceListener reindirizza l'output a un log eventi.

  • DefaultTraceListener genera messaggi Write e WriteLine in OutputDebugString e nel metodo Debugger.Log. In Visual Studio questo comportamento fa sì che i messaggi di debug vengano visualizzati nella finestra di output. I messaggi Assert non riusciti e Fail vengono generati anche nell'API Windows OutputDebugString e nel metodo Debugger.Log e provocano anche la visualizzazione di una finestra di messaggio. Questo comportamento è quello predefinito per i messaggi di Debug e Trace, perché DefaultTraceListener viene automaticamente incluso in ogni raccolta Listeners ed è l'unico listener incluso automaticamente.

  • ConsoleTraceListener reindirizza l'output di traccia o di debug all'output standard o al flusso di errori standard.

  • Tramite l'oggetto DelimitedListTraceListener l'output di traccia o di debug viene indirizzato a un writer di testo, ad esempio un writer di flusso oppure a un flusso, ad esempio un flusso di file. L'output di traccia è in un formato testo delimitato che usa il delimitatore specificato dalla proprietà Delimiter.

  • XmlWriterTraceListener reindirizza l'output di traccia o di debug come dati con codifica XML a un oggetto TextWriter o Stream, come FileStream.

Se si vuole che altri listener oltre a DefaultTraceListener ricevano l'output di Debug, Trace e TraceSource, è necessario aggiungerli alla raccolta Listeners. Per altre informazioni, vedere Procedura: Creare e inizializzare listener di traccia e Procedura: Usare TraceSource e filtri con listener di traccia. Tutti i listener inclusi nella raccolta Listeners ricevono gli stessi messaggi dai metodi di output di traccia. Si supponga, ad esempio, di configurare due listener, TextWriterTraceListener ed EventLogTraceListener. Ogni listener riceve lo stesso messaggio. TextWriterTraceListener reindirizzerà l'output a un flusso, mentre EventLogTraceListener reindirizzerà l'output a un log eventi.

L'esempio seguente mostra come inviare l'output alla raccolta Listeners.

' Use this example when debugging.
Debug.WriteLine("Error in Widget 42")
' Use this example when tracing.
Trace.WriteLine("Error in Widget 42")

// Use this example when debugging.
System.Diagnostics.Debug.WriteLine("Error in Widget 42");
// Use this example when tracing.
System.Diagnostics.Trace.WriteLine("Error in Widget 42");

Poiché Debug e Trace condividono la stessa raccolta Listeners, se si aggiunge un oggetto listener a una raccolta Debug.Listeners nell'applicazione, l'oggetto viene aggiunto anche alla raccolta Trace.Listeners.

L'esempio seguente mostra come usare un listener per inviare informazioni di traccia a una console:

Trace.Listeners.Clear()
Trace.Listeners.Add(New TextWriterTraceListener(Console.Out))

System.Diagnostics.Trace.Listeners.Clear();
System.Diagnostics.Trace.Listeners.Add(
   new System.Diagnostics.TextWriterTraceListener(Console.Out));

Listener definiti dallo sviluppatore

È possibile definire listener personalizzati ereditando dalla classe di base TraceListener ed eseguendo l'override dei metodi della classe con metodi personalizzati. Per altre informazioni sulla creazione di listener definiti dallo sviluppatore, vedere TraceListener negli argomenti di riferimento su .NET Framework.

Vedi anche