autofac 組件的實例範圍

實例範圍決定如何在請求之間共用服務。

原文地址：http://docs.autofac.org/en/latest/lifetime/instance-scope.html

每個依賴一個實例

使用這個選項，每次請求服務都會返回一個新實例。使用 InstancePerDependency() 指定。這是預設選項。下麵的代碼，第2行和第3行是等價的。

1 var builder = new ContainerBuilder();
2 builder.RegisterType<Worker>();
3 builder.RegisterType<Worker>().InstancePerDependency();

下麵的代碼，每次迴圈都生成一個新的實例，一共生成 100 個實例。

using(var scope = container.BeginLifetimeScope())
{
  for(var i = 0; i < 100; i++)
  {
    var w = scope.Resolve<Worker>();
    w.DoWork();
  }
}

單個實例

使用這個選項，在根範圍或嵌套範圍中請求服務，都返回同一個的實例。使用 SingleInstance() 指定。

var builder = new ContainerBuilder();
builder.RegisterType<Worker>().SingleInstance();

下麵的代碼，w1 和 w2 始終是同一個對象，100 次迴圈只有一個 Worker 類的實例。

using(var scope1 = container.BeginLifetimeScope())
{
  for(var i = 0; i < 100; i++)
  {
    var w1 = scope1.Resolve<Worker>();
    using(var scope2 = scope1.BeginLifetimeScope())
    {
      var w2 = scope2.Resolve<Worker>();
    }
  }
}

每個生命周期範圍一個實例

使用這個選項，在特定的 ILifetimeScope 中請求服務，只返回一個實例。使用 InstancePerLifetimeScope() 指定。下麵的代碼中，scope1 中的 100 次 w1 是同一個對象，scope2 中的 100 次 w2 是同一個對象，但是 w1 和 w2 不是同一個對象。

var builder = new ContainerBuilder();
builder.RegisterType<Worker>().InstancePerLifetimeScope();
using(var scope1 = container.BeginLifetimeScope())
{
  for(var i = 0; i < 100; i++)
  {
    var w1 = scope1.Resolve<Worker>();
  }
}

using(var scope2 = container.BeginLifetimeScope())
{
  for(var i = 0; i < 100; i++)
  {
    var w2 = scope2.Resolve<Worker>();
  }
}

每個匹配的生命周期範圍一個實例

類似於上面【每個生命周期範圍一個實例】，但可以提供更多控制。使用此選項，允許為 ILifetimeScope 對象提供“標記”。在標記匹配的範圍中只有一個實例。使用 InstancePerMatchingLifetimeScope() 方法指定。

var builder = new ContainerBuilder();
builder.RegisterType<Worker>().InstancePerMatchingLifetimeScope("x");

下麵的代碼中，w1 和 w2 相同，w3 和 w4 相同，但 w1 和 w3 不同。

using(var scope1 = container.BeginLifetimeScope("x"))
{
  for(var i = 0; i < 100; i++)
  {
    var w1 = scope1.Resolve<Worker>();
    using(var scope2 = scope1.BeginLifetimeScope())
    {
      var w2 = scope2.Resolve<Worker>();
    }
  }
}

using(var scope3 = container.BeginLifetimeScope("x"))
{
  for(var i = 0; i < 100; i++)
  {
    var w3 = scope3.Resolve<Worker>();
    using(var scope4 = scope1.BeginLifetimeScope())
    {
      var w4 = scope4.Resolve<Worker>();
    }
  }
}

解析時必須提供提供合適的標記，以下代碼會拋出異常。

using(var noTagScope = container.BeginLifetimeScope())
{
  var fail = noTagScope.Resolve<Worker>();
}

每個請求一個實例

有些應用程式天然具有【請求】語義，例如 ASP.NET MVC 或 WebForm 應用程式。【每個請求一個實例】在【每個匹配的生命周期範圍一個實例】基礎上，通過提供範圍標記，註冊函數和常見類型集成實現。本質上是【每個匹配的生命周期範圍一個實例】。

var builder = new ContainerBuilder();
builder.RegisterType<Worker>().InstancePerRequest();

ASP.NET Core 使用【每個生命周期範圍一個實例】，而不是【每個請求一個實例】。

每個 Owned 一個實例

 Owned<T> 隱式關聯類型創建嵌套的生命周期範圍。使用 instance-per-owned 註冊，可將依賴限定在 owned 實例中。

var builder = new ContainerBuilder();
builder.RegisterType<MessageHandler>();
builder.RegisterType<ServiceForHandler>().InstancePerOwned<MessageHandler>();

本例中 ServiceForHandler 服務會限制在 MessageHandler 實例範圍內。

using(var scope = container.BeginLifetimeScope())
{
  // MessageHandler 和附屬的 ServiceForHandler 
  // 在 scope 下麵的一個微型的 lifetime scope 中。
  // 解析 Owned<T> 需要程式員負責執行清理工作。
  var h1 = scope.Resolve<Owned<MessageHandler>>();
  h1.Dispose();
}

線程範圍

Autofac 可以強制使A線程的對象不滿足B線程的依賴。

var builder = new ContainerBuilder();
builder.RegisterType<MyThreadScopedComponent>()
       .InstancePerLifetimeScope();
var container = builder.Build();

然後讓每個創建自己的 lifetime scope

void ThreadStart()
{
  using (var threadLifetime = container.BeginLifetimeScope())
  {
    var thisThreadsInstance = threadLifetime.Resolve<MyThreadScopedComponent>();
  }
}

重要：在多線程場景下，要小心不要將父範圍清理掉。否則，派生線程中的子範圍將無法解析服務。

每個線程都將有自己的 MyThreadScopedComponent 實例，本質上是生命周期範圍內的單例。範圍內的實例不會提供到外部，因此很容易保持線程間的組件隔離。

通過添加 ILifetimeScope 參數，可將父範圍註入到生成線程的代碼中，Autofac 會將當前範圍自動註入，接下來可以使用它創建嵌套範圍。

public class ThreadCreator
{
  private ILifetimeScope _parentScope;

  public ThreadCreator(ILifetimeScope parentScope)
  {
    this._parentScope = parentScope;
  }

  public void ThreadStart()
  {
    using (var threadLifetime = this._parentScope.BeginLifetimeScope())
    {
      var thisThreadsInstance = threadLifetime.Resolve<MyThreadScopedComponent>();
    }
  }
}

如果想進一步控制，可以使用【每個匹配的生命周期範圍一個實例】將線程範圍的組件同內部生命周期範圍關聯起來，這個方式的效果如圖：

圖中的"Context"是 BeginLifetimeScope 方法創建的生命周期範圍。