"Musterbasiertes verwenden" und "Verwenden von Deklarationen""pattern-based using" and "using declarations"

ZusammenfassungSummary

Die Sprache fügt zwei neue Funktionen um die using -Anweisung hinzu, um die Ressourcenverwaltung zu vereinfachen: using sollte ein verwerfbares Muster zusätzlich zu erkennen IDisposable und using der Sprache eine Deklaration hinzufügen.The language will add two new capabilities around the using statement in order to make resource management simpler: using should recognize a disposable pattern in addition to IDisposable and add a using declaration to the language.

MotivationMotivation

Die- using Anweisung ist zurzeit ein effektives Tool für die Ressourcenverwaltung, erfordert aber eine gewisse Zahl von Zeremonien.The using statement is an effective tool for resource management today but it requires quite a bit of ceremony. Methoden mit einer Reihe von zu verwaltenden Ressourcen können mit einer Reihe von-Anweisungen syntaktisch blockiert werden using .Methods that have a number of resources to manage can get syntactically bogged down with a series of using statements. Diese Syntax Belastung ist ausreichend, dass die meisten Richtlinien zum Codierungsstil in diesem Szenario explizit mit geschweiften Klammern zu tun haben.This syntax burden is enough that most coding style guidelines explicitly have an exception around braces for this scenario.

Die using -Deklaration entfernt einen Großteil der Zeremonie an dieser Stelle und erhält c# auf der gleichen Seite wie andere Sprachen, die Ressourcen Verwaltungs Blöcke enthalten.The using declaration removes much of the ceremony here and gets C# on par with other languages that include resource management blocks. Mit dem musterbasierten können using Entwickler zudem den Satz von Typen erweitern, die an dieser Stelle teilnehmen können.Additionally the pattern-based using lets developers expand the set of types that can participate here. In vielen Fällen ist es nicht mehr erforderlich, Wrapper Typen zu erstellen, die nur vorhanden sind, um Werte in einer-Anweisung zu verwenden using .In many cases removing the need to create wrapper types that only exist to allow for a values use in a using statement.

Diese Features ermöglichen es Entwicklern, die Szenarien, in denen angewendet werden kann, zu vereinfachen und zu erweitern using .Together these features allow developers to simplify and expand the scenarios where using can be applied.

Detaillierter EntwurfDetailed Design

using-Deklarationusing declaration

Die Sprache ermöglicht das using Hinzufügen von zu einer lokalen Variablen Deklaration.The language will allow for using to be added to a local variable declaration. Eine solche Deklaration hat denselben Effekt wie das Deklarieren der Variablen in einer- using Anweisung am gleichen Speicherort.Such a declaration will have the same effect as declaring the variable in a using statement at the same location.

if (...) 
{ 
   using FileStream f = new FileStream(@"C:\users\jaredpar\using.md");
   // statements
}

// Equivalent to 
if (...) 
{ 
   using (FileStream f = new FileStream(@"C:\users\jaredpar\using.md")) 
   {
    // statements
   }
}

Die Lebensdauer eines using lokalen wird bis zum Ende des Bereichs erweitert, in dem er deklariert ist.The lifetime of a using local will extend to the end of the scope in which it is declared. Die using lokalen Variablen werden dann in umgekehrter Reihenfolge verworfen, in der Sie deklariert werden.The using locals will then be disposed in the reverse order in which they are declared.

{ 
    using var f1 = new FileStream("...");
    using var f2 = new FileStream("..."), f3 = new FileStream("...");
    ...
    // Dispose f3
    // Dispose f2 
    // Dispose f1
}

Es gibt keine Einschränkungen in Bezug auf goto oder ein anderes Ablauf Steuerungs Konstrukt im Gesicht einer using Deklaration.There are no restrictions around goto, or any other control flow construct in the face of a using declaration. Stattdessen verhält sich der Code genauso wie bei der entsprechenden- using Anweisung:Instead the code acts just as it would for the equivalent using statement:

{
    using var f1 = new FileStream("...");
  target:
    using var f2 = new FileStream("...");
    if (someCondition) 
    {
        // Causes f2 to be disposed but has no effect on f1
        goto target;
    }
}

Eine lokale Deklaration, die in einer using lokalen Deklaration deklariert wird, ist implizit schreibgeschützt.A local declared in a using local declaration will be implicitly read-only. Dies entspricht dem Verhalten der in einer-Anweisung deklarierten lokalen Variablen using .This matches the behavior of locals declared in a using statement.

Die Sprachgrammatik für using Deklarationen lautet wie folgt:The language grammar for using declarations will be the following:

local-using-declaration:
  using type using-declarators

using-declarators:
  using-declarator
  using-declarators , using-declarator
  
using-declarator:
  identifier = expression

