发际线总和我作队——代码规范、冲刺任务与计划

[发际线总和我作队]

这个作业属于哪个课程	2501_CS_SE_FZU
这个作业要求在哪里	团队作业——站立式会议+α冲刺
这个作业的目标	明确团队的代码规范、本次冲刺任务与计划
其他参考文献	《阿里巴巴Java开发手册终极版v1.3.0》

目录

• 1 冲刺任务与计划
• 1.1 冲刺任务
• 1.2 冲刺计划
• 2 代码规范
• 2.1 命名规范
• 2.2 异常处理规范
• 2.3 注释规范
• 2.4 控制器规范
• 2.5 数据库操作规范
• 2.6 其他规范
• 3 AI技术员

1 冲刺任务与计划

1.1 冲刺任务

我们的最终目标是完成一个具备学生选课、教师成绩管理、管理员后台管理三大核心功能的“选课管理系统”Web应用。系统应具备完整的登录认证、角色权限控制、数据增删改查能力，并达到可演示、可验收的水平。而在这6天的计划中，我们计划完成系统中的一部分功能。

具体任务
我们是一个5人小组，其中2人负责前端，2人负责后端，1人负责测试

1、学生端所有页面、选课/退课交互、课表与成绩展示。
2、管理员端所有页面、数据管理（CRUD）界面。
3、用户认证、学生业务逻辑（选课、课表、成绩查询）。
4、管理员业务逻辑（用户/课程管理）。
5、制定测试计划、编写测试用例、执行功能/接口测试。

1.2 冲刺计划

日期	后端A	后端B	前端A	前端B	测试
Day1	初始化Spring Boot项目，配置MyBatis、MySQL连接、Redis	编写基础实体类	初始化Vue3项目，配置Element Plus、Vue Router、Axios，搭建登录页面框架	搭建管理员、学生、教师基础布局，设计统一导航栏和侧边栏组件	计划测试，准备接口测试工具（如Postman），编写登录模块测试用例
Day2	实现用户登录接口（含密码加密），实现JWT token生成与校验	实现角色权限拦截器，编写用户信息查询接口	完成登录页面交互，实现根据角色跳转	实现学生/教师/管理员主页框架，开发个人信息页面	测试登录接口，验证权限控制是否生效
Day3	实现选课/退课接口	实现课程列表查询接口	学生选课页面（课程列表、搜索）	选课/退课交互	验证选课操作是否正确
Day4	实现成绩查询接口	实现课表生成接口	学生课表页面	成绩查询页面	验证课表与成绩查询是否正确
Day5	实现管理员对用户/课程的CRUD接口	实现院系、专业、班级管理接口	课程管理页面	管理员用户管理页面（增删改查）	测试成绩录入与计算逻辑，测试管理员操作权限
Day6	配合前端调试接口，修复接口逻辑错误	配合前端调试接口，优化数据库查询性能	联调学生模块所有页面，修复前端交互问题	联调管理模块页面，优化页面响应与提示	执行全流程测试，提交Bug清单并跟踪修复

2 代码规范

2.1 命名规范

类名：使用大驼峰命名法（UpperCamelCase）
方法名：使用小驼峰命名法（lowerCamelCase）
变量名：使用小驼峰命名法（lowerCamelCase）
常量名：全部大写，单词间用下划线隔开
包名：全部小写
杜绝完全不规范的缩写

2.2 异常处理规范

使用自定义异常
统一异常处理，返回明确的错误码和消息
在Service层进行业务校验和异常抛出

2.3 注释规范

每个类都有类级别的文档注释
方法都有方法功能的简要说明
使用JavaDoc格式的注释
关键业务逻辑有行内注释

2.4 控制器规范

使用 @RestController 注解
统一的URL前缀 @RequestMapping
明确的HTTP方法注解（@GetMapping、@PostMapping等）
使用 @PathVariable 和 @RequestBody 注解

2.5 数据库操作规范

在Mapper接口中定义数据访问方法
使用MyBatis注解或XML配置
方法命名体现操作意图

2.6 其他规范

使用合适的访问修饰符（public、private）
字段封装，使用getter/setter方法
保持方法单一职责
适当的空行分隔代码块，提高可读性

3 AI技术员

使用AI辅助前端成员初步编写页面结构，前端成员进行调整组件位置，添加组件、点击事件，细化页面等工作。