外观
工作空间
springboot-business-workspace 管理协作空间、空间中的成员及加入邀请。例如,用户创建一个项目空间,成为所有者,再通过邀请码邀请同事以管理员或普通成员身份加入。
模块提供空间和成员关系的数据库模型,以及管理端、App 端 API。它不自动为应用的项目、订单等业务数据添加空间隔离,也不负责前端邀请页面或消息发送。
从哪里开始
| 你的需求 | 文档 |
|---|---|
| 创建空间并邀请另一个用户加入 | 快速开始 |
| 查询、管理空间,初始化用户默认空间 | 空间管理 |
| 查看成员、调整角色、转让所有权和退出 | 成员与角色 |
| 创建、查看、撤销邀请及处理加入失败 | 邀请加入 |
选择接入模块
以下模块的 groupId 均为 com.own.business,版本由 Business BOM 管理。
| 模块 | 何时引入 |
|---|---|
springboot-business-workspace-controller-app | 面向登录用户提供空间、成员和邀请 API |
springboot-business-workspace-controller-admin | 在管理后台提供空间与成员的通用 CRUD API |
springboot-business-workspace-business | 应用自行编排 Service,不使用预置 Controller |
springboot-business-workspace-common | 只需要共享 DTO、VO、查询模型和角色枚举 |
两个 Controller JAR 均传递引入 business 和 common。顶层 springboot-business-workspace 是聚合 POM/BOM,不是包含所有接口的运行时 JAR。
数据与职责
| 对象 | 作用 |
|---|---|
| 工作空间 | 保存名称、封面及是否为默认空间 |
| 空间成员 | 关联一个用户与一个空间,保存其角色及加入时使用的邀请码 |
| 空间邀请 | 保存目标空间、加入角色、启用状态和有效期;成功加入后不会自动消耗邀请码 |
同一用户可以加入多个空间。所有者、管理员、普通成员是空间内角色,与管理后台的模块操作权限分开。
接入时需要已有用户身份、MySQL 数据源和 Store 锁实现。App 列表会按当前用户过滤,但部分详情、修改和分页入口没有成员身份校验;默认空间及通用更新也存在当前实现限制。使用前请结合空间管理、成员与角色和邀请加入中对应操作的边界配置应用授权。
按文件查阅方法
重点文件与方法逐项说明核心类、接口和方法重载的用途、参数、返回值、调用示例与注意事项,并链接到公开仓库对应源码。