CRL Team —— 代码规范、冲刺任务与计划

[CRLTeam]

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

目录

• 一、代码规范
• 1. 通用规范
• 1.1 命名原则
• 1.2 注释要求
• 1.3 版本控制
• 2. Java后端规范（参考阿里巴巴Java开发手册）
• 2.1 命名规范
• 2.2 代码格式
• 2.3 集合与数组
• 2.4 异常处理
• 2.5 数据库操作
• 3. Vue 前端规范（参考华为前端规范及 Vue 官方风格指南）
• 3.1 命名规范
• 3.2 组件设计
• 3.3 模板与样式
• 4. 规范执行与监督
• 二、冲刺任务
• 1.核心功能迭代优化
• 2.AI功能深度升级
• 三、冲刺计划
• 1. 人员安排（7人团队，贴合文档功能模块，融入AI技术辅助）
• 2. 时间安排
• 3. 工作地点与时间

一、代码规范

1. 通用规范

1.1 命名原则

• 可读性优先：命名需清晰表达含义，避免缩写（公认缩写如URL、DTO除外）。
• 一致性：同类型元素命名风格统一（如后端接口统一前缀、前端组件统一后缀）。
• 避免关键字：不使用编程语言或框架的保留字（如class、function）。

1.2 注释要求

• 必须注释：公共接口、核心算法、复杂逻辑、异常处理需详细注释。
• 注释格式：使用工具规范（Java用/** */，Vue用/** */或//），注释与代码同步更新。
• 禁用冗余注释：避免对显而易见的代码（如i++）加注释。

1.3 版本控制

• 分支命名：feature/功能名（新功能）、fix/问题描述（修复）、release/版本号（发布）。
• 提交信息：格式为[类型] 描述（如[feat] 新增用户登录接口、[fix] 修复订单计算bug）。
• 代码提交：每次提交聚焦单一功能或修复，避免大篇幅混合修改。

2. Java后端规范（参考阿里巴巴Java开发手册）

2.1 命名规范

• 类名：使用UpperCamelCase（帕斯卡命名法），如UserController、OrderService。
• 方法名/参数名/变量名：使用lowerCamelCase（驼峰命名法），如getUserById、orderAmount。
• 常量：全大写+下划线分隔，如MAX_RETRY_COUNT、ORDER_STATUS_PAID。
• 包名：全小写，使用域名反转+模块名，如com.team.project.user.controller。

2.2 代码格式

