CA2254: O modelo deve ser uma expressão estática

  • Artigo
Property valor
ID da regra CA2254
Título O modelo deve ser uma expressão estática
Categoria Utilização
A correção está quebrando ou não quebrando Sem quebra
Habilitado por padrão no .NET 8 Como sugestão

Motivo

Um modelo de mensagem passado para uma API do registrador não é constante. Isso ocorre quando o modelo passado usa concatenação de cadeia de caracteres ou interpolação. Em vez disso, o modelo deve ser um valor constante que representa a mensagem de log no formato de modelo de mensagem. Por exemplo: "User {User} logged in from {Address}". Para obter mais informações, consulte Formatação de modelo de mensagem de log.

Descrição da regra

Ao executar o registro, é desejável preservar a estrutura do log (incluindo nomes de espaço reservado) juntamente com os valores de espaço reservado. A preservação dessas informações permite uma melhor observabilidade e pesquisa em softwares de agregação e monitoramento de logs.

Preferencial:

var firstName = "Lorenz";
var lastName = "Otto";

// This tells the logger that there are FirstName and LastName properties
// on the log message, and correlates them with the argument values.
logger.Warning("Person {FirstName} {LastName} encountered an issue", firstName, lastName);

Não preferido:

// DO NOT DO THIS

var firstName = "Lorenz";
var lastName = "Otto";

// Here, the log template itself is changing, and the association between named placeholders and their values is lost.
logger.Warning("Person " + firstName + " " + lastName + " encountered an issue");

// String interpolation also loses the association between placeholder names and their values.
logger.Warning($"Person {firstName} {lastName} encountered an issue");

O modelo de mensagem de registro não deve variar entre chamadas.

Como corrigir violações

Atualize o modelo de mensagem para ser uma expressão constante. Se você estiver usando valores diretamente no modelo, refatore o modelo para usar espaços reservados nomeados.

logger.Warning("Person {FirstName} {LastName} encountered an issue", firstName, lastName);

Quando suprimir erros

É seguro suprimir um aviso dessa regra se o seu caso de uso não exigir registro estruturado. Também é seguro suprimir essa regra se o modelo de mensagem de log estiver definido em um arquivo de recurso.

Consulte também