ABP框架中基于路由的多租户解析方案详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00473/article/details/148392218

ABP框架中基于路由的多租户解析方案详解

abp Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation. 项目地址: https://gitcode.com/gh_mirrors/abp1/abp

前言

在现代SaaS应用开发中，多租户架构已成为标配功能。ABP框架作为.NET领域优秀的应用开发框架，提供了完善的多租户支持体系。本文将深入探讨ABP框架中基于路由的租户解析方案，帮助开发者构建灵活的多租户Web应用。

多租户解析基础

ABP框架内置了多种租户解析方式，包括但不限于：

Cookie解析
HTTP头解析
域名解析
路由解析

其中，路由解析(RouteTenantResolveContributor)是最为直观和SEO友好的方式之一，它允许通过URL路径直接标识租户。

路由租户解析实现原理

基本路由配置

在控制器或页面中，我们可以通过{__tenant}路由参数来标识租户：

// 控制器路由示例
[Route("{__tenant}/products")]
public class ProductController : AbpControllerBase
{
    public IActionResult Index()
    {
        return View();
    }
}

<!-- Razor页面路由示例 -->
@page "{__tenant}/products"

当访问/acme/products时，ABP会自动从路由中提取acme作为当前租户标识。

全局路由配置

为简化开发，我们可以实现全局路由配置，自动为所有控制器和页面添加租户路由前缀：

// 页面路由约定
public class AddTenantRouteToPages : IPageRouteModelConvention
{
    public void Apply(PageRouteModel model)
    {
        // 实现逻辑：为所有页面添加{__tenant}路由前缀
    }
}

// 控制器路由约定
public class AddTenantRouteToControllers : IApplicationModelConvention
{
    public void Apply(ApplicationModel application)
    {
        // 实现逻辑：为所有控制器添加{__tenant}路由前缀
    }
}

注册路由约定：

services.Configure<RazorPagesOptions>(options => 
{
    options.Conventions.Add(new AddTenantRouteToPages());
});

services.Configure<MvcOptions>(options => 
{
    options.Conventions.Add(new AddTenantRouteToControllers());
});

关键实现细节

路由正则约束：{__tenant:regex(^[a-zA-Z0-9]+$)}确保租户标识符只包含字母和数字
路径前缀处理：通过RemovePreFix("/")确保路由模板拼接正确
Cookie路径配置：设置x.Cookie.Path = "/"避免跨租户认证问题

高级路由处理

动态PathBase处理

为确保导航链接正确包含租户信息，我们需要中间件动态调整请求路径：

app.Use(async (httpContext, next) =>
{
    // 提取租户名称
    var tenantMatch = Regex.Match(httpContext.Request.Path, "^/([^/.]+)(?:/.*)?$");
    
    if (tenantMatch.Success)
    {
        var tenantName = tenantMatch.Groups[1].Value;
        // 验证租户存在性
        var tenantStore = httpContext.RequestServices.GetRequiredService<ITenantStore>();
        var tenantInfo = await tenantStore.FindAsync(tenantName);
        
        if (tenantInfo != null)
        {
            // 调整Path和PathBase
            var originalPath = httpContext.Request.Path;
            var originalPathBase = httpContext.Request.PathBase;
            
            httpContext.Request.PathBase = originalPathBase.Add($"/{tenantName}");
            httpContext.Request.Path = originalPath.Value.Substring(tenantName.Length + 1);
            
            try { await next(httpContext); }
            finally
            {
                // 恢复原始路径
                httpContext.Request.Path = originalPath;
                httpContext.Request.PathBase = originalPathBase;
            }
            return;
        }
    }
    
    await next(httpContext);
});

自定义租户解析器

扩展默认的路由解析器，支持从PathBase提取租户信息：

public class EnhancedRouteTenantResolver : RouteTenantResolveContributor
{
    public override async Task ResolveAsync(ITenantResolveContext context)
    {
        var httpContext = context.GetHttpContext();
        var options = context.GetAbpAspNetCoreMultiTenancyOptions();
        
        // 尝试从路由值获取
        var tenantId = httpContext.GetRouteValue(options.TenantKey)?.ToString();
        
        // 从PathBase回退获取
        if(string.IsNullOrEmpty(tenantId))
        {
            tenantId = httpContext.Request.PathBase.ToString().Trim('/');
        }
        
        if(!string.IsNullOrEmpty(tenantId))
        {
            context.TenantIdOrName = tenantId;
        }
    }
}

注册自定义解析器：

Configure<AbpTenantResolveOptions>(options =>
{
    options.TenantResolvers.Insert(0, new EnhancedRouteTenantResolver());
});

前端资源路径处理

为确保前端资源路径正确，需要调整基础路径：

services.Configure<AbpThemingOptions>(options =>
{
    var currentTenant = services.BuildServiceProvider()
        .GetRequiredService<ICurrentTenant>();
    
    if(!string.IsNullOrEmpty(currentTenant.Name))
    {
        options.BaseUrl = $"/{currentTenant.Name}/";
    }
});

这确保了以下前端行为：