ASP.NET Core 釋放 IDisposable 對象的四種方法

本文翻譯自《Four ways to dispose IDisposables in ASP.NET Core》，由於水平有限，故無法保證翻譯完全正確，歡迎指出錯誤。謝謝！

IDisposable 接口是.NET中最常用的接口之一。當類型包含非托管資源的引用，比如窗口句柄、文件或網絡通信，可以實現IDisposable接口。垃圾收集器自動釋放托管（即.NET）對象的內存，但不知道如何處理非托管資源。通過實現IDisposable接口，您可以在類被釋放時正確地清理這些資源。

這篇文章介紹了在ASP.NET Core應用程序中可以用於處理釋放資源的一些方法，特別是在使用內置的依賴注入容器時。

為了達到這篇文章的目的，我在示例中使用下面實現了IDisposable接口的類。為了達到我們演示的目的，只需要將日志輸出到控制台，而不需要做任何實際的清理工作。

public class MyDisposable : IDisposable  
{
    public MyDisposable()
    {
        Console.WriteLine("+ {0} was created", this.GetType().Name);
    }

    public void Dispose()
    {
        Console.WriteLine("- {0} was disposed!", this.GetType().Name);
    }
}

現在來看看我們的方案。

最簡單的方法 - using語法

在代碼中使用using語句塊釋放一個IDisposable對象是一種最普通的方法：

using(var myObject = new MyDisposable())  
{
    // myObject.DoSomething();
}

使用using語句塊的方式，無論是否拋出異常，都能確保Dispose方法可以正常的執行。如果需要，您也可以使用try- finally語句塊的方式：

MyDisposable myObject = null;  
try  
{
    myObject = new MyDisposable();
    // myObject.DoSomething();
}
finally  
{
    myObject?.Dispose();
}

您會發現通常在使用文件或流(在短暫的某一范圍內)等會用此模式。不幸的是，有時不一定符合這種情況，您可能需要在其它的地方釋放該對象。根據您的真實情況，還可以使用一些其它的方式。

注意： 只要有可能，最好的做法就是將它們在創建的使用范圍內釋放。這將有助於防止應用程序中的內存泄漏和意外的文件鎖，或者對象意外地未釋放。

## 在請求結束時釋放 - 使用`RegisterForDispose`

當您在ASP.NET Core或任何Web應用程序工作時，將對象的使用范圍限定為單個請求是非常常見的。也就是說，任何您在請求時創建的對像，在請求完成時釋放該對象。

有很多方法可以做到這一點。最常見的方法是在利用依賴容器（我馬上就會講到），但有時候不可能，因為您可能需要在代碼中手動創建IDisposable對象。

如果您手動創建一個IDisposable實例，則可以將該實例注冊到HttpContext中，以便在請求結束時，該實例被自動釋放。只需將實例傳遞給HttpContext.Response.RegisterForDispose方法：

public class HomeController : Controller  
{
    readonly Disposable _disposable;

    public HomeController()
    {
        _disposable = new RegisteredForDispose();
    }

    public IActionResult Index()
    {
        // register the instance so that it is disposed when request ends
        HttpContext.Response.RegisterForDispose(_disposable);
        Console.Writeline("Running index...");
        return View();
    }
}

在這個例子中，我在HomeController的構造函數中創建Disposable對象，然后在action方法中注冊它。這種設計有點做作，但至少展示了這種機制。

如果執行此action方法，您將看到以下內容：

$ dotnet run
Hosting environment: Development  
Content root path: C:\Users\Sock\Repos\RegisterForDispose  
Now listening on: http://localhost:5000  
Application started. Press Ctrl+C to shut down.  
+ MyDisposable was created
Running index...  
- MyDisposable was disposed!

HttpContext負責為我們釋放我們創建的對象！

警告： 我在action方法中注冊實例，而不是構造方法，是因為在構造函數中HttpContext為null！

在您的代碼中，RegisterForDispose對處理創建的服務很有用。但是鑒於Dispose模式僅適用於使用非托管資源的類，您可能會發現，通常情況下，您的IDisposable類被封裝在使用依賴容器注冊的服務中。

正如 Mark Rendle 指出的那樣，Controller 本身也將在請求結束時釋放，因此您可以使用該機制來處理您創建的任何對象。

## 自動釋放服務 - 利用內置依賴容器

ASP.NET Core附帶一個簡單的內置依賴容器，您可以使用“Transient”，“Scoped”或“Singleton”注冊您的服務。你可以在這里了解更多，所以我假設您已經知道如何使用它來注冊您的服務。

請注意，本文僅討論內置容器 - 第三方容器可能有其它關於自動處理服務的規則。

內置容器可以填充任何服務創建的依賴項，它將實現了IDisposable接口的對象，將在適當的時候由容器釋放。因此Transient，Scoped實例將在請求結束時（或更准確地說，在范圍結束時），Singleton實例在應用程序被關閉釋放，並且ServiceProvider自身也會被釋放。

這意味着只要您不提供具體的實例，提供者將釋放您注冊的任何服務。例如，我將創建一些可釋放類：

