Logger Logger Logger Logger Class

Definizione

In caso di override in una classe derivata, offre funzionalità per i logger che gestiscono gli eventi generati dal motore MSBuild.When overridden in a derived form, provides functionality for loggers that handle events raised by the MSBuild engine.

public ref class Logger abstract : Microsoft::Build::Framework::ILogger
public abstract class Logger : Microsoft.Build.Framework.ILogger
type Logger = class
    interface ILogger
Public MustInherit Class Logger
Implements ILogger
Ereditarietà
LoggerLoggerLoggerLogger
Implementazioni

Esempi

Nell'esempio seguente viene illustrato come scrivere un logger di base che risponde agli eventi di compilazione.The following example shows how to write a basic logger that responds to build events.

using System;
using System.IO;
using System.Security;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

namespace MyLoggers
{
	// This logger will derive from the Microsoft.Build.Utilities.Logger class,
	// which provides it with getters and setters for Verbosity and Parameters,
	// and a default empty Shutdown() implementation.
	public class BasicFileLogger : Logger
	{
		/// <summary>
		/// Initialize is guaranteed to be called by MSBuild at the start of the build
		/// before any events are raised.
		/// </summary>
		public override void Initialize(IEventSource eventSource)
		{
			// The name of the log file should be passed as the first item in the
			// "parameters" specification in the /logger switch.  It is required
			// to pass a log file to this logger. Other loggers may have zero or more than 
			// one parameters.
			if (null == Parameters)
			{
				throw new LoggerException("Log file was not set.");
			}
			string[] parameters = Parameters.Split(';');
			
			string logFile = parameters[0];
			if (String.IsNullOrEmpty(logFile))
			{
				throw new LoggerException("Log file was not set.");
			}
			
			if (parameters.Length > 1)
			{
				throw new LoggerException("Too many parameters passed.");
			}
			
			try
			{
				// Open the file
				this.streamWriter = new StreamWriter(logFile);
			}
			catch (Exception ex)
			{
				if
				(
					ex is UnauthorizedAccessException
					|| ex is ArgumentNullException
					|| ex is PathTooLongException
					|| ex is DirectoryNotFoundException
					|| ex is NotSupportedException
					|| ex is ArgumentException
					|| ex is SecurityException
					|| ex is IOException
				)
				{
					throw new LoggerException("Failed to create log file: " + ex.Message);
				}
				else
				{
					// Unexpected failure
					throw;
				}
			}

			// For brevity, we'll only register for certain event types. Loggers can also
			// register to handle TargetStarted/Finished and other events.
			eventSource.ProjectStarted += new ProjectStartedEventHandler(eventSource_ProjectStarted);
			eventSource.TaskStarted += new TaskStartedEventHandler(eventSource_TaskStarted);
			eventSource.MessageRaised += new BuildMessageEventHandler(eventSource_MessageRaised);
			eventSource.WarningRaised += new BuildWarningEventHandler(eventSource_WarningRaised);
			eventSource.ErrorRaised += new BuildErrorEventHandler(eventSource_ErrorRaised);
			eventSource.ProjectFinished += new ProjectFinishedEventHandler(eventSource_ProjectFinished);
		}

