Autofac.AspNetCore.Multitenant 6.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 5.0 .NET Core 3.1
dotnet add package Autofac.AspNetCore.Multitenant --version 6.0.0
NuGet\Install-Package Autofac.AspNetCore.Multitenant -Version 6.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Autofac.AspNetCore.Multitenant" Version="6.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Autofac.AspNetCore.Multitenant --version 6.0.0
#r "nuget: Autofac.AspNetCore.Multitenant, 6.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Autofac.AspNetCore.Multitenant as a Cake Addin
#addin nuget:?package=Autofac.AspNetCore.Multitenant&version=6.0.0

// Install Autofac.AspNetCore.Multitenant as a Cake Tool
#tool nuget:?package=Autofac.AspNetCore.Multitenant&version=6.0.0

Autofac.AspNetCore.Multitenant

ASP.NET Core support for multitenant DI via Autofac.Multitenant.

Build status codecov

Please file issues and pull requests for this package in this repository rather than in the Autofac core repo.

Why Use This?

ASP.NET Core default RequestServicesContainerMiddleware is where the per-request lifetime scope usually gets generated. However, its constructor is where it wants the IServiceScopeFactory that will be used later during the request to create the request lifetime scope.

Unfortunately, that means the IServiceScopeFactory is created/resolved at the point when the request comes in, long before an HttpContext is set in any IHttpContextAccessor. The result is the scope factory ends up coming from the default tenant scope, before a tenant can be identified, and per-request services will later all come from the default tenant. Multitenancy fails.

This package provides a different request services middleware that ensures the IHttpContextAccessor.HttpContext is set and defers creation of the request lifetime scope until as late as possible so anything needed for tenant identification can be established.

Quick Start

When creating your application host, use the multitenant service provider factory. Your Startup will register common dependencies, but you'll need to provide a static method to initialize the tenant-specific overrides.

var host = Host.CreateDefaultBuilder(args)
    .UseServiceProviderFactory(new AutofacMultitenantServiceProviderFactory(MultitenantContainerSetup.ConfigureMultitenantContainer))
    .ConfigureWebHostDefaults(webHostBuilder => webHostBuilder.UseStartup<Startup>())
    .Build();

In your Startup class, make sure to use the multitenant request services middleware and register your common dependencies.

public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
    // Add the multitenant request services handler.
    services
      .AddAutofacMultitenantRequestServices()
      .AddControllers();
  }

  public void ConfigureContainer(ContainerBuilder builder)
  {
    // Register tenant-shared dependencies and defaults.
    builder.RegisterType<CommonDependency>()
      .As<IDependency>()
      .InstancePerLifetimeScope();
  }

  public void Configure(IApplicationBuilder app)
  {
      app.UseRouting();
      app.UseEndpoints(builder => builder.MapControllers());
  }
}

Provide a method to override things for tenant-specific dependencies. This is what gets passed to the multitenant service provider factory.

public static class MultitenantContainerSetup
{
  public static MultitenantContainer ConfigureMultitenantContainer(IContainer container)
  {
    // Define how you're going to identify tenants.
    var strategy = new QueryStringTenantIdentificationStrategy(
        container.Resolve<IHttpContextAccessor>(),
        container.Resolve<ILogger<QueryStringTenantIdentificationStrategy>>());

    // Create the multitenant container.
    var multitenantContainer = new MultitenantContainer(strategy, container);

    // Register tenant overrides.
    multitenantContainer.ConfigureTenant(
        "some-tenant",
        cb => cb
          .RegisterType<OverrideDependency>()
          .As<IDependency>()
          .WithProperty("Id", "some-tenant")
          .InstancePerLifetimeScope());

    // Return the built container for use in the app.
    return multitenantContainer;
  }
}

Reference

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp3.1
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Autofac.AspNetCore.Multitenant:

Package Downloads
Autofac.AspNetCore.Extensions

ASP.NET Core library with IWebHostBuilder Single Tenant and Multitenant Autofac Extensions

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.0.0 28,511 7/18/2022
5.1.0 123,817 11/15/2021
5.0.0 233,542 12/20/2020
4.0.1 22,183 10/6/2020
4.0.0 1,374 9/30/2020
3.0.2 37,368 8/5/2020
3.0.1 386,289 4/7/2020
3.0.0 43,591 1/28/2020
2.0.1 43,785 11/12/2019
2.0.0 18,486 9/24/2019
2.0.0-rc1 420 9/5/2019
1.1.0 64,545 4/16/2019
1.0.2 58,201 7/12/2018
1.0.1 4,462 6/1/2018
1.0.1-rc1 997 5/7/2018
1.0.0 10,894 8/18/2017