autofac 组件的实例范围

实例范围决定如何在请求之间共享服务。

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

每个依赖一个实例

使用这个选项，每次请求服务都会返回一个新实例。使用 InstancePerDependency() 指定。这是默认选项。下面的代码，第2行和第3行是等价的。

var builder = new ContainerBuilder();
builder.RegisterType<Worker>();
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 方法创建的生命周期范围。