doc: modify README.md

This commit is contained in:
seahi 2024-12-18 09:01:34 +08:00
parent 669522ba58
commit 5b51b8a151

View File

@ -4,6 +4,7 @@
## 项目结构
```
AbsenceManager/
├── src/ # 源代码目录
│ ├── dao/ # 数据访问层
@ -16,6 +17,7 @@ AbsenceManager/
├── sql/ # 数据库相关文件
│ └── init.sql # 数据库初始化脚本
└── README.md # 项目说明文档
```
## 技术栈
@ -63,63 +65,3 @@ AbsenceManager/
- JDK 8 或更高版本
- MySQL 5.7 或更高版本
- IDE推荐使用IntelliJ IDEA
## 任务步骤
## Day 1 - 项目框架搭建
### 任务步骤
1. 项目初始化
- 创建Java项目
- 建立项目目录结构src, lib, sql等参考“项目结构”部分
- 导入必要的第三方库mysql-connector-java.jar
2. 数据库配置
- 创建MySQL数据库absence_manager
- 运行sql/init.sql脚本创建表结构
- 配置数据库连接src/util/DatabaseUtil.java
3. 实现学生实体类model/Student.java
```java
public class Student {
private int id; // 数据库主键ID
private String studentId; // 学号
private String name; // 学生姓名
private String className; // 班级
private String contact; // 联系方式
private String college; // 学院
private String major; // 专业
private String password; // 登录密码
// 构造方法
// getter和setter方法
}
```
4. 测试运行
- 测试数据库连接
- 确保项目能够正常编译运行
### 完成标准
- [ ] 项目结构完整,包含所有必要的目录
- [ ] 成功导入所需的第三方库
- [ ] 数据库表结构创建完成
- [ ] 数据库连接配置正确
- [ ] Student类实现完整包含所有必要的属性和方法
- [ ] 项目可以正常编译运行
### 注意事项
1. 建立项目时注意包结构的规范性
2. 数据库字符集使用utf8mb4避免中文乱码
3. 代码编写要规范,加上必要的注释
4. 提交代码前进行本地测试,确保无编译错误
### 参考代码
![](https://static.seahi.me/2024/12/202412171225346.png)
![](https://static.seahi.me/2024/12/202412171226194.png)