Einschränkungen bei der using Deklaration:Restrictions around using declaration:

  • Darf nicht direkt in einer Bezeichnung vorkommen, case sondern muss sich innerhalb eines Blocks innerhalb der case Bezeichnung befinden.May not appear directly inside a case label but instead must be within a block inside the case label.
  • Kann nicht als Teil einer out Variablen Deklaration angezeigt werden.May not appear as part of an out variable declaration.
  • Für jeden Deklarator muss ein Initialisierer vorhanden sein.Must have an initializer for each declarator.
  • Der lokale Typ muss implizit in IDisposable das Muster konvertiert oder erfüllt werden using .The local type must be implicitly convertible to IDisposable or fulfill the using pattern.

Muster basiert mithilfe vonpattern-based using

Die Sprache fügt das Konzept eines verwerfbaren Musters hinzu: ein Typ, der über eine barrierefreie Dispose Instanzmethode verfügt.The language will add the notion of a disposable pattern: that is a type which has an accessible Dispose instance method. Typen, die das verwerfbare Muster erfüllen, können an einer- using Anweisung oder-Deklaration teilnehmen, ohne dass implementiert werden muss IDisposable .Types which fit the disposable pattern can participate in a using statement or declaration without being required to implement IDisposable.

class Resource
{ 
    public void Dispose() { ... }
}

using (var r = new Resource())
{
    // statements
}

Auf diese Weise können Entwickler using in einer Reihe neuer Szenarien nutzen:This will allow developers to leverage using in a number of new scenarios:

  • ref struct: Diese Typen können heute keine Schnittstellen implementieren und können daher nicht an-Anweisungen teilnehmen using .ref struct: These types can't implement interfaces today and hence can't participate in using statements.
  • Erweiterungs Methoden ermöglichen es Entwicklern, Typen in anderen Assemblys für die Teilnahme an Anweisungen zu erweitern using .Extension methods will allow developers to augment types in other assemblies to participate in using statements.

In dem Fall, in dem ein Typ implizit in konvertiert werden kann IDisposable und auch das verwerfbare Muster entspricht, IDisposable wird bevorzugt.In the situation where a type can be implicitly converted to IDisposable and also fits the disposable pattern, then IDisposable will be preferred. Obwohl dies der gegenüberliegende Ansatz von foreach ist (Muster wird gegenüber Interface bevorzugt), ist es aus Gründen der Abwärtskompatibilität erforderlich.While this takes the opposite approach of foreach (pattern preferred over interface) it is necessary for backwards compatibility.

Auch hier gelten dieselben Einschränkungen wie bei einer herkömmlichen using Anweisung: lokale Variablen, die in deklariert using werden, sind schreibgeschützt, ein null Wert verursacht keine Ausnahme, usw... Die Codegenerierung unterscheidet sich nur darin, dass vor dem Aufrufen von "verwerfen" keine Umwandlung in vorhanden ist IDisposable :The same restrictions from a traditional using statement apply here as well: local variables declared in the using are read-only, a null value will not cause an exception to be thrown, etc ... The code generation will be different only in that there will not be a cast to IDisposable before calling Dispose:

{
      Resource r = new Resource();
      try {
            // statements
      }
      finally {
            if (resource != null) resource.Dispose();
      }
}

Um dem verwerfbaren Muster gerecht zu Dispose werden, muss auf die Methode zugegriffen werden können, Parameter lose Parameter und haben einen void Rückgabetyp.In order to fit the disposable pattern the Dispose method must be accessible, parameterless and have a void return type. Es gibt keine weiteren Einschränkungen.There are no other restrictions. Dies bedeutet explizit, dass hier Erweiterungs Methoden verwendet werden können.This explicitly means that extension methods can be used here.

ÜberlegungenConsiderations

Case-Bezeichnungen ohne Blöckecase labels without blocks

Ein using declaration ist case aufgrund von Komplikationen im Zusammenhang mit seiner tatsächlichen Lebensdauer direkt innerhalb einer Bezeichnung unzulässig.A using declaration is illegal directly inside a case label due to complications around its actual lifetime. Eine mögliche Lösung besteht darin, die gleiche Lebensdauer wie eine out var am gleichen Speicherort anzugeben.One potential solution is to simply give it the same lifetime as an out var in the same location. Dies war die zusätzliche Komplexität der Featureimplementierung und die Problem Umgehung (fügen Sie der Bezeichnung einfach einen Block hinzu case ) nicht rechtfertigen, diese Route zu übernehmen.It was deemed the extra complexity to the feature implementation and the ease of the work around (just add a block to the case label) didn't justify taking this route.

Zukünftige ErweiterungenFuture Expansions

lokale Variablenfixed locals

Eine- fixed Anweisung verfügt über alle Eigenschaften von- using Anweisungen, die die Möglichkeit haben, lokale zu haben using .A fixed statement has all of the properties of using statements that motivated the ability to have using locals. Beachten Sie, dass diese Funktion auch auf lokale Erweiterungen erweitert werden muss fixed .Consideration should be given to extending this feature to fixed locals as well. Die Lebensdauer-und Bestell Regeln sollten für und hier gleichermaßen gut angewendet werden using fixed .The lifetime and ordering rules should apply equally well for using and fixed here.