JNPF 租户管理

租户管理一、核心功能租户管理是 JNPF 框架提供的多租户支持系统允许在同一应用实例中运行多个独立的租户每个租户拥有独立的数据和配置。1.1 核心价值多租户架构支持同一应用实例运行多个租户数据隔离支持列级隔离和数据库级隔离两种模式租户配置支持租户级别的配置管理租户切换支持运行时动态切换租户可扩展性支持自定义租户解析和租户存储二、多租户模式2.1 列级隔离COLUMN所有租户共享同一个数据库通过f_tenant_id列区分不同租户的数据-- 查询指定租户的数据SELECT*FROMuserWHEREf_tenant_idtenant-001;适用场景租户数量较多数百到数千数据量适中数据库资源有限2.2 数据库级隔离SCHEMA每个租户拥有独立的数据库或数据库架构-- 使用指定租户的数据库USEtenant_001;SELECT*FROMuser;适用场景租户数量较少数十个以内数据量较大需要更高的数据隔离级别2.3 配置模式在Tenant.json中配置多租户模式{Tenant:{MultiTenancy:true,MultiTenancyType:COLUMN,MultiTenancyDBInterFace:https://tenant.xxx.cn/api/Tenant/DbName/,MultiSystem:true}}三、实现原理3.1 租户解析框架通过多种方式解析当前租户方式说明优先级请求头通过jnpf-tenant-id请求头传递租户 ID高URL 参数通过tenantIdURL 参数传递租户 ID中Cookie通过 Cookie 传递租户 ID低默认租户使用配置的默认租户 ID默认3.2 租户过滤器框架自动为查询添加租户过滤器// SqlSugar 查询过滤器db.QueryFilter.Add(newTableFilterItemBaseUserEntity(itit.TenantIdcurrentTenantId));四、使用示例4.1 租户配置在Tenant.json中配置多租户{Tenant:{MultiTenancy:true,MultiTenancyType:COLUMN,MultiTenancyDBInterFace:https://tenant.xxx.cn/api/Tenant/DbName/,MultiSystem:true}}4.2 获取当前租户publicclassUserService{publicvoidProcess(){varcurrentTenantIdApp.GetTenantId();// 使用当前租户ID查询数据}}4.3 切换租户publicclassTenantService{publicvoidSwitchTenant(stringtenantId){App.SetTenantId(tenantId);// 后续操作将使用新的租户ID}}4.4 租户数据查询框架自动为查询添加租户过滤器publicclassUserService{privatereadonlyISqlSugarClient_db;publicUserService(ISqlSugarClientdb){_dbdb;}publicasyncTaskListUserInfoGetUserList(){// 框架自动添加租户过滤器returnawait_db.QueryableUserInfo().Where(uu.DeleteMark!1).ToListAsync();}}4.5 跨租户查询使用IgnoreQueryFilter忽略租户过滤器publicclassAdminService{privatereadonlyISqlSugarClient_db;publicAdminService(ISqlSugarClientdb){_dbdb;}publicasyncTaskListUserInfoGetAllUsers(){// 忽略租户过滤器查询所有租户的数据returnawait_db.QueryableUserInfo().IgnoreQueryFilter().Where(uu.DeleteMark!1).ToListAsync();}}五、配置选项5.1 租户配置配置项默认值说明MultiTenancyfalse是否启用多租户MultiTenancyTypeCOLUMN多租户类型COLUMN/SCHEMAMultiTenancyDBInterFacenull租户数据库接口地址MultiSystemfalse是否启用多系统DefaultTenantIdnull默认租户 ID5.2 租户数据库接口当使用 SCHEMA 模式时框架通过租户数据库接口获取租户的数据库连接信息{Tenant:{MultiTenancyDBInterFace:https://tenant.xxx.cn/api/Tenant/DbName/}}接口返回格式{code:200,data:{dbName:tenant_001,connectionString:Serverlocalhost;Databasetenant_001;Trusted_ConnectionTrue;}}六、高级特性6.1 租户初始化为新租户初始化数据publicclassTenantService{publicasyncTaskCreateTenant(TenantInputinput){// 创建租户记录vartenantnewTenantEntity{Idinput.Id,Nameinput.Name,CreateTimeDateTime.Now};await_db.Insertable(tenant).ExecuteCommandAsync();// 初始化租户数据awaitInitializeTenantData(input.Id);}privateasyncTaskInitializeTenantData(stringtenantId){// 设置当前租户varoriginalTenantIdApp.GetTenantId();App.SetTenantId(tenantId);try{// 初始化基础数据awaitInitializeRoles(tenantId);awaitInitializeUsers(tenantId);awaitInitializeMenus(tenantId);}finally{// 恢复原租户App.SetTenantId(originalTenantId);}}}6.2 租户缓存实现租户级别的缓存publicclassTenantCacheService{privatereadonlyICache_cache;publicTenantCacheService(ICachecache){_cachecache;}publicTGetTenantCacheT(stringkey){vartenantIdApp.GetTenantId();varcacheKey$Tenant:{tenantId}:{key};return_cache.GetT(cacheKey);}publicvoidSetTenantCacheT(stringkey,Tvalue,intexpireSeconds3600){vartenantIdApp.GetTenantId();varcacheKey$Tenant:{tenantId}:{key};_cache.Set(cacheKey,value,expireSeconds);}}6.3 租户配置支持租户级别的配置管理publicclassTenantConfigService{publicTGetTenantConfigT(stringconfigKey){vartenantIdApp.GetTenantId();// 从数据库查询租户配置varconfig_db.QueryableTenantConfigEntity().Where(cc.TenantIdtenantIdc.ConfigKeyconfigKey).First();returnJsonConvert.DeserializeObjectT(config.ConfigValue);}}6.4 租户统计统计租户的数据publicclassTenantStatisticsService{publicasyncTaskTenantStatisticsGetTenantStatistics(stringtenantId){varoriginalTenantIdApp.GetTenantId();App.SetTenantId(tenantId);try{varuserCountawait_db.QueryableUserInfo().CountAsync();varorderCountawait_db.QueryableOrderInfo().CountAsync();returnnewTenantStatistics{TenantIdtenantId,UserCountuserCount,OrderCountorderCount,StatisticTimeDateTime.Now};}finally{App.SetTenantId(originalTenantId);}}}6.5 租户备份与恢复支持租户数据的备份与恢复publicclassTenantBackupService{publicasyncTaskstringBackupTenant(stringtenantId){varoriginalTenantIdApp.GetTenantId();App.SetTenantId(tenantId);try{// 导出租户数据varbackupDataawaitExportTenantData(tenantId);// 保存备份文件varbackupPathPath.Combine(backups,${tenantId}_{DateTime.Now:yyyyMMddHHmmss}.json);awaitFile.WriteAllTextAsync(backupPath,backupData);returnbackupPath;}finally{App.SetTenantId(originalTenantId);}}publicasyncTaskRestoreTenant(stringtenantId,stringbackupPath){varbackupDataawaitFile.ReadAllTextAsync(backupPath);awaitImportTenantData(tenantId,backupData);}}6.6 多系统支持框架支持多系统和多租户的组合{Tenant:{MultiTenancy:true,MultiSystem:true}}七、总结租户管理通过多租户架构和数据隔离机制实现了灵活的多租户支持。核心设计思想多租户模式支持列级隔离和数据库级隔离两种模式自动租户过滤框架自动为查询添加租户过滤器无需手动处理租户解析支持多种租户解析方式灵活适配不同场景租户配置支持租户级别的配置管理多系统支持支持多系统和多租户的组合这种设计使得应用可以同时服务多个独立的租户每个租户拥有独立的数据和配置提高了应用的可扩展性和运营效率。