CA2024: Não use StreamReader.EndOfStream em métodos assíncronos

2025-01-17

Propriedade	Valor
ID da regra	CA2024
de título do	Não use StreamReader.EndOfStream em métodos assíncronos
de Categoria	de Confiabilidade
Correção está quebrando ou não interrompendo	Sem interrupções
Habilitado por padrão no .NET 10	Como aviso

Causa

Uma chamada para StreamReader.EndOfStream é feita dentro de um método assíncrono.

Descrição da regra

A propriedade StreamReader.EndOfStream pode causar bloqueio síncrono não intencional quando nenhum dado é armazenado em buffer. Em vez disso, use StreamReader.ReadLineAsync() diretamente, que retorna null ao chegar ao final do fluxo.

Como corrigir violações

Para corrigir uma violação, chame diretamente StreamReader.ReadLineAsync() e verifique o valor retornado para null.

Exemplo

O snippet de código a seguir mostra uma violação da CA2024:

public async Task Example(StreamReader streamReader)
{
    while (!streamReader.EndOfStream)
    {
        string? line = await streamReader.ReadLineAsync();
        // Do something with line.
    }
}

Public Async Function Example(streamReader As StreamReader) As Task
    While Not streamReader.EndOfStream
        Dim line As String = Await streamReader.ReadLineAsync()
        ' Do something with line.
    End While
End Function

O snippet de código a seguir corrige a violação:

public async Task Example(StreamReader streamReader)
{
    string? line;
    while ((line = await streamReader.ReadLineAsync()) is not null)
    {
        // Do something with line.
    }
}

Public Async Function Example(streamReader As StreamReader) As Task
    Dim line As String = Await streamReader.ReadLineAsync()
    While line IsNot Nothing
        ' Do something with line.
        line = Await streamReader.ReadLineAsync()
    End While
End Function

Quando suprimir avisos

Você não deve suprimir avisos dessa regra, pois seu aplicativo poderá ser travado se você não corrigir as violações.

Suprimir um aviso

Se você quiser suprimir apenas uma única violação, adicione diretivas de pré-processador ao arquivo de origem para desabilitar e, em seguida, reabilitar a regra.

#pragma warning disable CA2024
// The code that's violating the rule is on this line.
#pragma warning restore CA2024

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração .

[*.{cs,vb}]
dotnet_diagnostic.CA2024.severity = none

Para obter mais informações, consulte Como suprimir avisos de análise de código.

Compartilhar via