CA2024: Nie używaj strumieniaReader.EndOfStream w metodach asynchronicznych

Własność	Wartość
identyfikator reguły	CA2024
Tytuł	Nie używaj strumieniaReader.EndOfStream w metodach asynchronicznych
Kategorii	niezawodność
Poprawka jest niezgodna lub nie przerywa	Niezgodność
domyślnie włączone na platformie .NET 10	Jako ostrzeżenie

Przyczyna

Wywołanie StreamReader.EndOfStream jest wykonywane wewnątrz metody asynchronicznej.

Opis reguły

Właściwość StreamReader.EndOfStream może spowodować niezamierzone blokowanie synchroniczne, gdy żadne dane nie są buforowane. Zamiast tego użyj StreamReader.ReadLineAsync() bezpośrednio, co zwraca null po osiągnięciu końca strumienia.

Jak naprawić naruszenia

Aby naprawić naruszenie, bezpośrednio wywołaj StreamReader.ReadLineAsync() i sprawdź wartość zwracaną dla null.

Przykład

Poniższy fragment kodu przedstawia naruszenie 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

Poniższy fragment kodu naprawia naruszenie:

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

Kiedy pomijać ostrzeżenia

Nie należy pomijać ostrzeżeń z tej reguły, ponieważ aplikacja może się zawieszać, jeśli nie naprawisz naruszeń.

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji .

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia analizy kodu.