smart
98 lines
7.1 KiB
Markdown
98 lines
7.1 KiB
Markdown
# 源码定位图
|
|
|
|
本文件只记录当前本地 JeecgBoot 快照中已经观察到的路径。课堂中可以让 TRAE 基于这些路径继续追踪调用链，但不能把没有路径依据的内容当作事实。
|
|
|
|
## 项目知识库入口
|
|
|
|
| 主题 | 路径 | 用途 |
|
|
| --- | --- | --- |
|
|
| 项目知识库入口 | `../../../JeecgBoot/docs/project-knowledge/README.md` | 阅读顺序、架构文档和生成索引入口 |
|
|
| 项目语境 | `../../../JeecgBoot/docs/project-knowledge/CONTEXT.md` | 产品语境、核心名词、角色和不变量 |
|
|
| 上下文地图 | `../../../JeecgBoot/docs/project-knowledge/CONTEXT-MAP.md` | 限界上下文和运行边界 |
|
|
| 架构说明 | `../../../JeecgBoot/docs/project-knowledge/01-architecture.md` | 系统形态、请求流和数据流 |
|
|
| 运行说明 | `../../../JeecgBoot/docs/project-knowledge/02-runtime.md` | 本地、Docker、微服务运行模式 |
|
|
| 后端说明 | `../../../JeecgBoot/docs/project-knowledge/03-backend.md` | 后端模块、API 和 CRUD 约定 |
|
|
| 前端说明 | `../../../JeecgBoot/docs/project-knowledge/04-frontend.md` | 前端启动链路、路由、状态和 API 客户端 |
|
|
| 权限说明 | `../../../JeecgBoot/docs/project-knowledge/06-auth-permissions.md` | Token、Shiro、菜单和按钮权限生命周期 |
|
|
| 扩展指南 | `../../../JeecgBoot/docs/project-knowledge/07-extension-guide.md` | 基于源码的功能扩展路径 |
|
|
|
|
## 后端入口与模块
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| 后端父 POM | `../../../JeecgBoot/jeecg-boot/pom.xml` | 判断 Maven 多模块、Spring Boot 版本、Java 版本 |
|
|
| 后端协作约束 | `../../../JeecgBoot/jeecg-boot/CLAUDE.md` | 查看模块结构、运行命令、修改痕迹规则 |
|
|
| 单体启动类 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-start/src/main/java/org/jeecg/JeecgSystemApplication.java` | 后端启动入口 |
|
|
| 系统启动模块 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-start` | 单体应用配置、启动和资源 |
|
|
| 系统业务模块 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-biz` | 用户、角色、权限、菜单等系统业务 |
|
|
| 系统 API 模块 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-api` | 单体和微服务 API 切换 |
|
|
| 基础核心模块 | `../../../JeecgBoot/jeecg-boot/jeecg-boot-base-core` | Shiro/JWT、MyBatis-Plus、通用工具 |
|
|
| 示例模块 | `../../../JeecgBoot/jeecg-boot/jeecg-boot-module/jeecg-module-demo` | 课堂可参考 CRUD 示例结构 |
|
|
| AI/RAG 模块 | `../../../JeecgBoot/jeecg-boot/jeecg-boot-module/jeecg-boot-module-airag` | AI 应用相关后端能力 |
|
|
|
|
## 前端入口与模块
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| 前端 package | `../../../JeecgBoot/jeecgboot-vue3/package.json` | 查看脚本、依赖、Node engines |
|
|
| 前端协作约束 | `../../../JeecgBoot/jeecgboot-vue3/CLAUDE.md` | 查看启动链路、路由、Pinia、API 层约定 |
|
|
| 前端入口 | `../../../JeecgBoot/jeecgboot-vue3/src/main.ts` | Vue app 初始化顺序 |
|
|
| Vite 配置 | `../../../JeecgBoot/jeecgboot-vue3/vite.config.ts` | alias、插件、构建配置 |
|
|
| 系统页面 | `../../../JeecgBoot/jeecgboot-vue3/src/views/system` | 用户、角色、菜单、字典等系统管理页面 |
|
|
| 扩展模块 | `../../../JeecgBoot/jeecgboot-vue3/src/views/super` | 动态发现扩展模块 |
|
|
| 组件库 | `../../../JeecgBoot/jeecgboot-vue3/src/components/jeecg` | Jeecg 封装组件 |
|
|
| 布局 | `../../../JeecgBoot/jeecgboot-vue3/src/layouts/default` | 后台布局、菜单、页签 |
|
|
|
|
## 权限与路由
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| 前端路由目录 | `../../../JeecgBoot/jeecgboot-vue3/src/router` | 静态路由、路由守卫、动态路由挂载 |
|
|
| 权限 Store | `../../../JeecgBoot/jeecgboot-vue3/src/store/modules/permission.ts` | 后端菜单、权限码、动态路由 |
|
|
| 用户 Store | `../../../JeecgBoot/jeecgboot-vue3/src/store/modules/user.ts` | Token、用户信息、角色、租户 |
|
|
| 认证工具 | `../../../JeecgBoot/jeecgboot-vue3/src/utils/auth/index.ts` | Token 本地存储和读取 |
|
|
| 后端系统业务 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-biz` | 用户、角色、菜单权限相关后端逻辑 |
|
|
| 权限知识库 | `../../../JeecgBoot/docs/project-knowledge/06-auth-permissions.md` | 课堂优先阅读的权限链路说明 |
|
|
|
|
## API 与请求层
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| 前端 API 目录 | `../../../JeecgBoot/jeecgboot-vue3/src/api` | API 定义分组 |
|
|
| Axios 封装 | `../../../JeecgBoot/jeecgboot-vue3/src/utils/http/axios` | `defHttp` 请求层 |
|
|
| 系统 API | `../../../JeecgBoot/jeecgboot-vue3/src/api/sys` | 登录、用户、权限等系统接口 |
|
|
| 通用 API | `../../../JeecgBoot/jeecgboot-vue3/src/api/common` | 通用上传、字典等能力 |
|
|
| 后端 Controller 索引 | `../../../JeecgBoot/docs/project-knowledge/generated/backend-endpoints.md` | 快速查后端接口候选位置 |
|
|
| 前端视图索引 | `../../../JeecgBoot/docs/project-knowledge/generated/frontend-routes.md` | 快速查前端页面候选位置 |
|
|
|
|
## 配置与运行
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| 根 README | `../../../JeecgBoot/README.md` | 项目介绍、版本、启动入口 |
|
|
| 单体 Docker Compose | `../../../JeecgBoot/docker-compose.yml` | MySQL、Redis、后端、前端容器 |
|
|
| 微服务 Docker Compose | `../../../JeecgBoot/docker-compose-cloud.yml` | 微服务模式容器 |
|
|
| 后端主配置 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-start/src/main/resources/application.yml` | profile 入口 |
|
|
| 后端开发配置 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-start/src/main/resources/application-dev.yml` | 端口、context path、MySQL、Redis、AI 配置 |
|
|
| 前端开发环境 | `../../../JeecgBoot/jeecgboot-vue3/.env.development` | mock、代理、后端地址 |
|
|
| 前端基础环境 | `../../../JeecgBoot/jeecgboot-vue3/.env` | 端口、标题、运行平台等基础变量 |
|
|
|
|
## 数据库与迁移
|
|
|
|
| 主题 | 路径 | 课堂用途 |
|
|
| --- | --- | --- |
|
|
| MySQL 初始化 | `../../../JeecgBoot/jeecg-boot/db/jeecgboot-mysql-5.7.sql` | 基础表结构和初始化数据 |
|
|
| Flyway 迁移 | `../../../JeecgBoot/jeecg-boot/jeecg-module-system/jeecg-system-start/src/main/resources/flyway/sql/mysql` | 增量迁移脚本 |
|
|
| 数据文档 | `../../../JeecgBoot/docs/project-knowledge/05-data-and-migrations.md` | 数据库来源和迁移策略 |
|
|
| 数据字典索引 | `../../../JeecgBoot/docs/project-knowledge/generated/database-dictionary.md` | 表结构快速索引 |
|
|
| 权限码索引 | `../../../JeecgBoot/docs/project-knowledge/generated/permission-codes.md` | 权限码候选索引 |
|
|
|
|
## 课堂使用方式
|
|
|
|
1. 学员先复制本文件的路径表，形成自己的上下文包。
|
|
2. 每次向 TRAE 提问前，至少提供 3 个相关路径。
|
|
3. TRAE 输出后，必须把“事实依据”填入 [worksheets.md](./worksheets.md) 的源码依据记录表。
|
|
4. 对没有路径支撑的内容，统一写入“不确定点”。
|
|
5. 讲师只验收能回到路径的结论，不验收泛泛总结。
|
|
|