public class TransientCreatedByContainer: MyDisposable { }  
public class ScopedCreatedByFactory : MyDisposable { }  
public class SingletonCreatedByContainer: MyDisposable {}  
public class SingletonAddedManually: MyDisposable {}  

在Startup.ConfigureServices方法以不同的方式注冊它們。我將這樣注冊：

• TransientCreatedByContainer - transient
• ScopedCreatedByFactory - scoped，使用lambda函數作為工廠
• SingletonCreatedByContainer - singleton
• SingletonAddedManually - singleton，傳遞具體的實例對象

public void ConfigureServices(IServiceCollection services)  
{
    // other services

    // these will be disposed
    services.AddTransient<TransientCreatedByContainer>();
    services.AddScoped(ctx => new ScopedCreatedByFactory());
    services.AddSingleton<SingletonCreatedByContainer>();

    // this one won't be disposed
    services.AddSingleton(new SingletonAddedManually());
}

最后，我將在HomeController中依次傳每個實例，因此依賴容器將根據需要創建/注入實例：

public class HomeController : Controller  
{
    public HomeController(
        TransientCreatedByContainer transient,
        ScopedCreatedByFactory scoped,
        SingletonCreatedByContainer createdByContainer,
        SingletonAddedManually manually)
    { }

    public IActionResult Index()
    {
        return View();
    }
}

當我運行應用程序，點擊主頁，然后停止應用程序，我將得到以下輸出：

$ dotnet run
+ SingletonAddedManually was created
Content root path: C:\Users\Sock\Repos\RegisterForDispose  
Now listening on: http://localhost:5000  
Application started. Press Ctrl+C to shut down.  
+ TransientCreatedByContainer was created
+ ScopedCreatedByFactory was created
+ SingletonCreatedByContainer was created
- TransientCreatedByContainer was disposed!
- ScopedCreatedByFactory was disposed!
Application is shutting down...  
- SingletonCreatedByContainer was disposed!

這里有幾件事要注意：

• SingletonAddedManually 是在Web主機完成設置之前創建的，因此，在日志開始之前，它將寫入控制台
• SingletonCreatedByContainer 在我們關閉服務之后被釋放
• SingletonAddedManually 從來沒有釋放，因為我們提供了一個具體的實例！

請注意，由依賴容器創建的對象被釋放的行為只適用於ASP.NET Core 1.1及更高版本。在ASP.NET Core 1.0中，所有*容器注冊的對象都會被釋放。*

讓容器幫您處理IDisposable對象顯然很方便，特別是您可能已經在注冊您的服務！這里唯一的需要注意的是您需要釋放您自己創建的對象。正如我剛才所說，如果可能，您應該盡量使用using語法，但這並不總是可能的。幸運的是，ASP.NET Core 應用程序的生命周期提供了機制，所以在應用程序關閉時可以進行一些清理。

## 應用程序結束時釋放 - 利用 `IApplicationLifetime` 事件

ASP.NET Core公開了一個稱為 IApplicationLifetime 的接口，可用於在應用程序啟動或關閉時執行代碼：

public interface IApplicationLifetime  
{
    CancellationToken ApplicationStarted { get; }
    CancellationToken ApplicationStopping { get; }
    CancellationToken ApplicationStopped { get; }
    void StopApplication();
}

您可以將其注入您的Startup 類（或其它類），並注冊您需要的事件。擴展前面的例子，我們在 Startup.cs 的Configure方法中注入 IApplicationLifetime和SingletonAddedManually實例的單例:

public void Configure(  
    IApplicationBuilder app, 
    IApplicationLifetime applicationLifetime,
    SingletonAddedManually toDispose)
{
    applicationLifetime.ApplicationStopping.Register(OnShutdown, toDispose);

    // configure middleware etc
}

private void OnShutdown(object toDispose)  
{
    ((IDisposable)toDispose).Dispose();
}

我創建了一個簡單的幫助方法，傳入SingletonAddedManually的實例，將其轉換為IDisposable並將其釋放。該幫助方法被注冊到類型是CancellationToken的ApplicationStopping屬性中，當關閉應用程序時，該方法被觸發。

如果我們再次運行應用程序，通過此額外的注冊，您可以看到該SingletonAddedManually實例現在已被釋放，就在應用程序關閉之后觸發。

$ dotnet run
+ SingletonAddedManually was created
Content root path: C:\Users\Sock\Repos\RegisterForDispose  
Now listening on: http://localhost:5000  
Application started. Press Ctrl+C to shut down.  
+ TransientCreatedByContainer was created
+ ScopedCreatedByFactory was created
+ SingletonCreatedByContainer was created
- TransientCreatedByContainer was disposed!
- ScopedCreatedByFactory was disposed!
Application is shutting down...  
- SingletonAddedManually was disposed!
- SingletonCreatedByContainer was disposed!

## 概要

您有四種不同的方法來處理您的IDisposable對象。只要有可能，您應該使用using語法，或者讓依賴容器為您釋放對象。對於不可能的情況，ASP.NET Core提供了兩種可以掛接的機制：RegisterForDispose和IApplicationLifetime。

轉載請注明出處，原文鏈接：http://www.cnblogs.com/tdfblog/p/four-ways-to-dispose-idisposables-in-asp-net-core.html。