		void eventSource_ErrorRaised(object sender, BuildErrorEventArgs e)
		{
			// BuildErrorEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters
			string line = String.Format(": ERROR {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber);
			WriteLineWithSenderAndMessage(line, e);
		}
		
		void eventSource_WarningRaised(object sender, BuildWarningEventArgs e)
		{
			// BuildWarningEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters
			string line = String.Format(": Warning {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber);
			WriteLineWithSenderAndMessage(line, e);
		}

		void eventSource_MessageRaised(object sender, BuildMessageEventArgs e)
		{
			// BuildMessageEventArgs adds Importance to BuildEventArgs
			// Let's take account of the verbosity setting we've been passed in deciding whether to log the message
			if ((e.Importance == MessageImportance.High && IsVerbosityAtLeast(LoggerVerbosity.Minimal))
				|| (e.Importance == MessageImportance.Normal && IsVerbosityAtLeast(LoggerVerbosity.Normal))
				|| (e.Importance == MessageImportance.Low && IsVerbosityAtLeast(LoggerVerbosity.Detailed))				
				)
			{
				WriteLineWithSenderAndMessage(String.Empty, e);
			}
		}

		void eventSource_TaskStarted(object sender, TaskStartedEventArgs e)
		{
			// TaskStartedEventArgs adds ProjectFile, TaskFile, TaskName
			// To keep this log clean, this logger will ignore these events.
		}
		
		void eventSource_ProjectStarted(object sender, ProjectStartedEventArgs e)
		{
			// ProjectStartedEventArgs adds ProjectFile, TargetNames
			// Just the regular message string is good enough here, so just display that.
			WriteLine(String.Empty, e);
			indent++;
		}

		void eventSource_ProjectFinished(object sender, ProjectFinishedEventArgs e)
		{
			// The regular message string is good enough here too.
			indent--;
			WriteLine(String.Empty, e);
		}
		
		/// <summary>
		/// Write a line to the log, adding the SenderName and Message
		/// (these parameters are on all MSBuild event argument objects)
		/// </summary>
		private void WriteLineWithSenderAndMessage(string line, BuildEventArgs e)
		{
			if (0 == String.Compare(e.SenderName, "MSBuild", true /*ignore case*/))
			{
				// Well, if the sender name is MSBuild, let's leave it out for prettiness
				WriteLine(line, e);
			}
			else
			{
				WriteLine(e.SenderName + ": " + line, e);
			}
		}
		
		/// <summary>
		/// Just write a line to the log
		/// </summary>
		private void WriteLine(string line, BuildEventArgs e)
		{
			for (int i = indent; i > 0; i--)
			{
				streamWriter.Write("\t");
			}
			streamWriter.WriteLine(line + e.Message);
		}
		
		/// <summary>
		/// Shutdown() is guaranteed to be called by MSBuild at the end of the build, after all 
		/// events have been raised.
		/// </summary>
		public override void Shutdown()
		{
			// Done logging, let go of the file
			streamWriter.Close();
		}

		private StreamWriter streamWriter;
		private int indent;
	}
}

Commenti

Questa classe astratta fornisce implementazioni predefinite per i metodi e proprietà del ILogger interfaccia.This abstract class provides default implementations for the methods and properties of the ILogger interface.

Questa classe è possibile creare solo istanze in un form derivato.This class can only be instantiated in a derived form.

Costruttori

Logger() Logger() Logger() Logger()

Inizializza una nuova istanza della classe Logger.Initializes a new instance of the Logger class.

Proprietà

Parameters Parameters Parameters Parameters

Ottiene o imposta i parametri del logger definiti dall'utente.Gets or sets the user-defined parameters of the logger.

Verbosity Verbosity Verbosity Verbosity

Ottiene o imposta il livello di dettaglio da visualizzare nel registro eventi.Gets or sets the level of detail to show in the event log.

Metodi

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
FormatErrorEvent(BuildErrorEventArgs) FormatErrorEvent(BuildErrorEventArgs) FormatErrorEvent(BuildErrorEventArgs) FormatErrorEvent(BuildErrorEventArgs)

Genera un messaggio di errore nel formato predefinito in base a un oggetto BuildErrorEventArgs.Generates an error message that is in the default format, from a BuildErrorEventArgs object.

FormatWarningEvent(BuildWarningEventArgs) FormatWarningEvent(BuildWarningEventArgs) FormatWarningEvent(BuildWarningEventArgs) FormatWarningEvent(BuildWarningEventArgs)

Genera un messaggio di avviso nel formato predefinito, in base a un oggetto BuildWarningEventArgs.Generates a warning message that is in the default format, from a BuildWarningEventArgs object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
Initialize(IEventSource) Initialize(IEventSource) Initialize(IEventSource) Initialize(IEventSource)

In caso di override in una classe derivata, sottoscrive eventi specifici per il logger.When overridden in a derived class, subscribes the logger to specific events.

IsVerbosityAtLeast(LoggerVerbosity) IsVerbosityAtLeast(LoggerVerbosity) IsVerbosityAtLeast(LoggerVerbosity) IsVerbosityAtLeast(LoggerVerbosity)

Determina se l'impostazione corrente della proprietà Verbosity è almeno pari al valore passato.Determines whether the current Verbosity setting is at least the value that is passed in.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
Shutdown() Shutdown() Shutdown() Shutdown()

In caso di override in una classe derivata, rilascia le risorse allocate nel logger al momento dell'inizializzazione o durante la compilazione.When overridden in a derived class, releases the resources allocated to the logger at the time of initialization or during the build.

ToString() ToString() ToString() ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Si applica a