Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C#

System.IDisposable: vlastnictví a deterministické uvolňování prostředků

`System.IDisposable` je kontrakt pro synchronní uvolňování prostředků. Pomocí `using` určíte, kdy k uvolnění dojde; vlastnictví určuje, kdo za něj odpovídá.

Verze: C# 12 and .NET 8; later runtimes may add compatible features

Syntaxe

// Separate syntax fragments, not a complete program.
// .NET API excerpt for reference only; do not redeclare it in consumer code.
namespace System
{
    public interface IDisposable
    {
        void Dispose();
    }
}

// In the two alternatives below, Acquire() is a placeholder for resource acquisition.

// Statement: dispose on exit from the block.
using (System.IDisposable resource = Acquire())
{
    // Use resource.
}

// Declaration (alternative): dispose on exit from the enclosing scope.
using System.IDisposable resource = Acquire();

System.IDisposable je rozhraní .NET s jedinou metodou void Dispose(), která nemá parametry ani návratovou hodnotu. Může uvolnit nespravovaný prostředek, zavolat Dispose() na vlastněném objektu nebo vrátit spravované pole do fondu polí. Neuvolňuje paměť samotného objektu ani nenahrazuje automatickou správu paměti (GC).

Příkaz using (...) { ... } zavolá Dispose() při opuštění bloku; deklarace using var resource = ...; při opuštění oblasti platnosti, ve které byla zapsána. Po úspěšném získání prostředku, který není null, kompilátor zajistí volání pomocí try/finally, a to i při return nebo výjimce uvnitř bloku. using výjimky nezachytává. Pro asynchronní uvolnění použijte await using s System.IAsyncDisposable.

Za uvolnění odpovídá vlastník, nikoli kód, který si prostředek pouze vypůjčil. V příkladu IBufferLease dědí z IDisposable a ResourceScope sám implementuje IDisposable, přebírá odpovědnost za výpůjčku a předává jí volání Dispose(). BufferLease vrátí pole právě jednou do téhož fondu a pozdější přístup odmítne výjimkou ObjectDisposedException. Opakovaná volání Dispose() nemají žádný účinek (idempotence); to nezaručuje bezpečnost při souběhu vláken.

Rent(1) zaručuje nejméně jeden prvek, ne však pole vyplněné nulami. Před čtením zapište hodnotu a po vrácení pole nepoužívejte žádný uložený odkaz na něj. clearArray: true vynuluje pole, pokud si je fond ponechá pro další použití; nezaručuje bezpečné vymazání dat.

Příklady

#nullable enable
using System;
using System.Buffers;

IBufferLease lease = new BufferLease();
IDisposable scope = new ResourceScope(lease);

using (scope)
{
    lease.Value = 42;
    Console.WriteLine(lease.Value);
}

scope.Dispose();

try
{
    _ = lease.Value;
}
catch (ObjectDisposedException)
{
    Console.WriteLine("Lease disposed.");
}

interface IBufferLease : IDisposable
{
    int Value { get; set; }
}

sealed class BufferLease : IBufferLease
{
    private readonly ArrayPool<int> _pool = ArrayPool<int>.Shared;
    private int[]? _buffer;

    public BufferLease() => _buffer = _pool.Rent(1);

    private int[] Buffer =>
        _buffer ?? throw new ObjectDisposedException(nameof(BufferLease));

    public int Value
    {
        get => Buffer[0];
        set => Buffer[0] = value;
    }

    public void Dispose()
    {
        int[]? buffer = _buffer;
        if (buffer is null)
            return;

        _buffer = null;
        _pool.Return(buffer, clearArray: true);
    }
}

sealed class ResourceScope : IDisposable
{
    private IBufferLease? _lease;

    public ResourceScope(IBufferLease lease) =>
        _lease = lease ?? throw new ArgumentNullException(nameof(lease));

    public void Dispose()
    {
        IBufferLease? lease = _lease;
        _lease = null;
        lease?.Dispose();
    }
}

Výsledek

42
Lease disposed.

V C# 12 a .NET 8 program vypíše `42` a potom `Lease disposed.`. Při opuštění `using` se pole vrátí do fondu; druhé volání `scope.Dispose()` nic neudělá. Zachycená výjimka `ObjectDisposedException` ukazuje, že výpůjčka odmítá pozdější čtení, nikoli že fond pole znovu použil.

Související lekce

  • C# · Lekce 31 · Pokročilá · Verze: 3
  • C# · Lekce 32 · Pokročilá · Verze: 3

Zdroje