跟新文档

This commit is contained in:
zk
2026-03-12 16:44:10 +08:00
parent bebf9c9c50
commit 7ecd277f4d
+10 -6
View File
@@ -20,12 +20,13 @@ offerpie/back-end
│ │ └─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树) │ │ └─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树)
│ ├─ server/ │ ├─ server/
│ │ ├─ LoginServer.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置) │ │ ├─ LoginServer.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置)
│ │ ├─ UserRegisterServer.java # 用户注册服务(注册逻辑、邀请码生成与绑定)
│ │ ├─ FuncPermissionServer.java # 功能权限服务(校验、扣减、查询、添加库存、回退) │ │ ├─ FuncPermissionServer.java # 功能权限服务(校验、扣减、查询、添加库存、回退)
│ │ ├─ RouteMenuServer.java # 路由菜单服务(查询、添加库存、获取用户菜单树) │ │ ├─ RouteMenuServer.java # 路由菜单服务(查询、添加库存、获取用户菜单树)
│ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现 │ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现
│ └─ pojo/ │ └─ pojo/
│ ├─ dto/ │ ├─ dto/
│ │ └─ SmsLoginDto.java # 短信登录入参(mobileNumber + code │ │ └─ SmsLoginDto.java # 短信登录入参(mobileNumber + code + inviteCode
│ └─ vo/ │ └─ vo/
│ ├─ LoginVo.java # 登录返回(userId + nick │ ├─ LoginVo.java # 登录返回(userId + nick
│ └─ RouteMenuVo.java # 路由菜单树形VO(含children子菜单) │ └─ RouteMenuVo.java # 路由菜单树形VO(含children子菜单)
@@ -53,6 +54,7 @@ offerpie/back-end
├─ mapper/ # MyBatis Mapper ├─ mapper/ # MyBatis Mapper
│ ├─ UserMapper.java │ ├─ UserMapper.java
│ ├─ OssFileMapper.java │ ├─ OssFileMapper.java
│ ├─ UserInviteMapper.java # 用户邀请记录Mapper
│ ├─ RouteMenuMapper.java # 路由菜单Mapper │ ├─ RouteMenuMapper.java # 路由菜单Mapper
│ ├─ FuncPermissionMapper.java # 功能权限Mapper │ ├─ FuncPermissionMapper.java # 功能权限Mapper
│ ├─ UserRouteMenuStockMapper.java # 用户路由菜单库存Mapper │ ├─ UserRouteMenuStockMapper.java # 用户路由菜单库存Mapper
@@ -62,6 +64,7 @@ offerpie/back-end
│ ├─ po/ # 持久化实体 │ ├─ po/ # 持久化实体
│ │ ├─ User.java │ │ ├─ User.java
│ │ ├─ OssFile.java │ │ ├─ OssFile.java
│ │ ├─ UserInvite.java # 用户邀请记录表(bg_user_invite
│ │ ├─ RouteMenu.java # 路由菜单表(bg_route_menu │ │ ├─ RouteMenu.java # 路由菜单表(bg_route_menu
│ │ ├─ FuncPermission.java # 功能权限表(bg_func_permission │ │ ├─ FuncPermission.java # 功能权限表(bg_func_permission
│ │ ├─ UserRouteMenuStock.java # 用户路由菜单库存表(bg_user_route_menu_stock │ │ ├─ UserRouteMenuStock.java # 用户路由菜单库存表(bg_user_route_menu_stock
@@ -75,15 +78,16 @@ offerpie/back-end
## 2️⃣ 各层模块职责 ## 2️⃣ 各层模块职责
| 层级 | 主要职责 | 关键类/包 | | 层级 | 主要职责 | 关键类/包 |
|------|----------|-----------| |------|----------|-----------|
| **client-api** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册) <br> - **功能权限校验**:注解 + 切面 + 权限服务(校验、扣减、回退) <br> - **路由菜单**:获取用户有效菜单树 | `ClientApplication``LoginController``RouteMenuController``FuncPermission``FuncPermissionAspect``FuncPermissionServer``RouteMenuServer``RouteMenuVo` | | **client-api** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册、邀请码绑定 <br> - **功能权限校验**:注解 + 切面 + 权限服务(校验、扣减、回退) <br> - **路由菜单**:获取用户有效菜单树 | `ClientApplication``LoginController``RouteMenuController``FuncPermission``FuncPermissionAspect``FuncPermissionServer``RouteMenuServer``UserRegisterServer``RouteMenuVo` |
| **common** | - **统一配置**OSS、Redis、Security、WxPay、Sms 等 <br> - **跨层工具**:HTTP、IP、认证、验证码、Redis Server 等 <br> - **全局拦截/切面**:日志、TraceId、黑名单、SQL 打印 <br> - **统一异常/响应**`GlobalExceptionAdvice``UnifiedResponse` <br> - **业务抽象**:邮件发送、微信支付(Native/JS/Transfer <br> - **公共 POJO**:登录令牌、防重放信息等 | `config/`, `tool/`, `interceptor/`, `aop/`, `exception/`, `email/`, `wxPay/`, `pojo/` | | **common** | - **统一配置**OSS、Redis、Security、WxPay、Sms 等 <br> - **跨层工具**:HTTP、IP、认证、验证码、Redis Server 等 <br> - **全局拦截/切面**:日志、TraceId、黑名单、SQL 打印 <br> - **统一异常/响应**`GlobalExceptionAdvice``UnifiedResponse` <br> - **业务抽象**:邮件发送、微信支付(Native/JS/Transfer <br> - **公共 POJO**:登录令牌、防重放信息等 | `config/`, `tool/`, `interceptor/`, `aop/`, `exception/`, `email/`, `wxPay/`, `pojo/` |
| **manager** | - **业务实体**`User``OssFile``RouteMenu``FuncPermission``UserRouteMenuStock``UserFuncPermissionStock``UserFuncUsageLog` <br> - **MyBatis Mapper**`UserMapper``OssFileMapper``RouteMenuMapper``FuncPermissionMapper``UserRouteMenuStockMapper``UserFuncPermissionStockMapper``UserFuncUsageLogMapper` <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` | | **manager** | - **业务实体**`User``OssFile``UserInvite``RouteMenu``FuncPermission``UserRouteMenuStock``UserFuncPermissionStock``UserFuncUsageLog` <br> - **MyBatis Mapper**`UserMapper``OssFileMapper``UserInviteMapper``RouteMenuMapper``FuncPermissionMapper``UserRouteMenuStockMapper``UserFuncPermissionStockMapper``UserFuncUsageLogMapper` <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` |
## 3️⃣ 关键业务实体 ## 3️⃣ 关键业务实体
| 实体 | 所属模块 | 作用概述 | | 实体 | 所属模块 | 作用概述 |
|------|----------|----------| |------|----------|----------|
| `User` | manager | 记录用户基础信息(手机号、邮箱、密码、昵称、微信绑定等),配合 `UserMapper` 完成持久化。 | | `User` | manager | 记录用户基础信息(手机号、邮箱、密码、昵称、微信绑定、邀请码等),配合 `UserMapper` 完成持久化。 |
| `OssFile` | manager | 描述 OSS(对象存储)中文件的元数据(路径、大小、标签等),通过 `OssFileMapper` 进行增删改查。 | | `OssFile` | manager | 描述 OSS(对象存储)中文件的元数据(路径、大小、标签等),通过 `OssFileMapper` 进行增删改查。 |
| `UserInvite` | manager | 用户邀请记录表,记录邀请人与被邀请人的关系及邀请时间。 |
| `RouteMenu` | manager | 路由菜单表(bg_route_menu),支持多级树形结构,通过 rootId/parentId 表达层级关系,openAccess 标识是否公开免费。 | | `RouteMenu` | manager | 路由菜单表(bg_route_menu),支持多级树形结构,通过 rootId/parentId 表达层级关系,openAccess 标识是否公开免费。 |
| `FuncPermission` | manager | 功能权限表(bg_func_permission),定义功能点编码(func_code,最长12字符,唯一约束),daily_free_count 配置每日免费次数。 | | `FuncPermission` | manager | 功能权限表(bg_func_permission),定义功能点编码(func_code,最长12字符,唯一约束),daily_free_count 配置每日免费次数。 |
| `UserRouteMenuStock` | manager | 用户路由菜单库存表(bg_user_route_menu_stock),记录用户拥有的菜单权限,支持时间维度。 | | `UserRouteMenuStock` | manager | 用户路由菜单库存表(bg_user_route_menu_stock),记录用户拥有的菜单权限,支持时间维度。 |
@@ -91,7 +95,7 @@ offerpie/back-end
| `UserFuncUsageLog` | manager | 用户功能使用记录表(bg_user_func_usage_log),记录每次功能使用,用于免费次数统计和异常回退。 | | `UserFuncUsageLog` | manager | 用户功能使用记录表(bg_user_func_usage_log),记录每次功能使用,用于免费次数统计和异常回退。 |
| `RouteMenuVo` | client-api | 路由菜单树形VO,包含 children 子菜单列表,供前端渲染动态路由。 | | `RouteMenuVo` | client-api | 路由菜单树形VO,包含 children 子菜单列表,供前端渲染动态路由。 |
| `LoginVo` | client-api | 登录成功后返回的用户信息(userId、nick)。 | | `LoginVo` | client-api | 登录成功后返回的用户信息(userId、nick)。 |
| `SmsLoginDto` | client-api | 短信验证码登录的请求参数(mobileNumber、code)。 | | `SmsLoginDto` | client-api | 短信验证码登录的请求参数(mobileNumber、code、inviteCode)。 |
## 4️⃣ 权限体系设计 ## 4️⃣ 权限体系设计
### 整体架构 ### 整体架构
@@ -145,7 +149,7 @@ offerpie/back-end
## 7️⃣ 小结 ## 7️⃣ 小结
- 项目采用 **三层结构** - 项目采用 **三层结构**
1. **client-api** → C 端 REST 接口 + 功能权限校验(注解/切面/服务) + 路由菜单服务。 1. **client-api** → C 端 REST 接口 + 功能权限校验(注解/切面/服务) + 路由菜单服务 + 用户注册与邀请
2. **manager** → 业务实体、Mapper 与业务 API,B 端 + C 端共享层。 2. **manager** → 业务实体、Mapper 与业务 API,B 端 + C 端共享层。
3. **common** → 所有层共同依赖的底层设施(配置、工具、拦截、异常、支付、邮件等)。 3. **common** → 所有层共同依赖的底层设施(配置、工具、拦截、异常、支付、邮件等)。
- 权限体系分两层:前端路由控制菜单可见性,后端切面控制功能点权限与库存扣减。 - 权限体系分两层:前端路由控制菜单可见性,后端切面控制功能点权限与库存扣减。