Compartir vía

CA1848: Usar los delegados LoggerMessage

Propiedad Value
Identificador de la regla CA1848
Título Utilizar los delegados LoggerMessage
Categoría Rendimiento
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 10 No

Causa

Uso de los métodos de extensión de registrador, como LogInformation y LogDebug.

Descripción de la regla

Para escenarios de registro de alto rendimiento, use el patrón LoggerMessage en lugar de los métodos de Logger<T> extensión.

Cómo corregir infracciones

Use LoggerMessageAttribute para corregir infracciones de esta regla. (O bien, si usa .NET 5 o versiones anteriores, use la LoggerMessage clase ).

public class SomethingDoer
{
   private readonly ILogger _logger;
   public SomethingDoer(ILogger<SomethingDoer> logger)
   {
       _logger = logger;
   }

   public void DoSomething()
   {
       // This call violates CA1848.
       _logger.LogInformation("Did something!");
   }
}

El código siguiente corrige la infracción.

public partial class SomethingDoer
{
   private readonly ILogger _logger;
   public SomethingDoer(ILogger<SomethingDoer> logger)
   {
       _logger = logger;
   }

   public void DoSomething()
   {
       Log_DidSomething();
   }

   [LoggerMessage(Level = LogLevel.Information, Message = "Did something!")]
   private partial void Log_DidSomething();
}

LoggerMessage proporciona las siguientes ventajas de rendimiento sobre Logger<T> los métodos de extensión:

  • Los métodos de extensión del registrador requieren la conversión boxing de tipos de valor, como int, en object. El patrón LoggerMessage impide la conversión boxing mediante métodos de extensión y campos Action estáticos con parámetros fuertemente tipados.
  • Los métodos de extensión del registrador deben analizar la plantilla de mensaje (cadena de formato con nombre) cada vez que se escribe un mensaje de registro. LoggerMessage solo necesita analizar una vez una plantilla cuando se define el mensaje.

Cuándo suprimir las advertencias

No suprima las advertencias de esta regla.

Consulte también

  • Last updated on