Finbuckle.MultiTenant 9.0.0

About Finbuckle.MultiTenant

Finbuckle.MultiTenant is an open-source multitenancy middleware library for .NET. It enables tenant resolution, per-tenant app behavior, and per-tenant data isolation. See https://www.finbuckle.com/multitenant for more details and documentation.

This release supports .NET 8 and .NET 9.

Current publish feed release:

Table of Contents

1. What's New in v9.0.0
2. Quick Start
3. Documentation
4. Sample Projects
5. Build and Test Status
6. License
7. .NET Foundation
8. Code of Conduct
9. Community
10. Building from Source
11. Running Unit Tests

What's New in v9.0.0

This section only lists release update details specific to v9.0.0. See the changelog file for all release update details.

9.0.0 (2024-11-13)

Features

• add multitenant db factory method (#894) ( ea216ff)
• better tenant resolution events (#897) (956ca36)
• dotnet 9 support (#893) (4be1b88)
• make builds deterministic and set latest GH actions (#889) (d82f89d)

BREAKING CHANGES

• OnTenantResolved and OnTenantNotResolved are no longer used. Use the OnStrategyResolveCompleted, OnStoreResolveCompleted, and OnTenantResolveCompleted events instead.
• MultiTenantDbContext constructors accepting ITenantInfo removed, use MultiTenantDbContext.Create factory method* MultiTenantDbContext constructors accepting ITenantInfo removed, use MultiTenantDbContext.Create factory method instead.
• net6.0 and net7.0 are no longer supported targets.
• dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs.

Quick Start

Finbuckle.MultiTenant is designed to be easy to use and follows standard .NET conventions as much as possible. This introduction assumes a standard ASP.NET Core use case, but any application using .NET dependency injection can work with the library.

Installation

First, install the Finbuckle.MultiTenant.AspNetCore NuGet package:

.NET Core CLI

$ dotnet add package Finbuckle.MultiTenant.AspNetCore

Basic Configuration

Next, in the app's service configuration call AddMultiTenant<TTenantInfo> and its various builder methods and in the middleware configuration call UseMultiTenant():

builder.Services.AddMultiTenant<TenantInfo>()
    .WithHostStrategy()
    .WithConfigurationStore();

// other app code...

app.UseMultiTenant();

// other app code...

app.Run();

That's all that is needed to get going. Let's breakdown each line:

builder.Services.AddMultiTenant<TenantInfo>()

This line registers the base services and designates TenantInfo as the class that will hold tenant information at runtime.

The type parameter for AddMultiTenant<TTenantInfo> must be an implementation of ITenantInfo which holds basic information about the tenant such as its name and an identifier. TenantInfo is provided as a basic implementation, but a custom implementation can be used if more properties are needed.

See Core Concepts for more information on ITenantInfo.

.WithHostStrategy()

The line tells the app that our "strategy" to determine the request tenant will be to look at the request host, which defaults to the extracting the subdomain as a tenant identifier.

See MultiTenant Strategies for more information.

.WithConfigurationStore()

This line tells the app that information for all tenants are in the appsettings.json file used for app configuration. If a tenant in the store has the identifier found by the strategy, the tenant will be successfully resolved for the current request.

See MultiTenant Stores for more information.

Finbuckle.MultiTenant comes with a collection of strategies and store types that can be mixed and matched in various ways.

app.UseMultiTenant()

This line configures the middleware which resolves the tenant using the registered strategies, stores, and other settings. Be sure to call it before other middleware which will use per-tenant functionality, e.g. UseAuthentication().

Basic Usage

With the services and middleware configured, access information for the current tenant from the TenantInfo property on the MultiTenantContext<T> object accessed from the GetMultiTenantContext<T> extension method:

var tenantInfo = HttpContext.GetMultiTenantContext<TenantInfo>().TenantInfo;

if(tenantInfo != null)
{
    var tenantId = tenantInfo.Id;
    var identifier = tenantInfo.Identifier;
    var name = tenantInfo.Name;
}

The type of the TenantInfo property depends on the type passed when calling AddMultiTenant<T> during configuration. If the current tenant could not be determined then TenantInfo will be null.

The ITenantInfo instance and/or the typed instance are also available directly through dependency injection.

See Configuration and Usage for more information.

Documentation

The library builds on this basic functionality to provide a variety of higher level features. See the documentation for more details:

• Per-tenant Options
• Per-tenant Authentication
• Entity Framework Core Data Isolation
• ASP.NET Core Identity Data Isolation

Sample Projects

A variety of sample projects are available in the repository. Check older tagged release commits for samples from prior .NET versions.

Build and Test Status

License

This project uses the Apache 2.0 license. See LICENSE file for license information.

.NET Foundation

This project is supported by the .NET Foundation.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct or the CONTRIBUTING.md file.

Community

Check out the GitHub repository to ask a question, make a request, or peruse the code!

Building from Source

From the command line clone the git repository, cd into the new directory, and compile with dotnet build.

$ git clone https://github.com/Finbuckle/Finbuckle.MultiTenant.git
$ cd Finbuckle.MultiTenant
Cloning into 'Finbuckle.MultiTenant'...
<output omitted>
$ cd Finbuckle.MultiTenant
$ dotnet build

Running Unit Tests

Run the unit tests from the command line with dotnet test from the solution directory.

$ dotnet test