Udostępnij za pośrednictwem

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

Właściwości Wartość
Identyfikator reguły CA1063
Tytuł Poprawnie zaimplementuj interfejs IDisposable
Kategoria Projektowanie
Poprawka łamiąca lub nienaruszająca Niezgodność
Domyślnie włączone na platformie .NET 10 Nie.
Zastosowane języki C# i Visual Basic

Przyczyna

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

  • IDisposable jest ponownie zaimplementowany w klasie.
  • Finalize został ponownie zastąpiony.
  • Dispose() jest zastępowany.
  • Metoda nie jest publiczna Dispose() , zapieczętowana ani nazwana Dispose.
  • Dispose(bool) nie jest chroniony, wirtualny ani niezabezpieczony.
  • W niezapieczętowanych typach Dispose() należy wywołać Dispose(true).
  • W przypadku niezapieczętowanych typów implementacja Finalize nie wywołuje ani Dispose(bool), ani finalizatora klasy bazowej.

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 niezapieczętowany typ, który deklaruje i implementuje interfejs IDisposable, musisz zdefiniować Dispose(bool) i go 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 implementowanych przez typ i zamiast tego przesłoń implementację klasy bazowej Dispose.

  • Usuń finalizator z typu, nadpisz metodę Dispose(bool disposing) i umieść logikę finalizacji w ścieżce kodu, w której 'disposing' jest false.

  • Przesłoń metodę Dispose(bool disposing) i umieść logikę zwalniania zasobów w ścieżce kodu, gdzie parametr 'disposing' 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 metoda Dispose(bool) jest zadeklarowana jako chroniona, wirtualna i niezapieczętowana.

  • Zmodyfikuj metodę Dispose(), aby wywołać metodę Dispose(true), a następnie wywołać SuppressFinalize na bieżącym wystąpieniu obiektu (this lub Me w Visual Basic), a następnie zakończyć działanie.

  • Zmodyfikuj finalizator tak, aby wywołał metodę Dispose(false), a następnie zakończył działanie.

  • Jeśli tworzysz niezapieczętowany typ, który deklaruje i implementuje IDisposable interfejs, upewnij się, że implementacja IDisposable jest zgodna ze 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 istotną zmianą 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 kodu mają być objęte tą regułą.

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óre części bazy kodu ma być stosowana ta reguła, na podstawie ich poziomu dostępu, ustawiając opcję api_surface. 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

Uwaga

Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.

Przykład pseudo-kodu

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ż

  • Last updated on