# OOAD **Repository Path**: moookyie/OOAD ## Basic Information - **Project Name**: OOAD - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-10-26 - **Last Updated**: 2026-11-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 基于 RBAC 模型的权限管理系统 > 厦门大学《面向对象分析与设计》(OOAD) 2026 秋季学期课程设计 > 与《软件工程》《JavaEE 平台技术》共用同一选题与分组 本仓库存放本组课程设计的**全部文档、模型与代码**。每次检查前需要提交的「详细设计 + Jacoco 测试报告」均从本仓库导出。 --- > 当前四节点部署、重新发布及服务器文件交接以 [部署交接文档](docs/17-deployment-handoff.md) 为准。日常更新不重新导入数据或清库。 ## 一、这个项目在做什么 为一家**市政公司**实现**统一授权中心**:公司的 18 个业务系统不自己管权限,而是把「某用户能否对某部门的数据做某操作」交给本系统判定。 **当前阶段(第一次检查)**按课程的 RBAC0 需求清单实现: - 权限模型只做 **RBAC0**:User — Role — Permission(= Resource × Action),不做角色继承与约束; - 用**面向功能的结构化设计**,技术栈 Spring MVC + JPA + MySQL + Redis,分层只用 Controller + Service + Mapper; - 登录、鉴权两个场景;一个用户属于一个部门,但可以在多个部门有权限;临时用户;按分公司 / 部门 / 员工批量授权;多公司;超级管理员越过权限引擎;管理员只能管理自身及以下层级;权限修改后下一次访问即生效。 系统建立在课程提供的三份**真实数据**之上,已全量导入核对: | 数据 | 导入结果 | |---|---| | 部门信息表 | 111 个部门(总公司 → 9 个分公司 + 职能部门 → 下级部门),全部建成 | | 员工信息表 | 10,000 名员工,全部按「分公司 + 部门」唯一定位到部门 | | 应用软件功能权限清单 | 18 个业务系统 / 115 个功能模块 / 359 个资源;1,795 个权限(资源 × 五类操作);五类角色共 3,190 条角色权限 | 外部模拟业务系统 `rbac-mock-biz` 取清单中的两个功能点(发文拟稿与审核、考勤管理),每次操作带着用户令牌调用权限中心,验证权限在业务系统里真实生效。 需求与实现的逐条对照、尚未完成的事项见 [`docs/14-rbac0-gap.md`](docs/14-rbac0-gap.md)。 --- ## 二、课程检查节点与对应交付物 > 依据:《课程设计成绩计算办法(V1)-OOAD_Grading_2026》与《课程介绍》 | 时间 | 分数 | 内容要求 | 本仓库对应交付物 | |---|---|---|---| | **10/27 – 10/29** | 20 | 前端界面设计、API 设计、数据库设计;用**结构化**方式实现 **RBAC0** 后端 | [`01`](docs/01-srs.md) 需求、[`02`](docs/02-architecture.md) 概要设计、[`03`](docs/03-database.md) 数据库、[`04`](docs/04-api.md) API、[`05`](docs/05-ui.md) 界面、[`06`](docs/06-detail-structured.md) **详细设计**、[`09`](docs/09-test-plan.md) 测试与 Jacoco | | 11/24 – 11/26 | 30 | 课程介绍中为 RBAC1、结构化与面向对象两种实现 + 部分前端 | 届时以老师当期需求清单为准 | | 12/22 – 12/24 | 20 | 课程介绍中为 RBAC2/3 + 前端,部分功能函数式 | 同上 | | 考勤 | −10 | 缺勤超 1/3 −10;超 1/4 −5;超 1/5 −2 | — | **每次检查前必须提交:详细设计文档 + Jacoco 测试报告**(无法提供报告则提供代码)。 ### 检查方式:无领导小组面试 分**个人陈述**与**自由讨论**两阶段。个人陈述阶段,每位同学依次陈述文档中的**一个设计**,讲清: 1. 这个设计的**需求是什么,存在什么问题** 2. 采用**何种设计方法,采用的理由**是什么 3. 展示**实现效果** 六个设计点与讲稿模板见 [`docs/11-defense.md`](docs/11-defense.md)。成绩 = 个人表现 50% + 小组整体表现 50%。 --- ## 三、文档导航 | 文档 | 内容 | 主要用于 | |---|---|---| | [`00-charter.md`](docs/00-charter.md) | 项目章程、设计点分工、里程碑、完成定义 | 全程 | | [`01-srs.md`](docs/01-srs.md) | **需求规格说明书**:领域模型、需求总表、用例、数据疑点 | 检查一 ★ | | [`02-architecture.md`](docs/02-architecture.md) | **概要设计**:质量属性与取舍、三层架构、判定、缓存与失效、认证、部署 | 检查一 ★ | | [`03-database.md`](docs/03-database.md) | **数据库设计**:ER 图、表结构、多公司与作用域、三份 xlsx 的导入规则与真实结果 | 检查一 ★ | | [`04-api.md`](docs/04-api.md) | **API 设计**:约定、错误码、45 个接口与所需权限 | 检查一 ★ | | [`05-ui.md`](docs/05-ui.md) | **前端界面设计**:页面结构、线框图、Dashboard 统计口径;已在 `rbac-web/` 实现 | 检查一 ★ | | [`06-detail-structured.md`](docs/06-detail-structured.md) | **详细设计 · 结构化**:功能层次图、数据流图、数据字典、处理规约、耦合与内聚 | 检查一 ★ | | [`09-test-plan.md`](docs/09-test-plan.md) | 测试策略、T01–T22 验收用例与追溯、Jacoco | 检查一 ★ | | [`11-defense.md`](docs/11-defense.md) | 六个设计点与个人陈述讲稿模板、高频追问 | 每次检查前 ★ | | [`12-design-log.md`](docs/12-design-log.md) | **设计问题与改正记录**(#15–#29 为本次按审查整改) | 检查二 ★ | | [`13-deployment.md`](docs/13-deployment.md) | 历史编译与部署说明;当前流程见 17 | 历史参考 | | [`17-deployment-handoff.md`](docs/17-deployment-handoff.md) | 当前四节点部署、源码更新发布、文件交接与测试范围 | 部署维护 | | [`14-rbac0-gap.md`](docs/14-rbac0-gap.md) | RBAC0 需求逐条对照、审查问题的处理、遗留事项 | 检查一 ★ | | [`15-debug-report.md`](docs/15-debug-report.md) | 验收前 Debug 记录:问题复现、定位、修复与验证;RBAC0 验收场景实测结果 | 检查一 ★ | | [`07`](docs/07-detail-oo.md) / [`08`](docs/08-detail-functional.md) / [`10`](docs/10-paradigm-comparison.md) | 面向对象、函数式、范式对比的早期骨架(**当前阶段不实现**) | 后续检查 | | [`archive/sql/`](docs/archive/sql/) | 旧版 V1–V3 迁移脚本(含 RBAC1/2/3,已不执行) | 参考 | | [`rbac-contract/`](rbac-contract/) | Flyway 建表脚本与 OpenAPI 契约(数据库与接口的唯一来源) | 全程 ★ | | [`data/raw/`](data/raw/) | 课程提供的三份原始 xlsx(**含真实人员信息,不入库**,需自行下载) | 导入 | | [`intro-spec-coding/`](intro-spec-coding/) | **导论题目 1**(与 RBAC 无关):Spec Coding 调研报告、PPT 文字稿、选型指南,以及对照实验工程与数据 | 导论 | --- ## 四、技术选型 | 层 | 选型 | 说明 | |---|---|---| | 语言 | Java 21 | Jacoco 是课程提交门槛 | | 构建 | Maven 3.9.9 多模块,仓库自带 `./mvnw` | 依赖走华为云镜像 | | 后端 | Spring Boot 3.3(Spring MVC) | | | 持久化 | **Spring Data JPA** + Flyway | 课程规定 JPA,不使用 MyBatis | | 数据库 | MySQL 8.0 | 组织与授权关系建外键 | | 缓存 | Redis 7 | 授权数据缓存(版本号在 MySQL,与修改同一事务)、已注销令牌 | | 认证 | JWT(只证明身份,不带权限)+ BCrypt | | | 数据导入 | Apache POI | 三份 xlsx,产出异常清单 | | 测试 | JUnit 5 + MockMvc + ArchUnit + **Jacoco** | 集成测试连真实 MySQL 与 Redis | | 部署 | Docker + Docker Swarm,华为云 3 台 2 核 2G | 见 [`13-deployment.md`](docs/13-deployment.md) | | 前端 | Vue 3 + TypeScript + Element Plus + Pinia + ECharts | `rbac-web/`,界面设计见 `05-ui.md`;Nginx 镜像提供页面 | | 前端测试 | Vitest + Playwright | 单元测试 + 连真实后端的端到端测试 | ### 工程结构 ``` rbac-parent/ ├── rbac-contract/ Flyway 建表脚本 V1(RBAC0 基线)与 OpenAPI 契约 rbac-api.yaml ├── rbac-structured/ 权限中心(:8081),结构化设计 │ └── src/main/java/com/xmu/rbac/structured/ │ ├── controller/ Spring MVC 控制器、按契约统一鉴权的拦截器、统一响应与异常处理 │ ├── service/ 处理过程:认证、权限判定、用户 / 角色 / 授权管理、批量、导入、审计、统计 │ ├── mapper/ Spring Data JPA 接口;Redis 访问(授权缓存、已注销令牌) │ ├── entity/ 与表一一对应的记录(只有字段,没有方法) │ ├── dto/ 请求、响应与过程间传递的数据(record) │ └── config/ 装配 ├── rbac-mock-biz/ 外部模拟业务系统(:8090):带用户令牌调用 /authz/check,允许才执行 └── rbac-web/ 前端(Vue 3 + TypeScript,不在 Maven 里):15 个页面,菜单与路由由 /menus/me 动态生成 ├── src/api/ 45 个接口的类型与调用、统一错误处理 ├── src/stores/ 登录与权限状态 ├── src/router/ 按菜单注册路由、路由守卫 ├── src/views/ 页面;src/components/ 共用组件(批量授权、部门选择、用户详情……) ├── tests/ Vitest 单元测试 └── e2e/ Playwright 端到端测试与虚构的 xlsx 样本 ``` 依赖方向、包结构、「不用 MyBatis」「实体没有方法」「Service 无状态」由 `ArchitectureTest` 检查,违反即构建失败。 --- ## 五、快速开始 ```bash git clone https://github.com/vintcessun/OOAD.git cd OOAD # 测试用的 MySQL 与 Redis(端口与 application-test.yml 一致) docker run -d --name rbac-test-mysql -p 13306:3306 -e MYSQL_ROOT_PASSWORD=root \ -e MYSQL_DATABASE=rbac_test mysql:8.0 --character-set-server=utf8mb4 docker run -d --name rbac-test-redis -p 16379:6379 redis:7-alpine # 构建:编译 + 69 个测试 + Jacoco 门槛(只需装 JDK 21,Maven 由 ./mvnw 下载) ./mvnw -s deploy/maven-settings-huawei.xml verify # Windows 用 mvnw.cmd # Jacoco 报告:rbac-structured/target/site/jacoco/index.html # 前端:单元测试、类型检查、端到端测试(需要 Node 20+;端到端会自己启动上面打出的 jar) cd rbac-web && npm ci && npm run typecheck && npm run test:coverage npx playwright install chromium && npm run e2e npm run dev # 开发:http://localhost:5173,/api 转发到 8081 cd .. # 部署:MySQL + Redis + 权限中心 + 外部模拟系统 + 前端 docker compose up -d --build curl http://localhost:8081/api/v1/actuator/health # {"status":"UP"} # 浏览器打开 http://localhost ``` 部署后的初始化(详见 [`13-deployment.md`](docs/13-deployment.md);可在前端页面操作,也可按 [`deploy/rbac-demo.http`](deploy/rbac-demo.http) 顺序调接口): 1. `root` / `Admin@123` 登录,**先修改口令**(改之前其他接口都返回 40304); 2. `POST /imports/permissions` 上传功能权限清单; 3. `POST /imports/organization?companyCode=SZ&companyName=市政公司` 上传部门表与员工表; 4. 核对导入报告中的异常清单; 5. 用 `POST /assignments/batch` **人工**分配角色(导入不分配任何角色),例如全公司分配普通员工。 ### 当前进度 | 模块 | 状态 | |---|---| | `rbac-contract` | ✅ RBAC0 基线 V1;45 个接口的 OpenAPI 契约 | | `rbac-structured` | ✅ 45 个接口全部实现;T01–T22 验收用例通过;69 个测试,行覆盖率 97%、分支 84% | | `rbac-mock-biz` | ✅ 发文拟稿 / 审批、考勤(只限本人)调用权限中心 | | `rbac-web` | ✅ 15 个页面;42 个单元测试、9 个连真实后端的端到端测试 | | 三台服务器部署 | 🟡 编排已含前端;新版本按组内安排暂未部署(旧库需删库重建) | ### 组员请先做三件事 1. **通读 [`docs/11-defense.md`](docs/11-defense.md)** —— 检查是无领导小组面试,每人要讲**文档中的一个设计**。先了解六个设计点各自在讲什么。 2. **读 [`docs/14-rbac0-gap.md`](docs/14-rbac0-gap.md)** —— 需求逐条对照,以及还没做完的事(服务器部署、老师的测试、StarUML 图)。 3. **把三份 xlsx 放进 `data/raw/`** —— 它们不入库(含一万条真实姓名和手机号),需要自己从课程网站下载。 ### 待决策与待办(10/21 汇总) 认领时在「负责人」一栏写上自己,做完把这一行删掉或改成 ✅,并在 [`12-design-log.md`](docs/12-design-log.md) 记一条。 **待团队决策**(意见不一或影响范围大,没有直接改) | # | 事项 | 现状与影响 | 建议 | 负责人 | |---|---|---|---|---| | D1 | 是否删除外部模拟业务系统 `rbac-mock-biz` | 组内提出 `01-srs` §1.2 那句(「另做一个独立进程的外部模拟业务系统」)可以删。它不在 RBAC0 需求清单里,审查分工也不含它;但它是 `pom.xml`、`docker-compose.yml` 里的独立模块,答辩时能演示「权限在业务系统里真实生效」 | 删就整体删:模块、编排服务、CI、文档(`01`、`02`、`04`、`05`、`06`、`13`)一起改;不删则保留现状 | 待认领 | | D2 | 审计是否分级 | 10/15 组内提出「日志没分级」;现为不分级,理由见 [12 R-19](docs/12-design-log.md) | 老师或组内坚持要分级时,V5 加 `level` 列(由事件类型与结果推出) | 待认领 | | D3 | 同一适用部门的管理员能否互相回收指派 | 回收只看适用部门([12 R-20](docs/12-design-log.md)),同范围的管理员能撤掉对方在该部门的角色;同公司内本来就是这样 | 若要禁止,需另加「不能回收与自己同级或更高的管理员角色」规则 | 待认领 | | D4 | 能否停用、删除自己的账号 | 10/22 组内提出。现在任何人(包括超级管理员)都不能改自己的状态(`CANNOT_CHANGE_SELF`),而回收自己的角色是允许的(只保护最后一个超级管理员)。理由:停用、删除后本人立即无法登录,也无法自己恢复,只能由别的管理员处理;回收角色不影响登录 | 建议保持现状;若要放开,至少保留「不能停用、删除最后一个超级管理员」 | 待认领 | | D5 | 停用后再启用,旧令牌是否恢复可用 | 10/22 组内讨论。**注销黑名单只在登出时写入**,停用不写黑名单;每次请求都查库看账号状态,所以停用立即生效。但重新启用后,此前签发、未登出、未改口令、未过 2 小时有效期的旧令牌会重新可用 | 若认为不应恢复:停用、删除时把 `token_version` 加一(与改口令同一机制),启用后必须重新登录;改动约两行加一个测试 | 待认领 | **待有人动手**(结论已定,需要特定工具或人工) | # | 事项 | 说明 | 负责人 | |---|---|---|---| | T1 | StarUML 核对与重新导出 | 打开 `diagrams/rbac.mdj` 核对三张图、调整布局;V4 删除了 `sys_user.expires_at`,ER 图要删掉这一列再导出 `er-diagram.png/svg`。清单见 [`diagrams/README.md`](diagrams/README.md) | 待认领 | | T2 | 复核 HR-001(跨公司授权) | [`human-review/findings.md`](human-review/findings.md) 的复核栏留空;审查规则不允许自动签字 | 待认领 | | T3 | Apifox 导入并跑一遍 | 按 [`docs/04-api.md`](docs/04-api.md) §1.5、[`docs/16-apifox-testing.md`](docs/16-apifox-testing.md) 操作(图形界面,需要人工) | 待认领 | | T4 | 部署到三台服务器 | 组内决定暂缓;部署时 Flyway 自动执行 V2–V4,跑过旧脚本的库按 [`13 §5`](docs/13-deployment.md) 重建 | 待认领 | | T5 | 接入老师的正式测试 | 尚未发布 | 待认领 | | T6 | 修 `human-review/check_packet.py` | 运行时找 `D:\Scripts\rbac-structured`,路径算错了一层;审查包按基线 `a42b801` 冻结,由包的作者决定是否修 | 待认领 | | T7 | 依赖升级 PR | Dependabot 为 `rbac-web` 开了新的升级分支,未合并 | 待认领 | | T8 | 组内资料过期部分 | 组内流传的「领域模型-ER 图解读」与「跨公司」对话记录写于 10/21 修复之前:「适用部门须与用户同公司」「不支持跨公司授权」「查别人只能按所属部门」已不成立,以 [12 R-20](docs/12-design-log.md) 为准;其余字段解释与代码一致 | 待认领 | | T9 | 画数据流图与结构图 | 结构化设计的 DFD、结构图目前只有 [`06`](docs/06-detail-structured.md) 里的 Mermaid 版本,StarUML 中尚未画 | 待认领 | **已知的小问题**(10/21 复核发现,早于本轮改动,影响低,暂未改) - 管理类权限(`rbac:assignment:*`、`rbac:authz:invoke`)若被导入成「只限本人」,管理范围检查不看这个标记。目前这些权限只由 V1 内置给 `RBAC_ADMIN`,不经清单导入,实际不会出现。 - 整批原子(ATOMIC)批量回收被拒时,失败清单会列出范围外持有该角色的用户编号。 **疑问与解答**(组内提过的问题,答案以代码为准) | 问题 | 解答 | |---|---| | 「部门越界」「管理范围」是什么?管理员有分级吗? | 没有分级。管理员持有 `RBAC_ADMIN` 的那条指派的适用部门及其下级,就是他的管理范围;管理员之间只差范围大小 | | Scope Department(适用部门)是什么?只给管理员用吗? | `sys_user_role.scope_dept_id`,每条指派都有:表示「这个人在这个部门及下级行使这个角色的权限」。选公司根部门就代表整家公司;`department.id` 与 `company.id` 是两张表,不会冲突 | | 「有权限但目标部门不在范围内」约束什么? | `OUT_OF_DATA_SCOPE`:有这个权限,但只在别的部门。例如道路分公司的审批人去批桥梁分公司的公文 | | 一个人只在一个部门,为什么能有多个部门的权限? | 所属部门只有一个,指派可以有多条、适用部门各不相同(需求清单第 8 条) | | 能跨公司授权吗? | 能(10/21 起)。授出要同时管得到用户所属部门和适用部门;回收只看适用部门;公司内角色只能落在本公司([12 R-20](docs/12-design-log.md)) | | 业务操作为什么没有「删除」? | 权限清单只有查看、新增、编辑、审批、导出五类,「全部」也只展开这五类;`delete` 只用于权限中心自己的用户、角色、菜单 | | 「查看本人」「编辑本人」为什么单列? | 权限中心只知道部门,不知道某条记录属于谁,所以随判定结果返回「只限本人」,由业务系统按记录归属过滤 | | 临时用户为什么不能填电话、工号? | 需求清单第 9 条「临时用户,没有工号、电话」 | | 临时用户怎么结束? | 由管理员停用。账号只有启用、停用、删除三态,到期时间已于 10/21 取消(V4,[12 R-21](docs/12-design-log.md)) | | `user_type = SYSTEM` 是不是多余? | 不多余,组内讨论过、老师也提示过:用于**内部账号**,包括内部测试账号和业务系统接入账号,内置的 `root` 也是。它只影响两点:不要求工号;编号取内部段 1–9999([12 R-17](docs/12-design-log.md))。它不带任何特权,权限仍只来自角色 | | 用户能换公司吗? | 不能。修改用户只能调到本公司的部门;所属公司由所属部门决定。删除后重建也要换用户名,因为已删除用户的用户名不能复用。要在别家公司干活,用跨公司授权(指派的适用部门选对方公司的部门)即可,不必换公司 | | 能代查别家公司的人的权限吗? | 不能。查别人只看被查用户所属部门是否在调用者的范围内;跨公司授权的人由业务系统转发他本人的令牌查自己即可。10/21 曾加过「凭目标部门代查、只返回结论」,10/22 组内认为多余已撤回([12 R-20](docs/12-design-log.md)) | | 令牌黑名单是怎么工作的? | 只有**登出**会把令牌编号写进 Redis(`rbac:revoked:`),键的存活时间等于令牌剩余有效期,到期自动删除。改口令靠 `token_version` 加一让旧令牌全部失效。停用、删除不写黑名单,而是每次请求查库看账号状态(重新启用后的情况见 D5) | | JaCoCo 报告在哪? | `./mvnw verify` 后打开 `rbac-structured/target/site/jacoco/index.html`;或在 GitHub Actions 某次运行的附件里下载 `jacoco-report`。报告不入库 | ### 有异议的地方 文档里的每一条决策都写了理由。**如果不同意,直接改文档并说明新理由**,再改代码;凡是改了设计,就在 [`12-design-log.md`](docs/12-design-log.md) 追加一条。 --- ## 六、参考资料 1. Craig Larman. *Applying UML and Patterns*, 3rd ed. 2. Alistair Cockburn. *Writing Effective Use Cases*. 3. Edward Yourdon, Larry Constantine. *Structured Design*.(变换分析、事务分析、耦合与内聚) 4. ANSI/INCITS 359-2012, *Role Based Access Control*. 5. 《支付模块需求规格说明书》(PayReqSPEC) —— 本项目需求文档的格式范本。 6. 《面向对象分析与设计》课件 1–4(软件设计概述、需求分析、结构化软件设计、软件体系结构),2026 秋季学期。