Skip to content

组织租户模块 ​

组织模块(org)是 MengStack 多租户体系的基础,管理租户(Tenant)的完整生命周期。每个租户拥有独立的 UUID 标识、名称、Slug 和配置数据。

架构概览 ​

modules/org/
├── domain/          # Tenant 实体、DTO、Repository 接口
├── application/     # Service(租户 CRUD、Slug 冲突检测)
├── infrastructure/  # GORM TenantRepository 实现、AutoMigrate
└── interfaces/      # HTTP Handler、路由注册

数据模型 ​

Tenant 实体 ​

字段类型说明
IDstring (UUID)主键,数据库自动生成 gen_random_uuid()
Namestring(128)租户名称
Slugstring(64)URL 友好标识,全局唯一
Statusint状态,默认 1(启用)
Settingstext租户私有配置(JSON),不通过 API 暴露
CreatedAttime.Time创建时间
UpdatedAttime.Time更新时间

数据库表: tenants

索引:

  • 主键:ID(UUID)
  • 唯一索引:Slug

API 接口 ​

所有接口需认证 + 多租户中间件。

方法路径权限说明
POST/api/v1/org/tenantsorg.tenant.write创建租户
GET/api/v1/org/tenantsorg.tenant.read租户列表
GET/api/v1/org/tenants/:idorg.tenant.read租户详情
PUT/api/v1/org/tenants/:idorg.tenant.write更新租户
DELETE/api/v1/org/tenants/:idorg.tenant.write删除租户

请求/响应示例 ​

创建租户 ​

json
// POST /api/v1/org/tenants
// Request
{
  "name": "示例公司",
  "slug": "demo-company"
}

// Response 200
{
  "id": "a1b2c3d4-...",
  "name": "示例公司",
  "slug": "demo-company",
  "status": 1,
  "created_at": "2026-10-01T10:00:00Z",
  "updated_at": "2026-10-01T10:00:00Z"
}

更新租户 ​

json
// PUT /api/v1/org/tenants/a1b2c3d4-...
// Request
{
  "name": "新名称",
  "slug": "new-slug",
  "status": 1
}

业务规则 ​

  • Slug 唯一性: 创建和更新时均检查 Slug 唯一性,冲突返回 409 Conflict
  • Settings 字段: 存储在数据库中但不通过 API 返回(TenantDTO 不包含 Settings)
  • UUID 生成: 由 PostgreSQL gen_random_uuid() 自动生成
  • 更新逻辑: 仅更新非空字段;Slug 变更时排除自身进行唯一性检查

依赖注入 ​

go
fx.Module("org",
    fx.Provide(
        infrastructure.NewTenantRepository,
        application.NewService,
        NewHandler,
    ),
)

Released under the Apache 2.0 License.