Compartir a través de

Instrucción using: asegúrese del uso correcto de objetos descartables

La instrucción using garantiza el uso correcto de una instancia IDisposable:

var numbers = new List<int>();
using (StreamReader reader = File.OpenText("numbers.txt"))
{
    string line;
    while ((line = reader.ReadLine()) is not null)
    {
        if (int.TryParse(line, out int number))
        {
            numbers.Add(number);
        }
    }
}

Cuando el control deja el bloque de la using instrucción , se elimina la instancia adquirida IDisposable . En concreto, la instrucción using garantiza que una instancia descartable se elimine incluso si se produce una excepción dentro del bloque de la instrucción using. En el ejemplo anterior, se cierra un archivo abierto después de procesar todas las líneas.

Use la instrucción await using para usar correctamente una instancia IAsyncDisposable:

await using (var resource = new AsyncDisposableExample())
{
    // Use the resource
}

Para obtener más información sobre el uso IAsyncDisposable de instancias, consulte la sección Uso de descartables asincrónicos del artículo Implementación de un método DisposeAsync .

También puede usar una using que no requiera llaves:

static IEnumerable<int> LoadNumbers(string filePath)
{
    using StreamReader reader = File.OpenText(filePath);
    
    var numbers = new List<int>();
    string line;
    while ((line = reader.ReadLine()) is not null)
    {
        if (int.TryParse(line, out int number))
        {
            numbers.Add(number);
        }
    }
    return numbers;
}

Cuando se declara en una declaración using, una variable local se elimina al final del ámbito en el que se declara. En el ejemplo anterior, la eliminación se produce al final de un método.

La referencia del lenguaje C# documenta la versión publicada más recientemente del lenguaje C#. También contiene documentación inicial sobre las características de las versiones preliminares públicas de la próxima versión del lenguaje.

La documentación identifica cualquier característica introducida por primera vez en las últimas tres versiones del idioma o en las versiones preliminares públicas actuales.

Sugerencia

Para buscar cuándo se introdujo por primera vez una característica en C#, consulte el artículo sobre el historial de versiones del lenguaje C#.

Una variable declarada por la instrucción using o declaración es readonly. No se puede reasignar ni pasarlo como parámetro ref o out .

Puede declarar varias instancias del mismo tipo en una instrucción using, tal como se muestra en el ejemplo siguiente:

using (StreamReader numbersFile = File.OpenText("numbers.txt"), wordsFile = File.OpenText("words.txt"))
{
    // Process both files
}

Cuando se declaran varias instancias en una instrucción using, se eliminan en orden inverso al de declaración.

También puede usar la instrucción y la declaración using con una instancia de una estructura ref que se ajuste al patrón descartable. Es decir, tiene un método de instancia Dispose accesible, sin parámetros y tiene un void tipo de valor devuelto.

Un return interior de un using bloque garantiza la eliminación. El compilador vuelve a escribirlo en , try/finallypor lo que siempre se llama al recurso Dispose antes de que el método devuelva realmente.

La instrucción using también puede tener el siguiente formato:

using (expression)
{
    // ...
}

donde expression genera una instancia descartable. En el ejemplo siguiente se muestra ese formulario:

StreamReader reader = File.OpenText(filePath);

using (reader)
{
    // Process file content
}

Advertencia

En el ejemplo anterior, después de que el control salga de la instrucción using, una instancia descartable permanece en el ámbito aunque ya está desechada. Si usa más esa instancia, podría encontrar una excepción, por ejemplo, ObjectDisposedException. Por eso debe declarar una variable descartable dentro de la using instrucción o con la using declaración .

Especificación del lenguaje C#

Para obtener más información, vea la sección Using statement de la especificación del lenguaje C#.

Consulte también

  • Last updated on