49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
|
||
# 项目背景
|
||
一个培训项目
|
||
|
||
## 技术栈
|
||
前后端分离
|
||
- 前端：react 版本 18，typescript，vite
|
||
- 后端：springboot 3.4.5，java 21，mybatis-plus
|
||
- 数据库：mysql 8
|
||
- 缓存：redis
|
||
|
||
## 工作规则
|
||
### 整体规则
|
||
- 所有文件使用 uft-8 格式，避免中文乱码。
|
||
- 修改代码前，必须先阅读项目结构。
|
||
- 修改前必须说明会影响哪些文件。
|
||
- 修改后必须给出启动命令和测试步骤。
|
||
- 不允许把所有功能堆在一个页面或一个文件里。
|
||
- 建表或修改表是要完整的加上相应的注释，注释使用中文。
|
||
- 涉及删除文件、删除结果、清空数据库时，必须有二次确认、操作日志和回滚说明。
|
||
|
||
## 环境
|
||
- 使用 .env.example 做为环境的配置
|
||
|
||
### 前端规则
|
||
|
||
### 后端规则
|
||
- 所有类型为大驼峰格式，变量名为小驼峰格式
|
||
- 代码采用四层结构完成，包括 controller，service，mapper，domain。
|
||
- controller层为接口申明，为前端提供接口。
|
||
- service层为业务逻辑的接口，其中子文件impl，为业务逻辑接口的实现层，专门写业务逻辑。
|
||
- mapper层包括mapper接口和mapper的xml文件，用户操作数据库。
|
||
- domain层包括各个pojo类。
|
||
- 所有的方法参数不允许使用map，需创建对应的dto类。
|
||
- 使用@RequiredArgsConstructor完成依赖注入
|
||
|
||
## 数据库规则
|
||
- 表名为大写，多个单词之间用下划线"_"连接。
|
||
- 数据库建表或修改表结构后，将最终的建表语句保存在sql/xxx.sql中，xxx为对应数据库表名。
|
||
|
||
## 输出规范
|
||
- 采用标准的代码格式。
|
||
|
||
## 完成标准
|
||
- 修改了哪些文件。
|
||
- 每个文件修改了什么。
|
||
- 如何验证功能。
|
||
- 是否涉及数据库 SQL。
|
||
- 是否存在风险和回滚方式。 |