.net core 动态路由与多租户支持

在构建现代化的 Web 应用程序时，动态路由和多租户支持一直是两个非常常见的需求。ASP.NET Core 提供了灵活的中间件和路由功能，使开发者能够实现丰富的动态路由解决方案，并支持基于多租户的架构。

以下是如何在 .NET Core 中实现动态路由和多租户支持的指导和示例。

---

动态路由

动态路由使应用程序可以在运行时根据条件动态决定路径，而不是在启动时固定定义所有路由。

使用 Route 和 IRouter

ASP.NET Core 支持动态路由的能力，可以通过实现自定义 IRouter 或使用 EndpointMiddleware 动态注册来实现。例如：

C#

public class DynamicRouter : IRouter
{
    public async Task RouteAsync(RouteContext context)
    {
        var requestPath = context.HttpContext.Request.Path.Value;

        // 根据请求路径动态判断
        if (requestPath.Equals("/custom-route", StringComparison.OrdinalIgnoreCase))
        {
            context.Handler = async ctx =>
            {
                await ctx.Response.WriteAsync("This is a dynamically routed response!");
            };
        }
    }

    public VirtualPathData GetVirtualPath(VirtualPathContext context)
    {
        // 如果需要生成链接，可在此实现逻辑
        return null;
    }
}

然后将 DynamicRouter 添加到路由中间件：

C#

app.UseRouter(new DynamicRouter());

使用 Endpoint Routing 动态注册

Endpoint Routing 是推荐的高层次路由方式。我们可以动态注册端点来实现动态路由。例如：

C#

app.UseEndpoints(endpoints =>
{
    endpoints.MapGet("/default-route", async context =>
    {
        await context.Response.WriteAsync("This is the default endpoint!");
    });

    // 动态添加新路由
    endpoints.MapGet($"/dynamic-route/{Guid.NewGuid()}", async context =>
    {
        await context.Response.WriteAsync("This is a dynamically added route!");
    });
});

---

多租户支持

多租户应用能够基于租户（Tenant）的上下文动态加载不同的配置、数据库或逻辑。ASP.NET Core 提供了灵活的中间件管道，可以很好地支持多租户模式。

常见的多租户实现模式

1. 基于域/子域的多租户

   • 例如：tenant1.example.com、tenant2.example.com

2. 基于路径的多租户

   • 例如：example.com/tenant1、example.com/tenant2

3. 基于查询字符串的多租户

   • 例如：example.com/?tenant=tenant1

实现步骤

1. 创建 Tenant 模型

定义一个租户模型，用于表示租户信息：

C#

public class Tenant
{
    public string Id { get; set; }
    public string Name { get; set; }
    public string ConnectionString { get; set; }
}

2. 创建 TenantResolver

实现一个服务，用于解析租户信息（可以基于路径、子域、查询参数等方式）：

C#

public interface ITenantResolver
{
    Tenant Resolve(HttpContext context);
}

public class PathTenantResolver : ITenantResolver
{
    public Tenant Resolve(HttpContext context)
    {
        // 基于请求路径解析租户信息
        var path = context.Request.Path.Value.Split('/');
        if (path.Length > 1)
        {
            var tenantId = path[1];
            // 这里可以从数据库或配置中获取租户信息
            return new Tenant
            {
                Id = tenantId,
                Name = $"Tenant {tenantId}",
                ConnectionString = $"Database_Connection_For_{tenantId}"
            };
        }

        return null; // 根据需求选择返回默认租户或抛异常
    }
}

3. 注册多租户中间件

创建一个中间件，用于将解析的租户注入到请求上下文中：

C#

public class MultiTenantMiddleware
{
    private readonly RequestDelegate _next;

    public MultiTenantMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context, ITenantResolver tenantResolver)
    {
        var tenant = tenantResolver.Resolve(context);
        if (tenant != null)
        {
            context.Items["Tenant"] = tenant;
        }

        await _next(context);
    }
}

注册中间件和服务：

C#

services.AddSingleton<ITenantResolver, PathTenantResolver>();

app.UseMiddleware<MultiTenantMiddleware>();

4. 使用租户信息

在 Controller 或其他服务中访问租户信息：

C#

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var tenant = HttpContext.Items["Tenant"] as Tenant;
        if (tenant != null)
        {
            return Content($"Welcome to {tenant.Name}!");
        }
        return Content("No tenant found.");
    }
}

---

路由与多租户的结合

动态路由与多租户可以结合使用。例如，为不同租户提供不同的路由或功能：

C#

app.UseEndpoints(endpoints =>
{
    endpoints.MapDynamicControllerRoute<CustomRouter>("{tenant}/Home/{action}");
});

自定义一个动态路由解析器，基于租户信息动态加载控制器或操作。

C#

public class CustomRouter : DynamicRouteValueTransformer
{
    public override ValueTask<RouteValueDictionary> TransformAsync(HttpContext httpContext, RouteValueDictionary values)
    {
        var tenant = httpContext.Items["Tenant"] as Tenant;
        if (tenant != null)
        {
            // 定义租户的动态路由逻辑
            values["controller"] = "Home";
            values["action"] = "Index";
        }

        return new ValueTask<RouteValueDictionary>(values);
    }
}