CA1063: Należy prawidłowo zaimplementować interfejs IDisposable

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1063
Stanowisko Poprawnie zaimplementuj interfejs IDisposable
Kategoria Projekt
Poprawka powodująca niezgodność lub niezgodność Niezgodność
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Interfejs System.IDisposable nie jest poprawnie zaimplementowany. Możliwe przyczyny tego:

  • IDisposable element jest ponownie zaimplementowany w klasie .
  • Finalize jest ponownie zastępowany.
  • Dispose() jest zastępowany.
  • Metoda nie jest publiczna Dispose() , zapieczętowana ani nazwana Dispose.
  • Dispose(bool) nie jest chroniony, wirtualny lub niezaużytowany.
  • W niezaużytowanych typach Dispose() należy wywołać metodę Dispose(true).
  • W przypadku niezauczętowanych typów implementacja Finalize nie wywołuje finalizatora klasy bazowej ani obu tych Dispose(bool) typów.

Naruszenie dowolnego z tych wzorców wyzwala ostrzeżenie CA1063.

Każdy niezaziemowany typ, który deklaruje i implementuje IDisposable interfejs, musi podać własną protected virtual void Dispose(bool) metodę. Dispose() powinien wywołać metodę Dispose(true), a finalizator powinien wywołać metodę Dispose(false). Jeśli tworzysz niezaziemowany typ, który deklaruje i implementuje IDisposable interfejs, musisz go zdefiniować Dispose(bool) i wywołać. Aby uzyskać więcej informacji, zobacz Oczyszczanie niezarządzanych zasobów (przewodnik platformy .NET) i Implementowanie metody Dispose.

Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.

Opis reguły

Wszystkie IDisposable typy powinny poprawnie zaimplementować wzorzec Dispose.

Jak naprawić naruszenia

Sprawdź swój kod i określ, które z następujących rozwiązań naprawi to naruszenie:

  • Usuń IDisposable z listy interfejsów, które są implementowane przez typ, i przesłoń implementację klasy bazowej Dispose zamiast tego.

  • Usuń finalizator z typu, przesłoń metodę Dispose(bool disposing) i umieść logikę finalizacji w ścieżce kodu, w której "dysponowanie" jest fałszywe.

  • Zastąpij metodę Dispose (usuwanie wartości logicznej) i umieść logikę usuwania w ścieżce kodu, w której "dysponowanie" ma wartość true.

  • Upewnij się, że funkcja Dispose() jest zadeklarowana jako publiczna i zapieczętowana.

  • Zmień nazwę metody dispose na Dispose i upewnij się, że jest zadeklarowana jako publiczna i zapieczętowana.

  • Upewnij się, że elementy Dispose(bool) są zadeklarowane jako chronione, wirtualne i niezauczalne.

  • Zmodyfikuj metodę Dispose(), aby wywołać metodę Dispose(true), a następnie wywołać SuppressFinalize bieżące wystąpienie obiektu (thislub Me w Visual Basic), a następnie powrócić.

  • Zmodyfikuj finalizator tak, aby wywołał metodę Dispose(false), a następnie zwróci wartość .

  • Jeśli tworzysz niezaziemowany typ, który deklaruje i implementuje IDisposable interfejs, upewnij się, że implementacja jest zgodna ze IDisposable wzorcem opisanym wcześniej w tej sekcji.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły.

Uwaga

Jeśli wszystkie następujące elementy mają zastosowanie, mogą pojawić się ostrzeżenia fałszywie dodatnie z tej reguły:

  • Używasz programu Visual Studio 2022 w wersji 17.5 lub nowszej ze starszą wersją zestawu .NET SDK, czyli platformą .NET 6 lub starszą.
  • Używasz analizatorów z zestawu .NET 6 SDK lub starszej wersji pakietów analizatora, takich jak Microsoft.CodeAnalysis.FxCopAnalyzers.
  • Masz atrybuty implementacji IDispose .

W takim przypadku można bezpiecznie pominąć ostrzeżenie fałszywie dodatnie. Wyniki fałszywie dodatnie są spowodowane zmianą powodującą niezgodność w kompilatorze języka C#. Rozważ użycie nowszego analizatora zawierającego poprawkę dla ostrzeżeń fałszywie dodatnich. Przeprowadź uaktualnienie do wersji Microsoft.CodeAnalysis.NetAnalyzers w wersji 7.0.0-preview1.22464.1 lub nowszej lub użyj analizatorów z zestawu .NET 7 SDK.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (Projekt), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Przykład przykładowy kod przykładowy

Poniższy pseudo-kod zawiera ogólny przykład sposobu implementacji Dispose(bool) w klasie, która używa zarządzanych i natywnych zasobów.

public class Resource : IDisposable
{
    private bool isDisposed;
    private IntPtr nativeResource = Marshal.AllocHGlobal(100);
    private AnotherResource managedResource = new AnotherResource();

    // Dispose() calls Dispose(true)
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    // The bulk of the clean-up code is implemented in Dispose(bool)
    protected virtual void Dispose(bool disposing)
    {
        if (isDisposed) return;

        if (disposing)
        {
            // free managed resources
            managedResource.Dispose();
        }

        // free native resources if there are any.
        if (nativeResource != IntPtr.Zero)
        {
            Marshal.FreeHGlobal(nativeResource);
            nativeResource = IntPtr.Zero;
        }

        isDisposed = true;
    }

    // NOTE: Leave out the finalizer altogether if this class doesn't
    // own unmanaged resources, but leave the other methods
    // exactly as they are.
    ~Resource()
    {
        // Finalizer calls Dispose(false)
        Dispose(false);
    }
}

Zobacz też