diff --git a/client-api/src/main/java/org/jiayunet/server/RouteMenuServer.java b/client-api/src/main/java/org/jiayunet/server/RouteMenuServer.java index 3203739..2e93b62 100644 --- a/client-api/src/main/java/org/jiayunet/server/RouteMenuServer.java +++ b/client-api/src/main/java/org/jiayunet/server/RouteMenuServer.java @@ -96,6 +96,23 @@ public class RouteMenuServer { * @return 树形路由菜单 */ public List getUserRoutes(Long userId) { + // 一次查出所有启用的菜单 + List allMenus = routeMenuMapper.selectList( + new LambdaQueryWrapper().eq(RouteMenu::getStatus, 1)); + + if (allMenus.isEmpty()) { + return Collections.emptyList(); + } + + Map menuMap = allMenus.stream() + .collect(Collectors.toMap(RouteMenu::getId, m -> m)); + + // 收集公开菜单ID + Set needIds = allMenus.stream() + .filter(m -> m.getOpenAccess() != null && m.getOpenAccess() == 1) + .map(RouteMenu::getId) + .collect(Collectors.toSet()); + // 查询用户有效库存（不限时 或 未过期） Instant now = Instant.now(); List stocks = userRouteMenuStockMapper.selectList( @@ -108,46 +125,36 @@ public class RouteMenuServer { ) ); - if (stocks == null || stocks.isEmpty()) { + // 合并库存中有权限的菜单ID + if (stocks != null && !stocks.isEmpty()) { + stocks.stream() + .map(UserRouteMenuStock::getRouteId) + .forEach(needIds::add); + } + + if (needIds.isEmpty()) { return Collections.emptyList(); } - Set validRouteIds = stocks.stream() - .map(UserRouteMenuStock::getRouteId) - .collect(Collectors.toSet()); - - if (validRouteIds.isEmpty()) { - return Collections.emptyList(); - } - - // 一次查出所有启用的菜单 - List allMenus = routeMenuMapper.selectList( new LambdaQueryWrapper().eq(RouteMenu::getStatus, 1)); - - if (allMenus.isEmpty()) { - return Collections.emptyList(); - } - - // 收集有权限的节点及其所有父节点ID - Map menuMap = allMenus.stream().collect(Collectors.toMap(RouteMenu::getId, m -> m)); - - Set needIds = new HashSet<>(validRouteIds); - for (Long routeId : validRouteIds) { + // 补充父节点 + Set allNeedIds = new HashSet<>(needIds); + for (Long routeId : needIds) { RouteMenu current = menuMap.get(routeId); while (current != null && current.getParentId() != 0) { - needIds.add(current.getParentId()); + allNeedIds.add(current.getParentId()); current = menuMap.get(current.getParentId()); } } // 转VO List voList = allMenus.stream() - .filter(menu -> needIds.contains(menu.getId())) + .filter(menu -> allNeedIds.contains(menu.getId())) .map(menu -> { RouteMenuVo vo = new RouteMenuVo(); BeanUtils.copyProperties(menu, vo); return vo; }) - .collect(Collectors.toList()); + .toList(); // 构建树形结构 Map> parentMap = voList.stream() diff --git a/manager/src/main/java/org/jiayunet/pojo/po/RouteMenu.java b/manager/src/main/java/org/jiayunet/pojo/po/RouteMenu.java index cdc7575..13ee0f4 100644 --- a/manager/src/main/java/org/jiayunet/pojo/po/RouteMenu.java +++ b/manager/src/main/java/org/jiayunet/pojo/po/RouteMenu.java @@ -55,6 +55,11 @@ public class RouteMenu { */ private Integer sortOrder; + /** + * 0=需要库存权限 1=公开免费 + */ + private Integer openAccess; + /** * 状态 1=启用 0=禁用 */ diff --git a/项目结构说明.md b/项目结构说明.md index 357e177..4f5f17e 100644 --- a/项目结构说明.md +++ b/项目结构说明.md @@ -1,4 +1,4 @@ -# OfferPie Back‑End 项目结构说明 +# OfferPie Back‑End 项目结构说明 @zk ## 1️⃣ 项目整体层次 ``` @@ -41,8 +41,8 @@ offerpie/back-end │ ├─ exception/ # 业务异常统一处理 │ ├─ email/ # 邮件发送抽象（EmailAbility） │ ├─ wxPay/ # 微信支付相关能力（Js、Native、Transfer 等） -│ ├─ pojo/ # 公共 POJO（统一响应、登录/防重放 token 等） -│ └─ web/ # Spring MVC 全局响应体 advice +│ ├─ pojo/ # 公共 POJO（统一响应、登录/防重放 token 等） +│ └─ web/ # Spring MVC 全局响应体 advice │ └─ manager/ # **B 端 + C 端共享** 的业务实现（尚未搭建完整的 B 端 UI） ├─ pom.xml @@ -68,26 +68,58 @@ offerpie/back-end │ └─ vo/ # ViewObject（OssUrlVo 等） └─ server/ # 业务 Service（OssServer、SmsServer 等） ``` -> **设计理念** – `manager` 模块把 **C 端** 与 **B 端** 共用的代码（如实体、Mapper、统一响应、拦截器、配置）集中放在 `common`，从而避免在两个子项目之间出现重复实现。`client‑api` 只负责面向用户的 API，`manager` 提供后台管理相关的功能；两者均通过 `common` 中的工具、配置、统一异常处理等实现一致的技术栈。 +> **设计理念** – 业务实体和 Mapper 位于 `manager`，B 端和 C 端共享；C 端特有的注解、切面、权限服务、路由菜单服务位于 `client-api`，避免 B 端误用；`common` 提供统一的技术支撑。 ## 2️⃣ 各层模块职责 | 层级 | 主要职责 | 关键类/包 | |------|----------|-----------| -| **client‑api** | - 面向终端用户的 REST API
- 启动 Spring Boot 应用
- 短信验证码登录（含自动注册）
- **功能权限校验**：注解 + 切面 + 权限服务（校验、扣减、回退）
- **路由菜单**：获取用户有效菜单树 | `ClientApplication`、`LoginController`、`RouteMenuController`、`FuncPermission`、`FuncPermissionAspect`、`FuncPermissionServer`、`RouteMenuServer`、`RouteMenuVo` | +| **client-api** | - 面向终端用户的 REST API
- 启动 Spring Boot 应用
- 短信验证码登录（含自动注册）
- **功能权限校验**：注解 + 切面 + 权限服务（校验、扣减、回退）
- **路由菜单**：获取用户有效菜单树 | `ClientApplication`、`LoginController`、`RouteMenuController`、`FuncPermission`、`FuncPermissionAspect`、`FuncPermissionServer`、`RouteMenuServer`、`RouteMenuVo` | | **common** | - **统一配置**：OSS、Redis、Security、WxPay、Sms 等
- **跨层工具**：HTTP、IP、认证、验证码、Redis Server 等
- **全局拦截/切面**：日志、TraceId、黑名单、SQL 打印
- **统一异常/响应**：`GlobalExceptionAdvice`、`UnifiedResponse`
- **业务抽象**：邮件发送、微信支付（Native/JS/Transfer）
- **公共 POJO**：登录令牌、防重放信息等 | `config/`, `tool/`, `interceptor/`, `aop/`, `exception/`, `email/`, `wxPay/`, `pojo/` | -| **manager** | - **业务实体**（`User`、`OssFile`、`RouteMenu`、`FuncPermission`、`UserRouteMenuStock`、`UserFuncPermissionStock` 等）
- **MyBatis Mapper**（`UserMapper`、`OssFileMapper`、`RouteMenuMapper`、`FuncPermissionMapper`、`UserRouteMenuStockMapper`、`UserFuncPermissionStockMapper`）
- **业务 API**：文件上传/下载、健康检查等
- **业务逻辑**：服务层、工具类等
- **既供 B 端 UI（待实现）使用，也供 C 端 业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` | +| **manager** | - **业务实体**（`User`、`OssFile`、`RouteMenu`、`FuncPermission`、`UserRouteMenuStock`、`UserFuncPermissionStock`）
- **MyBatis Mapper**（`UserMapper`、`OssFileMapper`、`RouteMenuMapper`、`FuncPermissionMapper`、`UserRouteMenuStockMapper`、`UserFuncPermissionStockMapper`）
- **业务 API**：文件上传/下载、健康检查等
- **业务逻辑**：服务层、工具类等
- **既供 B 端 UI（待实现）使用，也供 C 端业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` | -## 3️⃣ 关键业务实体（示例） -| 实体 | 所属路径 | 作用概述 | +## 3️⃣ 关键业务实体 +| 实体 | 所属模块 | 作用概述 | |------|----------|----------| -| `User` | `manager/src/main/java/.../pojo/po/User.java` | 记录用户基础信息（手机号、邮箱、密码、昵称、微信绑定等），配合 `UserMapper` 完成持久化。 | -| `OssFile` | `manager/src/main/java/.../pojo/po/OssFile.java` | 描述 OSS（对象存储）中文件的元数据（路径、大小、标签等），通过 `OssFileMapper` 进行增删改查。 | -| `OssUrlVo` | `manager/src/main/java/.../pojo/vo/OssUrlVo.java` | 对外返回的 OSS 访问 URL 结构体，供前端直接使用。 | -| `LoginVo` | `client-api/src/main/java/.../pojo/vo/LoginVo.java` | 登录成功后返回的用户信息（userId、nick）。 | -| `SmsLoginDto` | `client-api/src/main/java/.../pojo/dto/SmsLoginDto.java` | 短信验证码登录的请求参数（mobileNumber、code）。 | -> 这些实体位于 **manager**，因为它们属于业务模型，`manager` 负责提供完整的业务实现；同时它们可以被 **C 端**（如 `client‑api`）直接调用，体现了 B 端 + C 端共享的设计初衷。 +| `User` | manager | 记录用户基础信息（手机号、邮箱、密码、昵称、微信绑定等），配合 `UserMapper` 完成持久化。 | +| `OssFile` | manager | 描述 OSS（对象存储）中文件的元数据（路径、大小、标签等），通过 `OssFileMapper` 进行增删改查。 | +| `RouteMenu` | manager | 路由菜单表（bg_route_menu），支持多级树形结构，通过 rootId/parentId 表达层级关系，openAccess 标识是否公开免费。 | +| `FuncPermission` | manager | 功能权限表（bg_func_permission），定义功能点编码（func_code，最长12字符，唯一约束）。 | +| `UserRouteMenuStock` | manager | 用户路由菜单库存表（bg_user_route_menu_stock），记录用户拥有的菜单权限，支持时间维度。 | +| `UserFuncPermissionStock` | manager | 用户功能权限库存表（bg_user_func_permission_stock），记录用户拥有的功能权限，支持时间/次数/复合维度。 | +| `RouteMenuVo` | client-api | 路由菜单树形VO，包含 children 子菜单列表，供前端渲染动态路由。 | +| `LoginVo` | client-api | 登录成功后返回的用户信息（userId、nick）。 | +| `SmsLoginDto` | client-api | 短信验证码登录的请求参数（mobileNumber、code）。 | -## 4️⃣ 共享技术栈（位于 `common`） +## 4️⃣ 权限体系设计 +### 整体架构 +- **前端**：路由控制菜单/页面可见性，登录后拉取用户有效菜单树（含公开免费菜单 + 库存授权菜单） +- **后端**：AOP 切面拦截 `@FuncPermission` 注解，校验权限 + 扣减库存，业务异常自动回退次数 +- **权限来源**：商品模块下单成功后写入库存表，权限框架不关心来源 + +### 数据库表（4张） +| 表名 | 说明 | +|------|------| +| `bg_route_menu` | 路由菜单定义（树形结构，open_access 标识公开免费菜单） | +| `bg_user_route_menu_stock` | 用户路由菜单库存（时间维度） | +| `bg_func_permission` | 功能权限定义（func_code 唯一） | +| `bg_user_func_permission_stock` | 用户功能权限库存（时间/次数/复合维度） | + +### 库存维度 +- `time_limit` + `expire_time`：时间维度，0=不限时，1=限时 +- `count_limit` + `remain_count`：次数维度，0=不限次，1=限次 +- 两个维度独立控制，组合形成四种模式：永久不限次、限时不限次、永久限次、限时限次 +- 添加库存时不降级：已经不限时/不限次的不会被覆盖 + +### 切面校验流程 +1. 拿注解上的 funcCode + 当前登录用户 userId +2. 查库存表（唯一索引 userId + funcCode） +3. 无记录 → 无权限 +4. time_limit=1 且过期 → 已过期 +5. count_limit=0 → 直接放行 +6. count_limit=1 → SQL 原子扣减 `remain_count = remain_count - 1`（WHERE remain_count > 0） +7. 业务方法异常 → 自动回退次数 + +## 5️⃣ 共享技术栈（位于 `common`） | 类别 | 关键实现 | 位置 | |------|----------|------| | **配置** | `OssConfig`, `RedissonConf`, `SecurityConfig`, `WxPayConfig`, `SmsConfig` | `common/config` | @@ -99,16 +131,16 @@ offerpie/back-end | **工具类** | `HttpTool`, `HttpIpTool`, `AuthenticTool`, `ObjectTool`, `VerifyImageCodeUtils` | `common/tool` | | **统一返回体** | `UnifiedResponse`, `UnifiedResponseBodyAdvice` | `common/pojo`, `common/web` | | **批量/更新** | `UpdateBatchMethod`（批量更新策略） | `common/config` | -这些设施在 **C 端** 与 **B 端** 中统一使用，确保技术栈、日志、异常、配置保持一致。 -## 5️⃣ 构建与运行 +## 6️⃣ 构建与运行 - **父 POM**（`back-end/pom.xml`）统一管理子模块的依赖与插件。 -- 子模块 (`client‑api`, `common`, `manager`) 均可单独 `mvn clean install`，生成各自的 jar 包。 -- **启动入口**：运行 `client‑api` 中的 `ClientApplication`，Spring Boot 会自动扫描并加载 `common`（配置、拦截、工具）以及 `manager` 中声明的 Mapper 与 Service。 +- 子模块 (`client-api`, `common`, `manager`) 均可单独 `mvn clean install`，生成各自的 jar 包。 +- **启动入口**：运行 `client-api` 中的 `ClientApplication`，Spring Boot 会自动扫描并加载 `common`（配置、拦截、工具）以及 `manager` 中声明的 Mapper 与 Service。 -## 6️⃣ 小结 +## 7️⃣ 小结 - 项目采用 **三层结构**： - 1. **client‑api** → 只负责 C 端 REST 接口。 - 2. **manager** → 包含业务实体、Mapper 与业务 API，既供 B 端（后台）使用，也供 C 端直接调用；因此是 **B 端 + C 端共享层**。 - 3. **common** → 所有层共同依赖的底层设施（配置、工具、拦截、异常、支付、邮件等），实现“一次实现、全局共享”。 -- 这种布局把 **业务实现** 与 **技术支撑** 明确分离，后续在 C 端或 B 端新增功能时，只需在 `manager` 中编写业务代码，`common` 负责统一的技术支撑，避免代码重复、提高维护效率。 \ No newline at end of file + 1. **client-api** → C 端 REST 接口 + 功能权限校验（注解/切面/服务） + 路由菜单服务。 + 2. **manager** → 业务实体、Mapper 与业务 API，B 端 + C 端共享层。 + 3. **common** → 所有层共同依赖的底层设施（配置、工具、拦截、异常、支付、邮件等）。 +- 权限体系分两层：前端路由控制菜单可见性，后端切面控制功能点权限与库存扣减。 +- 权限和菜单作为商品维度，框架只负责校验和库存管理，不关心权限来源。