Delen via

CA2000: Objecten verwijderen voordat het bereik verloren gaat

  • Artikel
Eigenschappen Weergegeven als
Regel-id CA2000
Titel Objecten verwijderen voordat het bereik verloren gaat
Categorie Betrouwbaarheid
Oplossing is brekend of niet-brekend Niet-brekend
Standaard ingeschakeld in .NET 9 Nee

Oorzaak

Er wordt een lokaal object van een IDisposable type gemaakt, maar het object wordt niet verwijderd voordat alle verwijzingen naar het object buiten het bereik vallen.

Deze regel analyseert standaard de hele codebasis, maar dit kan worden geconfigureerd.

Beschrijving van regel

Als een wegwerpobject niet expliciet wordt verwijderd voordat alle verwijzingen naar het object buiten het bereik vallen, wordt het object op een onbepaald tijdstip verwijderd wanneer de garbagecollector de finalizer van het object uitvoert. Omdat er een uitzonderlijke gebeurtenis kan optreden die verhindert dat het object wordt uitgevoerd, moet het object expliciet worden verwijderd.

Speciale gevallen

Regel CA2000 wordt niet geactiveerd voor lokale objecten van de volgende typen, zelfs als het object niet wordt verwijderd:

Het doorgeven van een object van een van deze typen aan een constructor en het vervolgens toewijzen aan een veld geeft aan dat het eigendom wordt overgedragen naar het nieuw samengestelde type. Dat wil gezegd, het zojuist gebouwde type is nu verantwoordelijk voor het verwijderen van het object. Als uw code een object van een van deze typen doorgeeft aan een constructor, treedt er geen schending van regel CA2000 op, zelfs als het object niet wordt verwijderd voordat alle verwijzingen naar het object buiten het bereik vallen.

Schendingen oplossen

Als u een schending van deze regel wilt oplossen, roept Dispose u het object aan voordat alle verwijzingen naar het object buiten het bereik vallen.

U kunt de using instructie (Using in Visual Basic) gebruiken om objecten te verpakken die worden geïmplementeerd IDisposable. Objecten die op deze manier zijn verpakt, worden automatisch aan het einde van het using blok verwijderd. De volgende situaties mogen echter niet of niet worden verwerkt met een using instructie:

  • Als u een wegwerpobject wilt retourneren, moet het object worden samengesteld in een try/finally blok buiten een using blok.

  • Initialiseer geen leden van een wegwerpobject in de constructor van een using instructie.

  • Wanneer constructors die worden beveiligd door slechts één uitzonderingshandler zijn genest in het overnamegedeelte van een using instructie, kan een fout in de buitenste constructor ertoe leiden dat het object dat is gemaakt door de geneste constructor nooit wordt gesloten. In het volgende voorbeeld kan een fout in de StreamReader constructor ertoe leiden dat het FileStream object nooit wordt gesloten. CA2000 markeert een schending van de regel in dit geval.

    using (StreamReader sr = new StreamReader(new FileStream("C:/myfile.txt", FileMode.Create)))
{ ... }

  • Dynamische objecten moeten een schaduwobject gebruiken om het verwijderingspatroon van IDisposable objecten te implementeren.

Wanneer waarschuwingen onderdrukken

Een waarschuwing van deze regel niet onderdrukken, tenzij:

  • U hebt een methode aangeroepen voor uw object dat aanroept Dispose, zoals Close.
  • De methode die de waarschuwing heeft gegenereerd, retourneert een IDisposable object dat uw object verpakt.
  • De toewijzingsmethode heeft geen eigendom van verwijdering; Dat wil gezegd: de verantwoordelijkheid voor het verwijderen van het object wordt overgedragen naar een ander object of wrapper dat is gemaakt in de methode en wordt geretourneerd naar de aanroeper.

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

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.CA2000.severity = none

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Code configureren om te analyseren

Gebruik de volgende opties om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.

U kunt deze opties configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (betrouwbaarheid) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.

Specifieke symbolen uitsluiten

U kunt specifieke symbolen, zoals typen en methoden, uitsluiten van analyse. Als u bijvoorbeeld wilt opgeven dat de regel niet mag worden uitgevoerd op code binnen benoemde MyTypetypen, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Toegestane notaties voor symboolnamen in de optiewaarde (gescheiden door |):

  • Alleen symboolnaam (inclusief alle symbolen met de naam, ongeacht het type of de naamruimte).
  • Volledig gekwalificeerde namen in de documentatie-id-indeling van het symbool. Voor elke symboolnaam is een voorvoegsel van het type symbool vereist, zoals M: voor methoden, T: voor typen en N: voor naamruimten.
  • .ctor voor constructors en .cctor voor statische constructors.

Voorbeelden:

Optiewaarde Samenvatting
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType Komt overeen met alle symbolen met de naam MyType.
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2 Komt overeen met alle symbolen met de naam of MyType1 MyType2.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType) Komt overeen met een specifieke methode MyMethod met de opgegeven volledig gekwalificeerde handtekening.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType) Komt overeen met specifieke methoden MyMethod1 en MyMethod2 met de respectieve volledig gekwalificeerde handtekeningen.

Specifieke typen en hun afgeleide typen uitsluiten

