CA2017: несоответствие счетчика параметров

Свойство	Значение
Идентификатор правила	CA2017
Заголовок	Несоответствие количества параметров
Категория	Надежность
Исправление является критическим или не критическим	Не критическое
Включен по умолчанию в .NET 10	Как предупреждение

Причина

Количество параметров, предоставленных в шаблоне сообщения ведения журнала, не соответствует числу именованных заполнителей.

Описание правила

Это правило помечает вызовы средства ведения журнала с неправильным числом аргументов сообщения.

Устранение нарушений

Соответствует количеству заполнителей в формате шаблона с числом переданных аргументов.

Когда лучше отключить предупреждения

Для этого правила отключать вывод предупреждений не следует.

Example

В следующем примере показаны методы, которые нарушают CA2017 и методы, удовлетворяющие правилу.

public class LoggingExample
{
    private readonly ILogger<LoggingExample> _logger;

    public LoggingExample(ILogger<LoggingExample> logger)
    {
        _logger = logger;
    }

    public void ExampleMethod()
    {
        string name = "Alice";
        int age = 30;

        // Violates CA2017: Too few arguments for placeholders.
        _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age);

        // Violates CA2017: Too many arguments for placeholders.
        _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument");

        // Correct usage: Matching number of placeholders and arguments.
        _logger.LogInformation("User {Name} is {Age} years old", name, age);
    }
}

Imports Microsoft.Extensions.Logging

Public Class LoggingExample

    Private ReadOnly _logger As ILogger(Of LoggingExample)

    Public Sub New(logger As ILogger(Of LoggingExample))
        _logger = logger
    End Sub

    Public Sub ExampleMethod()
        Dim name As String = "Alice"
        Dim age As Integer = 30

        ' Violates CA2017: Too few arguments for placeholders.
        _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age)

        ' Violates CA2017: Too many arguments for placeholders.
        _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument")

        ' Correct usage: Matching number of placeholders and arguments.
        _logger.LogInformation("User {Name} is {Age} years old", name, age)
    End Sub

End Class

См. также

• Правила надежности