55 lines
5.1 KiB
Markdown
55 lines
5.1 KiB
Markdown
# 后端文件速查表
|
||
|
||
> 工程：UserHome（yh-platform 用户首页/应用门户） ｜ 基础包：com.yunhai.userhome ｜ 最近更新：2026-08-20
|
||
> 维护规则：本表在**新增 / 重命名 / 删除** .java 源文件时自动同步；纯内容改动不触发。也可手动输出"更新后端文件速查表"全量重建。
|
||
|
||
## Controller（接口层）
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/controller/api/UserController.java | UserController | 用户首页接口（CAS 登录态 `/{platform}/user/`）：登录信息、可访问应用分组全集、按 id 取应用、角色列表/当前角色保存 | AppRemoteService、IUserCurrentRoleService、YschBaseOpenApi |
|
||
| src/main/java/com/yunhai/userhome/controller/api/UsedAppController.java | UsedAppController | 常用应用接口（CAS 登录态 `/{platform}/usedapp/`）：常用详情（按角色/学校）、覆盖式保存（appIds+type+roleType+schId）、用户级常用、按 ids 取应用 | UsedAppService、AppRemoteService |
|
||
|
||
## Service
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/service/AppRemoteService.java | AppRemoteService | 远程「用户可访问应用」数据服务接口（跨仓 UserBase 分组全集） | 实现 OpenApiAppRemoteServiceImpl；产出 BoaAppType |
|
||
| src/main/java/com/yunhai/userhome/service/impl/OpenApiAppRemoteServiceImpl.java | OpenApiAppRemoteServiceImpl | AppRemoteService 真实实现：经 YschBaseOpenApi.getUserApp 实时拉取（PC_BROWSER，自动带 app-auth 签名） | YschBaseOpenApi、ClientEnum |
|
||
| src/main/java/com/yunhai/userhome/service/UsedAppService.java | UsedAppService | 本地「常用应用」服务接口（used_app 表读写，四维结构） | 实现 UsedAppServiceImpl |
|
||
| src/main/java/com/yunhai/userhome/service/impl/UsedAppServiceImpl.java | UsedAppServiceImpl | 常用应用读写：覆盖式保存（setId+type+roleType+schId 唯一）、多级生效（用户>学校>系统）、详情从跨仓全集过滤 | UsedAppRepository、AppRemoteService |
|
||
| src/main/java/com/yunhai/userhome/service/IUserCurrentRoleService.java | IUserCurrentRoleService | 用户当前激活角色服务接口（user_current_role 表） | 实现 UserCurrentRoleServiceImpl |
|
||
| src/main/java/com/yunhai/userhome/service/impl/UserCurrentRoleServiceImpl.java | UserCurrentRoleServiceImpl | 当前角色读写实现 | UserCurrentRoleRepository |
|
||
|
||
## Repository
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/repository/UsedAppRepository.java | UsedAppRepository | used_app 数据访问（Spring Data JPA + Specification）：四维唯一判重、多级生效查询 | 实体 UsedApp |
|
||
| src/main/java/com/yunhai/userhome/repository/UserCurrentRoleRepository.java | UserCurrentRoleRepository | user_current_role 数据访问：按 userId 查当前角色 | 实体 UserCurrentRole |
|
||
|
||
## Entity / Model
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/entity/UsedApp.java | UsedApp | 常用应用设置实体（app_ids 逗号分隔 + set_type/set_id/sch_id/role_type/c_id/c_date），本地表不冗余应用元数据 | 继承 BaseEntity；SetType |
|
||
| src/main/java/com/yunhai/userhome/entity/UserCurrentRole.java | UserCurrentRole | 用户当前激活角色实体（user_id 主键 + role_id/role_name/sch_id/sch_name/child_id/child_name） | — |
|
||
| src/main/java/com/yunhai/userhome/model/SetType.java | SetType | 常用应用设置级别枚举：0=系统 1=学校 2=用户 | 被 UsedApp 引用 |
|
||
|
||
## Config
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/config/Config.java | Config | 路径前缀枚举：`/{platform}` 普通接口（CAS 登录态）、`/oapi/` 开放接口（yh-app-auth 签名） | 被 Controller 使用；注 Boot 2.6+ 路径勿带尾斜杠 |
|
||
|
||
## Common（aspect/annotation/util/interceptor/listener）
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/common/BaseEntity.java | BaseEntity | JPA 实体基类（自增主键 id + create_time + update_time），与 UserBase/BasePlatform 约定一致 | 被 UsedApp 继承 |
|
||
|
||
## 其他（task/event/enums）
|
||
| 路径(相对工程根) | 类名 | 职责 | 关键关联 |
|
||
| --- | --- | --- | --- |
|
||
| src/main/java/com/yunhai/userhome/UserHomeApplication.java | UserHomeApplication | Spring Boot 启动入口类 | — |
|
||
|
||
## 变更记录
|
||
| 时间 | 类型 | 说明 |
|
||
| --- | --- | --- |
|
||
| 2026-08-19 | 初始化 | 建表（随"启用后端文档维护"触发，扫描现有 12 个 .java 生成） |
|
||
| 2026-08-20 | 重构 | 跨仓接口就绪：删 PlaceholderAppRemoteServiceImpl / UserAppVo，新增 OpenApiAppRemoteServiceImpl（真实 YschBaseOpenApi 调用）；used_app 升级四维结构；新增 UserCurrentRole 一列实体/Repo/Service；UserController 增 getUserRole/findUserRole/savUserRole；UsedAppController 增 getUsedAppById/saveUsedAppById/getAppByIds，getUsedApp 返回 BoaApp 详情；新增 model/SetType |
|