CA1506: Vermijd overmatige klassekoppeling

Artikel
09/06/2023

Eigenschappen	Weergegeven als
Regel-id	CA1506
Titel	Vermijd overmatige klassekoppeling
Categorie	Onderhoudbaarheid
Oplossing is brekend of niet-brekend	Breken
Standaarddrempelwaarde	Typen: 95 Andere symbolen: 40
Standaard ingeschakeld in .NET 9	Nee

Oorzaak

Een type, methode, veld, eigenschap of gebeurtenis wordt gekoppeld aan vele andere typen. Door compiler gegenereerde typen worden uitgesloten van deze metrische waarde.

Beschrijving van regel

Deze regel meet klassekoppeling door het aantal unieke typeverwijzingen te tellen dat een type, methode, veld, eigenschap of gebeurtenis bevat. De standaarddrempel voor koppeling is 95 voor typen en 40 voor andere symbooltypen en de drempelwaarden kunnen worden geconfigureerd.

Typen, methoden en andere symbolen met een hoge mate van klassekoppeling kunnen moeilijk te onderhouden zijn. Het is een goede gewoonte om typen, methoden en andere symbolen te hebben die een lage koppeling en een hoge samenhang vertonen.

Schendingen oplossen

U kunt deze schending oplossen door het type of de methode opnieuw te ontwerpen om het aantal typen te verminderen waaraan deze is gekoppeld.

Wanneer waarschuwingen onderdrukken

U kunt deze waarschuwing onderdrukken wanneer het type of de methode als onderhoudbaar wordt beschouwd, ondanks het grote aantal afhankelijkheden van andere typen.

Notitie

U ziet mogelijk fout-positieve waarschuwingen van deze regel als alle volgende van toepassing zijn:

U gebruikt Visual Studio 2022 versie 17.5 of hoger met een oudere versie van de .NET SDK, dat wil zeggen .NET 6 of eerder.
U gebruikt de analyses van de .NET 6 SDK of een oudere versie van de analysepakketten, zoals Microsoft.CodeAnalysis.FxCopAnalyzers.

De fout-positieven zijn te wijten aan een wijziging die fouten veroorzaakt in de C#-compiler. Overweeg om een nieuwere analyse te gebruiken die de oplossing voor de fout-positieve waarschuwingen bevat. Voer een upgrade uit naar Microsoft.CodeAnalysis.NetAnalyzers versie 7.0.0-preview1.22464.1 of hoger of gebruik de analyses van de .NET 7 SDK.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

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

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Drempelwaarde configureren

U kunt de drempelwaarde configureren waarop deze regel wordt geactiveerd en de soorten symbolen die moeten worden geanalyseerd. De toegestane symbooltypen zijn:

Assembly
Namespace
Type
Method
Field
Event
Property

Maak een tekstbestand met de naam CodeMetricsConfig.txt.
Voeg de gewenste drempelwaarde toe aan het tekstbestand in de volgende indeling:
```
CA1506(Method): 60
CA1506(Type): 120
```
In dit voorbeeld wordt de regel geconfigureerd om te worden geactiveerd wanneer een methode meer dan 60 unieke typeverwijzingen heeft of een type meer dan 120 unieke typeverwijzingen heeft. Met dit configuratiebestand blijft de regel velden, eigenschappen en gebeurtenissen markeren waarvan de klassekoppeling groter is dan de standaarddrempelwaarde (40).
Markeer in het projectbestand de buildactie van het configuratiebestand als AdditionalFiles. Bijvoorbeeld:
```
<ItemGroup>
  <AdditionalFiles Include="CodeMetricsConfig.txt" />
</ItemGroup>
```

Share via