添加文档

This commit is contained in:
zk
2026-03-12 11:50:16 +08:00
parent 636ca5413f
commit 28b118f975
+28 -7
View File
@@ -11,16 +11,24 @@ offerpie/back-end
│ └─ src/main/java
│ └─ org.jiayunet
│ ├─ ClientApplication.java # Spring Boot 主入口
│ ├─ annotation/
│ │ └─ FuncPermission.java # 功能权限校验注解(标记在Controller方法上)
│ ├─ aop/
│ │ └─ FuncPermissionAspect.java # 功能权限校验切面(拦截注解,校验+扣减+异常回退)
│ ├─ controller/
│ │ ─ LoginController.java # 登录相关接口(发送验证码、短信登录)
│ │ ─ LoginController.java # 登录相关接口(发送验证码、短信登录)
│ │ └─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树)
│ ├─ server/
│ │ ├─ LoginServer.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置)
│ │ ├─ FuncPermissionServer.java # 功能权限服务(校验、扣减、查询、添加库存、回退)
│ │ ├─ RouteMenuServer.java # 路由菜单服务(查询、添加库存、获取用户菜单树)
│ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现
│ └─ pojo/
│ ├─ dto/
│ │ └─ SmsLoginDto.java # 短信登录入参(mobileNumber + code
│ └─ vo/
─ LoginVo.java # 登录返回(userId + nick
─ LoginVo.java # 登录返回(userId + nick
│ └─ RouteMenuVo.java # 路由菜单树形VO(含children子菜单)
├─ common/ # **共享层**:被 C 端和 B 端共同使用的代码库
│ ├─ pom.xml
@@ -40,21 +48,34 @@ offerpie/back-end
├─ pom.xml
└─ src/main/java
└─ org.jiayunet
├─ constant/ # 常量枚举(OSS路径、短信模板等)
├─ controller/ # 对外 REST 接口(HealthCheck、Oss 等)
├─ mapper/ # MyBatis MapperUserMapper、OssFileMapper
├─ mapper/ # MyBatis Mapper
│ ├─ UserMapper.java
│ ├─ OssFileMapper.java
│ ├─ RouteMenuMapper.java # 路由菜单Mapper
│ ├─ FuncPermissionMapper.java # 功能权限Mapper
│ ├─ UserRouteMenuStockMapper.java # 用户路由菜单库存Mapper
│ └─ UserFuncPermissionStockMapper.java # 用户功能权限库存Mapper
├─ pojo/
│ ├─ po/ # 持久化实体User、OssFile 等)
│ ├─ po/ # 持久化实体
│ │ ├─ User.java
│ │ ├─ OssFile.java
│ │ ├─ RouteMenu.java # 路由菜单表(bg_route_menu
│ │ ├─ FuncPermission.java # 功能权限表(bg_func_permission
│ │ ├─ UserRouteMenuStock.java # 用户路由菜单库存表(bg_user_route_menu_stock
│ │ └─ UserFuncPermissionStock.java # 用户功能权限库存表(bg_user_func_permission_stock
│ └─ vo/ # ViewObjectOssUrlVo 等)
└─ … (业务 Service、Utils)
└─ server/ # 业务 ServiceOssServer、SmsServer
```
> **设计理念** `manager` 模块把 **C 端** 与 **B 端** 共用的代码(如实体、Mapper、统一响应、拦截器、配置)集中放在 `common`,从而避免在两个子项目之间出现重复实现。`client‑api` 只负责面向用户的 API,`manager` 提供后台管理相关的功能;两者均通过 `common` 中的工具、配置、统一异常处理等实现一致的技术栈。
## 2️⃣ 各层模块职责
| 层级 | 主要职责 | 关键类/包 |
|------|----------|-----------|
| **clientapi** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册) | `ClientApplication``LoginController``LoginServer``SmsLoginDto``LoginVo``application.yml` |
| **clientapi** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册) <br> - **功能权限校验**:注解 + 切面 + 权限服务(校验、扣减、回退) <br> - **路由菜单**:获取用户有效菜单树 | `ClientApplication``LoginController``RouteMenuController``FuncPermission``FuncPermissionAspect``FuncPermissionServer``RouteMenuServer``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/` |
| **manager** | - **业务实体**`User``OssFile` 等) <br> - **MyBatis Mapper**`UserMapper``OssFileMapper` <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端 业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/` |
| **manager** | - **业务实体**`User``OssFile``RouteMenu``FuncPermission``UserRouteMenuStock``UserFuncPermissionStock` 等) <br> - **MyBatis Mapper**`UserMapper``OssFileMapper``RouteMenuMapper``FuncPermissionMapper``UserRouteMenuStockMapper``UserFuncPermissionStockMapper` <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端 业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` |
## 3️⃣ 关键业务实体(示例)
| 实体 | 所属路径 | 作用概述 |