• 缩进：4个空格（禁用Tab），一行代码不超过120字符（过长需换行）。
• 括号：{ 不单独换行，如：
  ```java
  if (condition) { // 正确
  // 逻辑
  }
  空行：方法间空一行，逻辑块间空一行，避免连续空行。

2.3 集合与数组

• 初始化指定容量：如List userList = new ArrayList<>(10);（避免频繁扩容）。
• 禁用ArrayList的subList：其返回的是视图，可能导致内存泄漏。
• 集合遍历：优先使用增强 for 循环，避免在循环中调用size()方法：
  for (User user : userList) { ... } // 正确

2.4 异常处理

• 不捕获Exception基类：需精确捕获具体异常（如NullPointerException）。
• 异常信息：需包含上下文（如"用户ID: " + userId + " 不存在"），禁止空异常（catch (Exception e) {}）。
• 自定义异常：业务异常需继承RuntimeException，并包含错误码和描述。

2.5 数据库操作

• SQL 命名：SELECT语句变量名前缀query，UPDATE前缀update，如queryUserById。
• 分页查询：必须包含limit和offset，避免全表扫描。
• 事务：非查询操作（增删改）需加事务注解@Transactional，明确rollbackFor。

3. Vue 前端规范（参考华为前端规范及 Vue 官方风格指南）

3.1 命名规范

• 组：
  全局组件：PascalCase（如UserForm），并注册在components目录。
  单文件组件（SFC）：文件名与组件名一致（如UserForm.vue）。
  局部组件：kebab-case（如user-list）。
• 变量 / 方法：camelCase（如userInfo、handleSubmit）。
• 常量：UPPER_SNAKE_CASE（如const MAX_UPLOAD_SIZE = 10 * 1024 * 1024;）。
• CSS 类名：kebab-case（如.user-avatar），避免使用id选择器。

3.2 组件设计

• 拆分原则：单个组件代码不超过 300 行，功能单一（如UserForm只处理表单，UserList只处理列表）。
• Props 规范：
  定义时指定类型和默认值：
  vue
  props: {
  userId: {
  type: Number,
  required: true,
  validator: (value) => value > 0 // 自定义校验
  }
  }
  避免直接修改props，通过$emit通知父组件更新。
• 状态管理：
  全局状态（如用户信息）用 Vuex/Pinia，局部状态用组件data。
  Vuex/Pinia 中，state只通过mutation/action修改，禁止直接赋值。

3.3 模板与样式

• 模板缩进：2 个空格，标签属性换行（超过 2 个属性时）：
  vue
  <el-button
  type="primary"
  size="small"
  @click="handleSave"
  保存 样式作用域：组件内样式需加scoped，避免全局污染： vue 避免v-if与v-for同用：如需使用，v-for优先级更高（或用计算属性过滤）。 #### 3.4 性能优化
• 列表渲染：必须加key（且唯一），如v-for="item in list" :key="item.id"。
• 事件解绑：组件销毁前解绑自定义事件（如window.scroll），避免内存泄漏。
• 图片优化：使用懒加载（v-lazy），指定width和height避免布局偏移。

4. 规范执行与监督

• 工具强制约束：
  后端：使用CheckStyle插件（规则基于阿里巴巴手册），IDE 配置自动格式化。
  前端：使用ESLint + Prettier，配置vue-eslint-config，提交前自动校验。
• 代码审查：
  提交 PR/MR 时，需至少 1 名团队成员审查，重点检查规范符合性。
  审查不通过的代码需修改后重新提交。
• 定期更新：每季度根据团队反馈和技术演进更新规范，同步至所有成员。

  二、冲刺任务

1.核心功能迭代优化

• 学习社区模块升级：新增帖子分页加载功能（解决文档黑盒测试中“数据过多卡顿”问题），支持按“热度/时间/标签”多维度排序；优化帖子发布编辑器，增加“草稿保存”与“图文预览”功能，提升内容创作流畅性{insert_element_0_}。
• 学习计划模块完善：新增学科分类（如“英语/数学/计算机”），支持用户自定义分类标签（响应文档测试反馈“建议新增计划分类”需求）；优化智能提醒机制，除邮件提醒外，新增“平台内弹窗+浏览器通知”双渠道提醒，降低计划遗漏率{insert_element_1_}。
• 文件管理模块体验优化：添加文件上传进度条（解决文档测试反馈“文件上传时无进度条提示”问题），支持断点续传；优化错题文件预览功能，支持PDF错题标注（如“高亮错误点”“添加笔记”），提升错题整理效率{insert_element_2_}。

2.AI功能深度升级

• AI错题分析能力强化：优化AI解析逻辑，提升知识点归因准确率（目标从文档测试中95%提升至98%）；新增“错题举一反三”功能，基于用户错题自动推荐3道同类练习题，强化薄弱知识点巩固{insert_element_3_}。
• 学习计划AI生成优化：接入学习知识图谱（参考文档后续升级计划），结合用户历史错题、学习进度数据，生成“知识点关联型学习计划”（如“先补‘微积分极限’，再学‘导数应用’”），而非单一任务罗列{insert_element_4_}。
• 学习社区AI推荐迭代：优化自适应神经网络算法，增加“用户互动行为权重”（如“点赞/收藏/评论过的帖子类型”），提升推荐帖子与用户兴趣的匹配度；新增“AI帖子摘要”功能，自动提取长帖核心观点，帮助用户快速筛选有效信息{insert_element_5_}。

三、冲刺计划

1. 人员安排（7人团队，贴合文档功能模块，融入AI技术辅助）

团队成员	负责领域	具体职责（基于《中国大学生计算机设计大赛软件开发类作品设计和开发文档.pdf》）	AI技术应用场景（驱动AI帮助完成任务）
张铭鑫	前端开发	1. 实现学习社区分页功能（含多维度排序）、帖子发布编辑器“草稿保存/图文预览”功能，适配文档3.1.3学习社区界面设计规范；2. 对接“AI帖子摘要”前端展示界面，确保交互流畅。	1. 用Vue AI代码插件（如Vue AI Code Helper）自动生成分页组件核心逻辑（如分页查询、页码切换），减少重复编码；2. 用AI兼容性工具（如Can I Use AI查询）验证功能在Chrome 122.0+/Edge 120.0+浏览器中正常显示。
陈宗冉	前端开发	1. 实现文件上传进度条、断点续传功能，优化错题文件预览界面的PDF标注交互；2. 对接“AI错题分析结果页”与“AI学习计划推荐卡片”界面，保持与界面风格统一。	1. 用Figma AI插件生成进度条动态效果原型，快速对齐邱毅伟的UI设计；2. 用AI调试工具（如Vue DevTools AI插件）自动定位前端与AI算法接口联调中的数据渲染问题。
应国浩	后端开发	1. 开发学习社区帖子分页接口、多维度排序接口，遵循技术架构（Spring Boot三层架构：Controller→Service→DAO）；2. 优化AI错题分析接口，利用Redis缓存高频错题解析结果，减少重复调用。	1. 用AI代码生成工具（如CodeGeeX）根据数据库设计（community_post表、file_meta表）生成SQL查询语句与DAO层代码；2. 用AI代码审查工具（如SonarQube AI）检测接口异常处理逻辑，确保符合性能要求（响应时间≤10秒）。
郑炜豪	后端开发	1. 开发学习计划学科分类接口、双渠道提醒接口（邮件+弹窗），集成RabbitMQ实现异步邮件通知；2. 对接学习知识图谱与ElasticSearch（数据存储方案），实现AI知识点关联计划生成逻辑。	1. 用AI脚本工具生成RabbitMQ异步通知代码，快速实现学习计划提醒功能；2. 用AI性能分析工具（如JProfiler AI插件）优化AI计划生成接口，确保响应时间≤5秒（符合性能测试标准）。
邱毅伟	UI设计	1. 设计学习社区分页界面、文件上传进度条、AI功能界面（错题分析结果页、计划推荐卡片），贴合“简洁易用”的人机界面要求；2. 输出界面设计规范与切图资源，适配不同浏览器显示。	1. 用MidJourney生成AI功能界面灵感图，结合文档3.1节界面示例优化布局；2. 用AI色彩搭配工具验证界面配色对比度，确保符合无障碍设计标准，提升用户体验。
都正宇	测试	1. 设计核心功能测试用例，覆盖测试范围（学习社区、学习计划、文件管理模块）；2. 执行性能测试（如并发访问、接口响应时间），重点验证前端功能正确性与后端接口稳定性。	1. 用Selenium AI插件编写自动化测试脚本，批量验证帖子分页、文件上传等功能；2. 用AI数据分析工具（如Tableau AI插件）整理性能测试数据，生成可视化报告。
许晓镔	测试	1. 设计AI功能专项测试用例（如“AI错题解析准确率测试”“AI推荐相关性测试”），覆盖AI核心功能场景；2. 执行黑盒测试，收集用户使用反馈，验证AI功能体验是否符合升级预期。	1. 用AI测试用例生成工具根据AI功能描述生成测试用例，批量输入100道不同学科错题验证解析准确率；2. 用AI反馈分析工具整理黑盒测试中的用户建议，输出AI功能优化方向（如“错题解析文字排版优化”）。

2. 时间安排

时间节点	核心任务	交付物
第1天	1. 拆解需求（聚焦学习社区分页、文件上传优化、AI功能迭代），明确各成员任务；2. 邱毅伟输出UI设计初稿（分页界面、进度条、AI功能界面）；3. 应国浩/郑炜豪搭建AI接口开发环境（ Spring Boot三层架构）。	1. 任务分配清单；2. UI设计初稿（Figma文件）；3. AI接口开发环境部署文档。
第2-3天	1. 张铭鑫/陈宗冉并行开发前端核心功能（学习社区分页、文件上传进度条）；2. 应国浩/郑炜豪开发后端接口（分页接口、学科分类接口、AI错题分析缓存接口，数据存储方案）；3. 都正宇/许晓镔同步编写测试用例（含AI专项用例）。	1. 前端核心功能代码（Git提交记录）；2. 后端接口文档（含AI接口）；3. 测试用例文档。
第4天	1. 张铭鑫/陈宗冉对接AI功能前端界面（错题分析结果页、计划推荐卡片）；2. 应国浩/郑炜豪联调AI接口与知识图谱；3. 邱毅伟优化UI设计并输出切图；4. 都正宇/许晓镔启动首轮测试（含功能与AI性能测试）。	1. AI功能前端界面代码；2. AI接口联调报告；3. UI切图资源；4. 首轮测试问题清单。
第5天	1. 各成员集中修复测试问题（如AI推荐偏差、分页加载异常）；2. 都正宇/许晓镔执行回归测试，重点验证AI错题解析准确率（目标达98%）与接口响应时间（≤5秒）。	1. Bug修复代码（Git提交记录）；2. 回归测试报告（含AI功能测试结果）。
第6天	1. 全员验收功能；2. 召开冲刺复盘会议，总结AI辅助开发经验与问题解决思路。	1. 测试、冲刺总结报告；2. 答辩PPT

3. 工作地点与时间

• 工作地点：1. 线下：团队固定办公区（宿舍或者紫荆园）；2. 线上：腾讯会议（每日短会）
• 工作时间：1. 日常开发：9:00-12:00、14:00-18:00（没课时间）；2. 每日站立式会议：9:00-9:30（同步进度、解决阻塞问题）