U kunt specifieke typen en hun afgeleide typen uitsluiten van analyse. Als u bijvoorbeeld wilt opgeven dat de regel niet mag worden uitgevoerd op methoden binnen benoemde MyType typen en de afgeleide typen, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Toegestane notaties voor symboolnamen in de optiewaarde (gescheiden door |):

  • Alleen de naam van het type (bevat alle typen met de naam, ongeacht het type of de naamruimte).
  • Volledig gekwalificeerde namen in de documentatie-id-indeling van het symbool, met een optioneel T: voorvoegsel.

Voorbeelden:

Optiewaarde Samenvatting
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType Komt overeen met alle typen met de naam MyType en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2 Komt overeen met alle typen met de naam MyType1 of MyType2 en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType Komt overeen met een specifiek type MyType met een volledig gekwalificeerde naam en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2 Komt overeen met specifieke typen MyType1 en MyType2 met de respectieve volledig gekwalificeerde namen en alle afgeleide typen.

Voorbeeld 1

Als u een methode implementeert die een wegwerpobject retourneert, gebruikt u een try/final block zonder catch-blok om ervoor te zorgen dat het object wordt verwijderd. Door een try/finally block te gebruiken, kunt u uitzonderingen genereren op het foutpunt en ervoor zorgen dat het object wordt verwijderd.

In de Methode OpenPort1 kan de aanroep om het ISerializable object SerialPort te openen of de aanroep naar SomeMethod mislukken. Er wordt een CA2000-waarschuwing gegenereerd over deze implementatie.

In de Methode OpenPort2 worden twee SerialPort-objecten gedeclareerd en ingesteld op null:

  • tempPort, die wordt gebruikt om te testen of de methodebewerkingen slagen.

  • port, dat wordt gebruikt voor de retourwaarde van de methode.

Het tempPort wordt gebouwd en geopend in een try blok en alle andere vereiste werkzaamheden worden uitgevoerd in hetzelfde try blok. Aan het einde van het try blok wordt de geopende poort toegewezen aan het port object dat wordt geretourneerd en het tempPort object is ingesteld nullop .

Het finally blok controleert de waarde van tempPort. Als deze niet null is, is een bewerking in de methode mislukt en tempPort wordt deze gesloten om ervoor te zorgen dat alle resources worden vrijgegeven. Het geretourneerde poortobject bevat het geopende SerialPort-object als de bewerkingen van de methode zijn geslaagd, of het is null als een bewerking is mislukt.

public SerialPort OpenPort1(string portName)
{
   SerialPort port = new SerialPort(portName);
   port.Open();  //CA2000 fires because this might throw
   SomeMethod(); //Other method operations can fail
   return port;
}

public SerialPort OpenPort2(string portName)
{
   SerialPort tempPort = null;
   SerialPort port = null;
   try
   {
      tempPort = new SerialPort(portName);
      tempPort.Open();
      SomeMethod();
      //Add any other methods above this line
      port = tempPort;
      tempPort = null;

   }
   finally
   {
      if (tempPort != null)
      {
         tempPort.Close();
      }
   }
   return port;
}

Public Function OpenPort1(ByVal PortName As String) As SerialPort

   Dim port As New SerialPort(PortName)
   port.Open()    'CA2000 fires because this might throw
   SomeMethod()   'Other method operations can fail
   Return port

End Function

Public Function OpenPort2(ByVal PortName As String) As SerialPort

   Dim tempPort As SerialPort = Nothing
   Dim port As SerialPort = Nothing

   Try
      tempPort = New SerialPort(PortName)
      tempPort.Open()
      SomeMethod()
      'Add any other methods above this line
      port = tempPort
      tempPort = Nothing

   Finally
      If Not tempPort Is Nothing Then
         tempPort.Close()
      End If

   End Try

   Return port

End Function

Voorbeeld 2

De Visual Basic-compiler heeft standaard alle rekenkundige operatoren die controleren op overloop. Daarom kan elke Visual Basic-rekenkundige bewerking een OverflowException. Dit kan leiden tot onverwachte schendingen in regels zoals CA2000. De volgende functie CreateReader1 produceert bijvoorbeeld een CA2000-schending omdat de Visual Basic-compiler een instructie voor overloopcontrole verzendt voor de toevoeging die een uitzondering kan genereren waardoor StreamReader niet kan worden verwijderd.

U kunt dit oplossen door het verzenden van overloopcontroles door de Visual Basic-compiler in uw project uit te schakelen of u kunt uw code wijzigen zoals in de volgende functie CreateReader2.

Als u het verzenden van overloopcontroles wilt uitschakelen, klikt u met de rechtermuisknop op de projectnaam in Solution Explorer en selecteert u Eigenschappen. Selecteer Geavanceerde compileeropties en schakel vervolgens overloopcontroles voor gehele getallen verwijderen in.>

Imports System.IO

Class CA2000
    Public Function CreateReader1(ByVal x As Integer) As StreamReader
        Dim local As New StreamReader("C:\Temp.txt")
        x += 1
        Return local
    End Function


    Public Function CreateReader2(ByVal x As Integer) As StreamReader
        Dim local As StreamReader = Nothing
        Dim localTemp As StreamReader = Nothing
        Try
            localTemp = New StreamReader("C:\Temp.txt")
            x += 1
            local = localTemp
            localTemp = Nothing
        Finally
            If (Not (localTemp Is Nothing)) Then
                localTemp.Dispose()
            End If
        End Try
        Return local
    End Function
End Class

Zie ook