Udostępnij za pośrednictwem

CA1002: Nie ujawniaj list generycznych

Właściwości Wartość
Identyfikator reguły CA1002
Tytuł Nie uwidaczniaj list ogólnych
Kategoria Projektowanie
Poprawka łamiąca lub nienaruszająca Przełomowe
Domyślnie włączone na platformie .NET 10 Nie.
Zastosowane języki C# i Visual Basic

Przyczyna

Typ zawiera zewnętrznie widoczny element członkowski, który jest typem System.Collections.Generic.List<T>, zwraca typ List<T>, lub którego podpis zawiera parametr List<T>.

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

Opis reguły

System.Collections.Generic.List<T> to kolekcja ogólna zaprojektowana z myślą o wydajności, a nie dziedziczeniu. List<T> nie zawiera wirtualnych członków, które ułatwiają modyfikację zachowania dziedziczonej klasy. Następujące kolekcje ogólne są przeznaczone do dziedziczenia i powinny być uwidocznione zamiast List<T>.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, zmień typ System.Collections.Generic.List<T> na jedną z kolekcji generycznych, która jest przeznaczona do dziedziczenia.

Example

// This class violates the rule.
public class MutableItems
{
    // CA1002: Change 'List<string>' in 'MutableItems.Items' to
    // use 'Collection<T>', 'ReadOnlyCollection<T>' or 'KeyedCollection<K,V>'.
    public List<string> Items { get; } = [];

    public void Add(string item)
    {
        Items.Add(item);
    }
}

// This class satisfies the rule.
public class ReadOnlyItems
{
    private readonly List<string> _items = [];

    public IReadOnlyCollection<string> Items => _items.AsReadOnly();

    public void Add(string item)
    {
        _items.Add(item);
    }
}

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżenia z tej reguły, chyba że zestaw, który zgłasza to ostrzeżenie, nie ma być biblioteką wielokrotnego użytku. Na przykład można bezpiecznie zignorować to ostrzeżenie w aplikacji zoptymalizowanej pod kątem wydajności, w której korzyści wydajnościowe wynikają z użycia list ogólnych.

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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002

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

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

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

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

Notatka

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

CA1005: Unikaj nadużywania parametrów w typach ogólnych

CA1010: Kolekcje powinny implementować interfejs ogólny

CA1000: Nie deklaruj składowych statycznych w typach ogólnych

CA1003: Użyj wystąpień ogólnych handlerów zdarzeń

Zobacz też

Typy ogólne

  • Last updated on