81 lines
2.6 KiB
Plaintext
81 lines
2.6 KiB
Plaintext
# 项目规则文档
|
||
|
||
## 1. 日志查看规则
|
||
- 不允许使用 `tail -f` 命令查看日志文件
|
||
- 应该使用 `tail` 命令查看日志内容
|
||
- 查看日志直接查看项目本身的日志，而非tomcat的日志
|
||
|
||
## 2. 项目结构规则
|
||
- 后端项目目录：`backend/`
|
||
- 前端项目目录：`frontend/`
|
||
- 数据库脚本目录：`database/`
|
||
- 文档目录：`doc/`
|
||
|
||
## 3. 构建和部署规则
|
||
- 使用 Maven 构建后端项目：`mvn clean package -DskipTests`
|
||
- Tomcat 运行在 Docker 容器中：
|
||
- 端口映射：18080
|
||
- 数据目录：`$DOCKER_DATA_DIR/tomcat`
|
||
- 日志目录：`$DOCKER_DATA_DIR/tomcat/logs`
|
||
- WAR包目录：`$DOCKER_DATA_DIR/tomcat/webapps`
|
||
- 应用上下文路径：`/llm-survey-api`
|
||
- 复制文件时，使用 `command cp` 命令
|
||
- 查看日志始终只查看应用的业务日志
|
||
- 部署完成后应该稍等几秒查看下业务日志看看发布有没有错误
|
||
|
||
## 4. 数据库规则
|
||
- 数据库名称：`llm_survey`
|
||
- 数据库用户：`dev`
|
||
- 数据库地址：`127.0.0.1:3306`
|
||
- 使用 `init_database.sh` 脚本初始化数据库
|
||
|
||
## 5. 代码规范
|
||
- Java源代码使用UTF-8编码
|
||
- 使用Lombok简化代码
|
||
- DAO层继承BaseDao接口
|
||
- Service层继承BaseService接口
|
||
- 控制器使用RestController注解
|
||
|
||
## 6. Spring配置规则
|
||
- 共享的bean定义放在 `applicationContext.xml`
|
||
- MVC相关配置放在 `spring-mvc.xml`
|
||
- MyBatis相关配置放在 `spring-mybatis.xml`
|
||
- 避免重复的bean定义
|
||
|
||
## 7. 错误处理规则
|
||
- 使用统一的错误处理格式（ErrorInfo）
|
||
- 所有异常由GlobalExceptionHandler处理
|
||
- 业务异常使用IllegalArgumentException
|
||
|
||
## 8. API规范
|
||
- RESTful API设计
|
||
- 统一的响应格式
|
||
- 支持跨域访问
|
||
- API文档位于 `doc/api.md`
|
||
|
||
## 9. 安全规则
|
||
- 不在代码中硬编码敏感信息
|
||
- 配置信息放在properties文件中
|
||
- 使用prepared statement防止SQL注入
|
||
|
||
## 10. 版本控制
|
||
- 使用Git进行版本控制
|
||
- 遵循语义化版本规范
|
||
- 重要配置文件加入版本控制
|
||
|
||
## 11. 文件操作
|
||
- 当需要复制文件时，使用 `command cp` 命令
|
||
- 如果发现目录不存在，首先确认自己当前目录是否正确
|
||
- 如果需要创建目录，使用 `command mkdir -p` 命令
|
||
- 不要尝试重新安装开发依赖工具，比如jdk, node，python等
|
||
|
||
## 前端开发
|
||
- 前端使用vue3开发
|
||
- 代码必须严格遵守 eslint 规则
|
||
- 前端项目使用yarn打包，用最新的4.x版
|
||
- 前端项目根目录下需要有`.yarn.yml`配置文件
|
||
- 前端启动开发服务器，需要把切换到前端目录以及启动开发服务器两个命令合并执行
|
||
|
||
## Vant 框架
|
||
|
||
- `van-popup`的 `v-model` 需要绑定为`v-model:show` |