290 lines
6.9 KiB
Markdown
290 lines
6.9 KiB
Markdown
# 项目配置清单
|
||
|
||
> 记录项目中的所有配置信息，包括外部接口、数据库、服务地址等
|
||
> 最后更新: 2025-12-12
|
||
|
||
---
|
||
|
||
## 📊 数据库配置
|
||
|
||
### MySQL数据库
|
||
- **数据库名**: `study`
|
||
- **JDBC URL**: `jdbc:mysql://127.0.0.1:3306/study?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=GMT%2B8&allowPublicKeyRetrieval=true`
|
||
- **地址**: `127.0.0.1`
|
||
- **端口**: `3306`
|
||
- **账号**: `root`
|
||
- **密码**: `root`
|
||
- **字符集**: `utf8mb4` + `utf8`
|
||
- **时区**: GMT+8 (Asia/Shanghai)
|
||
- **驱动**: `com.mysql.cj.jdbc.Driver`
|
||
- **用途**: 主数据库，存储所有业务数据
|
||
|
||
### 连接池配置 (Druid)
|
||
- **类型**: Alibaba Druid
|
||
- **初始连接数**: 5
|
||
- **最小空闲数**: 10
|
||
- **最大活动连接数**: 20
|
||
- **获取连接超时**: 60秒
|
||
- **连接超时**: 30秒
|
||
- **网络超时**: 60秒
|
||
- **监控地址**: `http://localhost:30091/druid/`
|
||
- **监控账号**: `ddnai_admin` / `Ddnai@2025#Druid`
|
||
- **慢SQL阈值**: 1000ms
|
||
|
||
### 数据库脚本位置
|
||
- **初始化脚本**: `log/数据库/dump-study-202512070856.sql`
|
||
- **备份脚本**: `log/mysql_study_20251129153033 (1).sql`
|
||
|
||
---
|
||
|
||
## 🌐 后端服务
|
||
|
||
### Spring Boot 应用
|
||
- **项目名称**: 国语教育平台
|
||
- **版本**: 1.0.0
|
||
- **项目路径**: `Study-Vue-redis/`
|
||
- **主程序**: `ry-study-admin/target/ry-study-admin.jar`
|
||
- **服务端口**: `30091`
|
||
- **访问路径**: `/`
|
||
- **API前缀**: `/dev-api` (Swagger)
|
||
- **启动命令**: `java -jar ry-study-admin/target/ry-study-admin.jar`
|
||
- **配置文件**:
|
||
- 主配置: `ry-study-admin/src/main/resources/application.yml`
|
||
- 数据源: `ry-study-admin/src/main/resources/application-druid.yml`
|
||
|
||
### Tomcat配置
|
||
- **URI编码**: UTF-8
|
||
- **最大线程数**: 800
|
||
- **最小线程数**: 100
|
||
- **连接队列数**: 1000
|
||
- **POST最大大小**: 2GB
|
||
|
||
### 管理后台
|
||
- **技术栈**: Vue.js
|
||
- **位置**: `Study-Vue-redis/ry-study-ui/`
|
||
|
||
### 日志配置
|
||
- **com.ddnai**: DEBUG级别
|
||
- **org.springframework**: WARN级别
|
||
|
||
---
|
||
|
||
## 📱 前端应用
|
||
|
||
### uni-app 移动端
|
||
- **项目路径**: `fronted_uniapp/`
|
||
- **技术栈**: uni-app (Vue.js)
|
||
- **打包平台**: Android / iOS / H5
|
||
- **开发工具**: HBuilderX
|
||
|
||
---
|
||
|
||
## 🔧 本地服务
|
||
|
||
### Redis缓存
|
||
- **地址**: `127.0.0.1`
|
||
- **端口**: `6379`
|
||
- **数据库索引**: `0`
|
||
- **密码**: 无密码（本地开发）
|
||
- **连接超时**: 10秒
|
||
- **连接池配置**:
|
||
- 最小空闲连接: 0
|
||
- 最大空闲连接: 8
|
||
- 最大活动连接: 8
|
||
- 最大等待时间: 无限制
|
||
- **用途**: 缓存、Session存储
|
||
|
||
### Whisper 语音识别服务器
|
||
- **服务文件**: `log/whisper_server.py`
|
||
- **端口**: `5000` (需确认)
|
||
- **用途**: 离线语音识别和评测
|
||
- **模型**: Whisper AI
|
||
- **功能**:
|
||
- 语音识别
|
||
- 语音评测（去除标点符号）
|
||
- 简体中文转换
|
||
|
||
---
|
||
|
||
## 🔐 安全配置
|
||
|
||
### Token认证
|
||
- **Header名称**: `Authorization`
|
||
- **令牌密钥**: `YWFhMzlhOGEtYTdjYi00NTUzLWFhMDct`
|
||
- **有效期**: 30分钟
|
||
- **⚠️ 注意**: 生产环境必须修改为随机32位字符串
|
||
|
||
### 用户密码策略
|
||
- **最大错误次数**: 5次
|
||
- **锁定时间**: 10分钟
|
||
|
||
### XSS防护
|
||
- **过滤开关**: 已启用
|
||
- **排除链接**: `/system/notice`
|
||
- **匹配链接**: `/system/*`, `/monitor/*`, `/tool/*`
|
||
|
||
### 防盗链
|
||
- **开关**: 已禁用
|
||
- **允许域名**: `localhost`, `127.0.0.1`, `ddnai.com`, `www.ddnai.com`
|
||
|
||
---
|
||
|
||
## 📁 文件上传配置
|
||
|
||
### 上传路径
|
||
- **Windows路径**: `D:\wwwroot\study_web\web\profile`
|
||
- **实际存储**: `profile/upload/yyyy/MM/dd/文件名`
|
||
- **数据库路径格式**: `/profile/upload/2025/11/18/xxx.mp4`
|
||
|
||
### 文件大小限制
|
||
- **单个文件**: 2GB
|
||
- **总请求大小**: 2GB
|
||
|
||
### 支持的文件类型
|
||
- 视频文件（MP4等）
|
||
- 音频文件（MP3、WAV等）
|
||
- 图片文件
|
||
- PDF文档
|
||
|
||
---
|
||
|
||
## 🗂️ 重要文件路径
|
||
|
||
### 日志和文档
|
||
- **工作日志**: `log/`
|
||
- **AI指南**: `log/1-AI指南.md`
|
||
- **配置清单**: `log/项目配置清单.md` (本文件)
|
||
- **SQL脚本**: `log/*.sql`
|
||
|
||
### 代码目录
|
||
- **后端代码**: `Study-Vue-redis/ry-study-system/src/main/java/com/ddnai/`
|
||
- **Mapper XML**: `Study-Vue-redis/ry-study-system/src/main/resources/mapper/`
|
||
- **前端页面**: `fronted_uniapp/pages/`
|
||
|
||
---
|
||
|
||
## 🔌 外部API接口
|
||
|
||
### 待补充
|
||
> 当发现使用外部API时，在此记录
|
||
|
||
```
|
||
格式示例：
|
||
### API名称
|
||
- **接口地址**: https://api.example.com
|
||
- **API Key**: your-api-key
|
||
- **用途**: 功能描述
|
||
- **文档**: 接口文档地址
|
||
- **添加时间**: 2025-12-12
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 部署环境
|
||
|
||
### 本地开发环境
|
||
- **操作系统**: Windows
|
||
- **Java版本**: (待确认)
|
||
- **Maven版本**: (待确认)
|
||
- **Node.js版本**: (待确认)
|
||
- **MySQL版本**: (待确认)
|
||
|
||
### 生产服务器
|
||
- **操作系统**: Linux
|
||
- **服务器IP**: (待补充)
|
||
- **部署路径**: (待补充)
|
||
- **注意事项**: 本地运行正常，服务器存在环境差异
|
||
|
||
---
|
||
|
||
## ⚙️ 环境变量
|
||
|
||
### 待补充
|
||
> 当配置环境变量时，在此记录
|
||
|
||
```
|
||
格式示例：
|
||
### 变量名称
|
||
- **变量名**: ENV_NAME
|
||
- **值**: value
|
||
- **用途**: 用途说明
|
||
- **设置位置**: .env / application.yml / 系统环境变量
|
||
```
|
||
|
||
---
|
||
|
||
## 📝 配置文件位置
|
||
|
||
### 后端配置
|
||
- `Study-Vue-redis/ry-study-admin/src/main/resources/application.yml`
|
||
- `Study-Vue-redis/ry-study-admin/src/main/resources/application-druid.yml`
|
||
|
||
### 前端配置
|
||
- `fronted_uniapp/manifest.json`
|
||
- `fronted_uniapp/pages.json`
|
||
|
||
---
|
||
|
||
## 🔐 第三方服务
|
||
|
||
### 待补充
|
||
> 当接入第三方服务时，在此记录
|
||
|
||
```
|
||
格式示例：
|
||
### 服务名称
|
||
- **服务商**: 阿里云/腾讯云等
|
||
- **服务类型**: OSS/SMS/邮件等
|
||
- **配置信息**: endpoint、accessKey等
|
||
- **用途**: 功能描述
|
||
- **文档**: 服务文档地址
|
||
```
|
||
|
||
---
|
||
|
||
## 🛠️ 框架配置
|
||
|
||
### MyBatis配置
|
||
- **类型别名包**: `com.ddnai.**.domain`
|
||
- **Mapper扫描**: `classpath*:mapper/**/*Mapper.xml`
|
||
- **配置文件**: `classpath:mybatis/mybatis-config.xml`
|
||
|
||
### PageHelper分页
|
||
- **方言**: MySQL
|
||
- **支持方法参数**: true
|
||
|
||
### Swagger文档
|
||
- **开关**: 已启用（⚠️ 生产环境必须关闭）
|
||
- **访问地址**: `http://localhost:30091/dev-api/swagger-ui.html`
|
||
|
||
---
|
||
|
||
## 📋 端口占用情况
|
||
|
||
| 端口 | 服务名称 | 用途 | 访问地址 |
|
||
|------|---------|------|---------|
|
||
| 3306 | MySQL | 数据库 | `localhost:3306` |
|
||
| 6379 | Redis | 缓存服务 | `localhost:6379` |
|
||
| 30091 | Spring Boot | 后端API | `http://localhost:30091` |
|
||
| 30091 | Druid监控 | 数据库监控 | `http://localhost:30091/druid/` |
|
||
| 5000 | Whisper Server | 语音识别 | `http://localhost:5000` (待确认) |
|
||
|
||
---
|
||
|
||
## 💡 使用说明
|
||
|
||
### 如何添加新配置
|
||
1. 在对应的分类下添加信息
|
||
2. 使用统一的Markdown格式
|
||
3. 注明添加时间和用途
|
||
4. 敏感信息可以使用环境变量替代
|
||
|
||
### 注意事项
|
||
- ⚠️ 不要将真实的密钥和密码提交到Git仓库
|
||
- ⚠️ 生产环境配置要单独管理
|
||
- ⚠️ 定期更新此文档，保持信息准确
|
||
|
||
---
|
||
|
||
*本文件会在开发过程中持续更新*
|