Skip to main content

代码结构索引

本章节汇总 SurveyKing Pro 前端 (React) 与 后端 (Spring Boot) 的代码组织方式，帮助研发快速定位文件并了解模块职责。

📚 阅读顺序​

  1. 前端代码结构 — React + Ant Design 客户端目录、核心模块、页面与组件说明。
  2. 后端代码结构 — Spring Boot 单体多模块项目的目录、业务/技术模块分层与依赖图。

建议先整体浏览索引，再按需深入前端或后端章节。

🏗️ 总览图​

  • Client → Server 通过 /admin-api/* & /survey/* REST 接口通信。
  • surveyking-framework 提供公共技术能力，业务模块依赖框架。

🔍 快速定位​

目标路径备注
前端入口client/src/app.tsxReact 根组件
前端 API 定义client/src/services/axios/rtk-query 请求封装
后端启动类server/surveyking-server/.../SurveyKingApplication.javaSpring Boot 启动
核心业务 Controller*module-*/**/controller/**路径统一 /admin-api/*
数据库映射*module-*/**/mapper/**MyBatis Plus Mapper
公共异常码surveyking-framework/surveyking-common/.../GlobalErrorCodeConstants.java

✨ 开发建议​

  • IDE Multi-Module：后端为父 Maven 项目，建议用 IntelliJ IDEA「Open as Project」一次加载父 POM。
  • 前端别名：@/components/ @/pages/ 通过 tsconfig.json > paths 配置，避免相对路径地狱。
  • 接口对照：代码中的 REST 接口与 API 规范 章节保持一致。

下一步：选择感兴趣的模块，深入阅读对应文档或直接浏览源码。

Last updated on