开发指南
Forge Admin 是基于 Vue 3 + Spring Boot 3 的企业级中后台管理框架。本指南帮助你快速掌握项目的开发规范、工程结构和最佳实践。
内容区域
开发规范与工程基础
| 文档 | 说明 |
|---|---|
| 完整工程目录与模块职责 | 后端 forge-server 模块树与前端 forge-admin-ui 目录 |
| 后端分层约定 | Controller → Service → Manager → Mapper 分层规则 |
| 前端结构约定 | src 下各目录职责说明 |
| 编码规范 | Java / Vue / SQL 命名与格式化要求 |
| API 协议约定 | 统一响应格式、分页参数、加密接口 |
| 数据库规范 | 表命名、必备字段、类型选择 |
| 逻辑删除设计 | del_flag 机制与唯一索引设计 |
| Flyway 脚本规范 | 迁移脚本命名与编写规则 |
| 租户隔离边界 | TenantLineInnerInterceptor 工作原理 |
| 数据权限规则 | DataScopeInterceptor SQL 改写机制 |
| 开发安全红线 | SQL 注入、XSS、密码与日志安全 |
| 渐进式 SDD 工作流 | spec-init → propose → apply → review → test → archive |
| Agent Skill 使用方式 | 项目级 Skill 目录与常用 Skill |
| 调试与日志定位 | IDEA 远程调试与日志级别调整 |
| Git 提交与代码审查 | commit message 规范与 PR 自查清单 |
后端基础开发
从 后端开发入口 开始，了解 Entity/DTO/VO 边界、Mapper XML、Service 事务、Controller 校验、分页与异常处理。
前端基础开发
从 前端开发入口 开始，了解页面路由、请求封装、加密请求、Pinia 状态管理、权限控制与字典组件。