CA1501: Evitare ereditarietà eccessiva

Articolo
09/06/2023

Proprietà	valore
ID regola	CA1501
Title	Evitare ereditarietà eccessiva
Categoria	Manutenibilità
La correzione causa un'interruzione o meno	Interruzione
Soglia predefinita	5
Abilitato per impostazione predefinita in .NET 9	No

Causa

Un tipo è di cinque o più livelli profondi nella gerarchia di ereditarietà.

Descrizione regola

Le gerarchie di tipi eccessivamente annidate possono comportare difficoltà di comprensione e gestione. Questa regola limita l'analisi alle gerarchie nello stesso modulo.

È possibile configurare questa regola nei modi seguenti:

Per impostazione predefinita, la regola esclude i tipi dallo spazio dei System nomi. È possibile configurare la regola per escludere anche altri tipi o spazi dei nomi .
È possibile configurare la profondità dell'albero di ereditarietà in corrispondenza della quale viene attivata questa regola.

Come correggere le violazioni

Per correggere una violazione di questa regola, derivare il tipo da un tipo di base meno profondo nella gerarchia di ereditarietà o eliminare alcuni dei tipi di base intermedi.

Quando eliminare gli avvisi

È sicuro eliminare un avviso da questa regola. Tuttavia, il codice potrebbe essere più difficile da gestire. A seconda della visibilità dei tipi di base, la risoluzione delle violazioni di questa regola potrebbe creare modifiche di rilievo. Ad esempio, la rimozione dei tipi di base pubblici è una modifica che causa un'interruzione.

Nota

Se si applicano tutti gli avvisi seguenti, è possibile che vengano visualizzati avvisi falsi positivi da questa regola:

Si usa Visual Studio 2022 versione 17.5 o successiva con una versione precedente di .NET SDK, ovvero .NET 6 o versioni precedenti.
Si usano gli analizzatori di .NET 6 SDK o una versione precedente dei pacchetti analizzatori, ad esempio Microsoft.CodeAnalysis.FxCopAnalyzers.

I falsi positivi sono dovuti a una modifica che causa un'interruzione nel compilatore C#. Prendere in considerazione l'uso di un analizzatore più recente che contiene la correzione per gli avvisi falsi positivi. Eseguire l'aggiornamento a Microsoft.CodeAnalysis.NetAnalyzers versione 7.0.0-preview1.22464.1 o successiva o usare gli analizzatori di .NET 7 SDK.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare la soglia

È possibile configurare la soglia in corrispondenza della quale viene attivata questa regola.

Creare un file di testo denominato CodeMetricsConfig.txt.
Aggiungere la soglia desiderata al file di testo nel formato seguente:
```
CA1501: 8
```
In questo esempio la regola viene configurata per l'avvio quando un tipo è di otto o più livelli nella gerarchia di ereditarietà.
Nel file di progetto contrassegnare l'azione di compilazione del file di configurazione come AdditionalFiles. Ad esempio:
```
<ItemGroup>
  <AdditionalFiles Include="CodeMetricsConfig.txt" />
</ItemGroup>
```

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

Nomi di tipo o spazio dei nomi esclusi dall'ereditarietà

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole di questa categoria (manutenibilità) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Nomi di tipo o spazio dei nomi esclusi dall'ereditarietà

È possibile configurare la regola per escludere determinati tipi o spazi dei nomi dall'albero della gerarchia di ereditarietà. Per impostazione predefinita, tutti i tipi dello System.* spazio dei nomi vengono esclusi. Indipendentemente dal valore impostato, viene aggiunto questo valore predefinito.

Valore opzione	Riepilogo
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = MyType`	Corrisponde a tutti i tipi denominati `MyType` o i cui spazi dei nomi contenitore contengono `MyType` (e tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = MyType1\|MyType2`	Corrisponde a tutti i tipi denominati `MyType1` o o `MyType2` il cui spazio dei nomi contenente contiene `MyType1` o `MyType2` (e tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = T:NS.MyType`	Corrisponde a un tipo `MyType` specifico nello spazio dei nomi (e a tutti i tipi dello spazio `NS` dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = T:NS1.MyType1\|T:NS2.MyType2`	Trova la corrispondenza di tipi `MyType1` specifici e `MyType2` con i rispettivi nomi completi (e tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = N:NS`	Corrisponde a tutti i tipi dello spazio dei `NS` nomi (e a tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = My*`	Trova la corrispondenza con tutti i tipi il cui nome inizia con `My` o le cui parti dello spazio dei nomi contenenti iniziano con `My` (e tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = T:NS.My*`	Trova la corrispondenza con tutti i tipi il cui nome inizia con `My` nello spazio dei nomi `NS` (e tutti i tipi dello spazio dei `System` nomi)
`dotnet_code_quality.CA1501.additional_inheritance_excluded_symbol_names = N:My*`	Trova la corrispondenza con tutti i tipi i cui spazi dei nomi contenitore iniziano con `My` (e tutti i tipi dello spazio dei `System` nomi)

Esempio

L'esempio seguente mostra un tipo che viola la regola:

class BaseClass {}
class FirstDerivedClass : BaseClass {}
class SecondDerivedClass : FirstDerivedClass {}
class ThirdDerivedClass : SecondDerivedClass {}
class FourthDerivedClass : ThirdDerivedClass {}

// This class violates the rule.
class FifthDerivedClass : FourthDerivedClass {}

Imports System

Namespace ca1501

    Class BaseClass
    End Class

    Class FirstDerivedClass
        Inherits BaseClass
    End Class

    Class SecondDerivedClass
        Inherits FirstDerivedClass
    End Class

    Class ThirdDerivedClass
        Inherits SecondDerivedClass
    End Class

    Class FourthDerivedClass
        Inherits ThirdDerivedClass
    End Class

    ' This class violates the rule.
    Class FifthDerivedClass
        Inherits FourthDerivedClass
    End Class

End Namespace

Condividi tramite