JAFSJosé Antonio Fuentes Santiago

VB.NET: crear un log sencillo

24-07-2012

La posibilidad de tener logs en las aplicaciones nos pueden ayudar bastante en el día a día, sobretodo cuando no podemos depurar nuestro código. Por ello, hoy os propongo un código sencillo para llevar un registro de los eventos de nuestra aplicación en VB.NET.

El código

Imports System.IO

Public Class Logger
  Public Enum TipoMensaje
    DEBUG
    INFO
    WARNING
    LERROR
  End Enum

  Private Const TAM_FICHERO As Integer = 52428800
  Private Const EXTENSION As String = ".log"

  Private Shared eNivel As TipoMensaje = TipoMensaje.DEBUG

  Public Shared Property Nivel As TipoMensaje
    Get
      Return eNivel
    End Get
    Set(eActual As TipoMensaje)
      eNivel = eActual
    End Set
  End Property

  Private Shared Sub add(ByVal eTipo As TipoMensaje, _
                         ByVal sMensaje As String, _
                         Optional ByVal objTraza As StackFrame = Nothing)
    If eTipo >= eNivel Then
      Dim sDestino As String = getFileFecha()

      verificar(sDestino)

      Dim objFichero As New FileStream(sDestino, FileMode.Append, _
                                       FileAccess.Write)

      If Not objFichero Is Nothing And objFichero.CanWrite Then
        Dim sDeb As String = String.Empty
        Dim objFecha As Date = Date.Now

        sDeb = objFecha.ToString() + " [" + eTipo.ToString + "] "
        sDeb &= getTraza(objTraza) & sMensaje

        Dim objStream As New StreamWriter(objFichero)
        objStream.WriteLine(sDeb)
        objStream.Close()
        objFichero.Close()
      End If
    End If
  End Sub

  Private Shared Function getFileFecha() As String
    Dim objFecha As Date = Date.Now
    Dim sCadena As String = String.Empty

    sCadena &= objFecha.Year
    If objFecha.Month < 10 Then
      sCadena &= "0"
    End If
    sCadena &= objFecha.Month
    If objFecha.Day < 10 Then
      sCadena &= "0"
    End If
    sCadena &= objFecha.Day
    sCadena &= EXTENSION

    Return sCadena
  End Function

  Private Shared Sub verificar(sFichero As String)
    Try
      If My.Computer.FileSystem.GetFileInfo(sFichero).Length >= _
         TAM_FICHERO Then
        My.Computer.FileSystem.MoveFile(sFichero, sFichero & ".old")
      End If
    Catch ex As IOException
    End Try
  End Sub

  Public Shared Sub e(sMensaje As String, objExcepcion As Exception, _
                      Optional ByVal objTraza As StackFrame = Nothing)
    add(TipoMensaje.LERROR, sMensaje & vbNewLine & _
        vbTab & objExcepcion.Message & vbNewLine & _
        vbTab & objExcepcion.ToString, objTraza)
  End Sub

  Public Shared Sub e(sMensaje As String, _
                      Optional ByVal objTraza As StackFrame = Nothing)
    add(TipoMensaje.LERROR, sMensaje, objTraza)
  End Sub

  Public Shared Sub w(sMensaje As String, _
                      Optional ByVal objTraza As StackFrame = Nothing)
    add(TipoMensaje.WARNING, sMensaje, objTraza)
  End Sub

  Public Shared Sub i(sMensaje As String, _
                      Optional ByVal objTraza As StackFrame = Nothing)
    add(TipoMensaje.INFO, sMensaje, objTraza)
  End Sub

  Public Shared Sub d(sMensaje As String, _
                      Optional ByVal objTraza As StackFrame = Nothing)
    add(TipoMensaje.DEBUG, sMensaje, objTraza)
  End Sub

  Public Shared Function getTraza(objTraza As StackFrame) As String
    Dim sTraza As String = String.Empty

    If Not objTraza Is Nothing Then
      Dim iPosicion As Integer = objTraza.GetFileName.LastIndexOf("\")

      If iPosicion < 0 Then
        sTraza = objTraza.GetFileName()
      Else
        sTraza = objTraza.GetFileName().Substring(iPosicion + 1)
      End If

      sTraza &= "::" & objTraza.GetFileLineNumber & " - "
    End If

    Return sTraza
  End Function
End Class

Explicación

Lo primero que vemos es el enumerado TipoMensaje que contiene los posibles tipos de registro que tendremos. A la hora de guardar nuestro registro se mostrará el nivel de cada evento.

La función getFileFecha() obtiene el nombre del fichero que vamos a utilizar. Por ejemplo, en el día de escritura de este artículo el nombre obtenido sería: 20120724.log.

El método verificar() lo que hace es analizar el tamaño del fichero de registro. Si este excede el límite que viene dado por la constante TAM_FICHERO se realiza una copia de seguridad y se comienza un nuevo fichero. Esta parte la podéis obviar si no os importa el tamaño de los archivos.

El método add() es el que contiene la parte principal del código. Recibe el tipo de registro, así como el mensaje a almacenar y de forma opcional la traza y se encarga de almacenarlos en el fichero de registro con la fecha y hora actuales.

Los métodos d(), i(), w() y e() hacen de interfaz para simplificar la escritura en el registro y son los métodos que utilizará el usuario o usuaria. El método e() puede recibir un parámetro extra que será un objeto de tipo Exception, de esta forma podremos añadir a nuestro log el contenido de la excepción.

Resultado

El resultado de utilizar nuestra clase Logger sería parecido al siguiente:

24/07/2012 16:37:34 [LERROR] - Este no tiene traza
24/07/2012 16:37:35 [DEBUG] FrmPrueba.vb::7 - Este si tiene traza
24/07/2012 16:37:36 [INFO] FrmPrueba.vb::9 - Mensaje de información.
24/07/2012 16:38:02 [LERROR] FrmPrueba.vb::19 - Ocurrió un error
  Valor demasiado grande o demasiado pequeño para un decimal.
  System.OverflowException: Valor demasiado grande o demasiado pequeño para un decimal.
    en System.Decimal..ctor(Double value)
    en Logger.Form1.btnEnviar_Click(Object sender, EventArgs e) en FrmPrueba.vb:línea 19

Finalmente, veamos como utilizar nuestro sistema de log. Lo primero es indicar el nivel de registro. Por defecto, es DEBUG, pero podemos ponerle un nivel, por ejemplo, de WARNING, esto se haría de la forma siguiente:

Logger.Nivel = Logger.TipoMensaje.WARNING

En este caso sólo se mostrarán los mensajes de WARNING y de ERROR, siendo omitidos los demás.

Ejemplos de uso

Logger.e("Error con excepción", ex)
Logger.d("Debug con traza", New StackFrame(True))
Logger.i("Info sin traza", New StackFrame(True))
Logger.e("Error con excepción y traza", ex, New StackFrame(True))