冰鉴InsightNews——α冲刺代码规范、冲刺任务与计划

冰鉴InsightNews 2025-10-30 23:37:19

项目	内容
这个作业属于哪个课程	202501福大-软件工程实践-W班
这个作业要求在哪里	团队作业——站立式会议+α冲刺
这个作业的目标	制定团队代码规范、明确冲刺任务与计划、引入AI技术员协助开发
其他参考文献	《构建之法》、阿里巴巴Java开发手册终极版v1.3.0、华为内部代码规范、Google代码规范

1. 代码规范
1.1 前端 (Android) 技术规范
1.2 前端 (Web) 技术规范
1.3 后端 (Backend) 技术规范
2. 冲刺任务与计划 (Alpha 阶段)
2.1 冲刺任务
后端 (Backend) 冲刺任务
前端 (Android) 冲刺任务
前端 (Web) 冲刺任务
3. AI技术员
3.1 AI 作为“AI 程序员”
3.2 AI 作为“AI 测试员”
3.3 AI 作为“AI 设计师”
3.4 AI 作为“项目助理与文档员”
4. 时间计划
5. 分工计划

1. 代码规范

1.1 前端 (Android) 技术规范

核心架构: 严格遵循 MVVM (ViewModel + LiveData) 模式。
数据持久化:
- 本地数据库: 使用 Room 数据库存储“检测历史” (DetectionRecordEntity)。
- 用户偏好: 使用 SharedPreferences 存储用户认证状态 (AuthRepository) 和用户配置 (UserProfileManager)。
模拟数据: 逻辑实现暂时不发起真实 OkHttp 网络请求。ViewModel 或 Repository 层应直接调用本地 Mock 管理器 (如 TopicManager) 或 Room 数据库获取数据，模拟 API 返回。

1.2 前端 (Web) 技术规范

核心框架: Vue.js (如 Vue 3 + Vite)。
UI 构建: 使用 Vue 单文件组件 (.vue)。
状态管理: 使用 Pinia 或 Vuex 管理全局用户状态（如 Token、用户信息）。
模拟数据: 不进行真实 API 对接。使用 Pinia Store 或本地 mock/data.js 文件模拟用户登录、获取用户信息、更新用户信息等 API 返回，确保前端交互流程完整。

1.3 后端 (Backend) 技术规范

核心框架: Spring Boot 2.6.13。
认证鉴权: 使用 JWT (JwtUtil) 进行Token生成与验证，通过 AuthInterceptor 拦截请求。
数据持久化: 使用 MyBatis Plus 操作 MySQL 数据库。
缓存: 使用 Spring Data Redis 存储热点数据（如验证码、点赞收藏关系、话题热度）。
交付标准: 所有 API 接口必须通过 Postman 等工具完成功能测试，确保逻辑无误。

2. 冲刺任务与计划 (Alpha 阶段)

2.1 冲刺任务

后端 (Backend) 冲刺任务

用户认证模块:
- 实现 /common/code 接口 (调用阿里云 SMS)。
- 实现 /user/register 和 /user/login 接口，完成验证码校验、数据库写入、JWT Token 生成。
个人中心模块:
- 实现 /user/info (获取信息) 和 /user/update (修改信息) 接口。
- 实现 /common/upload 接口 (调用阿里云 OSS)。
核心功能模块 (检测与专题):
- 实现 DetectionController (新闻检测) 和 TopicController (专题互动) 的所有接口。
- 确保 AI 服务 (AIService) 和 Redis 缓存逻辑正确。

前端 (Android) 冲刺任务

认证与个人中心模块:
- 构建 WelcomeActivity, LoginActivity, RegisterActivity 界面。
- 构建 ProfileFragment 和 EditProfileActivity 界面。
- 实现 AuthRepository 和 UserProfileManager，使用 SharedPreferences 模拟登录和资料读写。
核心检测流模块:
- 构建 HomeFragment (检测首页) 和 CredibilityFragment (聊天式检测界面)。
- 构建 HistoryActivity (历史记录页) 和 EnhancedReportActivity (详细报告页)。
- 实现 Room 数据库 (DetectionDao) 逻辑，完成模拟检测 -> 存入 Room -> 读出历史的功能闭环。
专题探究流模块:
- 构建 ExploreFragment (探究真相) 界面，实现分类筛选和列表。
- 构建 DetailTopicActivity (话题详情页)，使用 ViewPager2 搭载 TopicNewsFragment 和 TopicCommentsFragment。
- 实现 TopicManager，加载和提供本地 Mock 话题数据 (新闻、评论) 以填充界面。
收藏模块:
- 构建 TopicCollectionActivity 和 NewsCollectionActivity 界面。
- 实现 TopicCollectionManager，将收藏的话题 ID 存入 SharedPreferences (UserProfileManager)。
- 实现 TopicCommentsFragment 中的本地模拟点赞和评论功能。

前端 (Web) 冲刺任务

项目搭建:
- 使用 Vite 或 Vue CLI 初始化 Vue.js 项目。
- 搭建项目结构 (views, components, store, router)。
- 配置 Pinia (或 Vuex) 进行状态管理。
认证界面:
- 构建 Login.vue (登录页) 和 Register.vue (注册页) 页面组件。
- 实现 authStore (Pinia)，编写 Mock 登录/注册 方法，在 Store 中模拟 Token 的存取。
- 实现前端路由守卫，模拟登录拦截。
用户管理界面:
- 构建 Profile.vue (个人信息展示页) 页面组件。
- 构建 EditProfile.vue (编辑个人资料) 页面组件。
- authStore 中需提供 Mock 的获取用户信息和更新用户信息的方法，确保 Profile.vue 和 EditProfile.vue 之间的数据流（读取和更新）能在本地跑通。

3. AI技术员

我们将 AI 视为一个可以扮演多种角色的助手，通过不同的“驱动指令”来分配任务：

3.1 AI 作为“AI 程序员”

AI 程序员负责生成样板代码、调试、优化和代码解释。

**驱动指令 (Prompt) 示例 (后端)**：

“请为 InsightNews-backend 项目的 TopicController 中 /comment/add/{topicId} 接口生成 Postman 接口测试脚本。”
**驱动指令 (Prompt) 示例 (Android)**：

“请为 EditProfileActivity (Android) 编写一个使用 UserProfileManager 读写 SharedPreferences 的完整 Mock 逻辑。”
**驱动指令 (Prompt) 示例 (Web)**：

“请为 Vue 3 和 Pinia 编写一个 authStore.js，包含 Mock 的 login(user, pass) 和 getUser() 异步 action。”

3.2 AI 作为“AI 测试员”

AI 测试员负责生成测试用例，帮助我们发现逻辑盲点。

**驱动指令 (Prompt) 示例 (Android)**：

“请为 LoginActivity 中的手机号输入框和验证码输入框设计 10 个边缘测试用例（Edge Case）。”
**驱动指令 (Prompt) 示例 (后端)**：

“请为 UserServiceImpl 中的 register 方法编写 JUnit 单元测试，重点 Mock Redis 验证码校验失败的场景。”

3.3 AI 作为“AI 设计师”

AI 设计师负责提供 UI 布局建议、UX 流程优化和视觉元素参考。

**驱动指令 (Prompt) 示例 (Android)**：

“请分析 fragment_profile.xml 的布局。请提供 3 种优化建议，使其布局更现代、更具呼吸感。”
**驱动指令 (Prompt) 示例 (Web)**：

“我需要为 Web 端的‘用户管理’界面设计 UI，请提供一个包含‘修改头像’、‘昵称’、‘简介’的 Vue 组件代码示例，要求使用 Ant Design Vue 风格。”

3.4 AI 作为“项目助理与文档员”

AI 助理负责分析项目、制定计划和撰写文档，本文（即您正在阅读的这篇随笔）就是 AI 协助的直接产物。

**驱动指令 (Prompt) 示例 (本项目)**：

“请你理解我们的项目实现，按照博客格式进行排版...”

4. 时间计划

日期	主要任务	后端 (袁昊)	前端 (蒋嘉会, 郭昀琪)	Web端 (胡喆昶)
Day 1-2	架构与认证	1. 完成用户认证 (Auth) 与 JWT 逻辑。 2. 实现 `UserController` (登录/注册/信息)。 3. 跑通阿里云 SMS。	1. 搭建 `auth`, `profile` 模块 UI。 2. 实现 `AuthRepository` 和 `UserProfileManager` (本地 SP 读写)。	1. 搭建 Vue + Pinia 项目。 2. 构建 `Login.vue` 和 `Register.vue` 界面。 3. 实现 Mock Auth Store (Pinia)。
Day 3-4	核心检测功能	1. 实现 `DetectionController` (上传/历史)。 2. 对接 `AIService` (Langchain4j)。 3. 确保检测结果能存入数据库。	1. 搭建 `credibility` 和 `history` 模块 UI。 2. 实现 Room 数据库 (`DetectionDao`) 闭环。	1. 构建 `Profile.vue` 界面 (读取 Mock Store)。 2. 构建 `EditProfile.vue` 界面 (表单)。
Day 5-6	专题探究功能	1. 实现 `TopicController` (列表/详情/搜索)。 2. 实现评论与点赞 (`/comment/*`)。 3. 确保 Redis 缓存正常工作。	1. 搭建 `explore` 和 `detail` 模块 UI (ViewPager)。 2. 实现 `TopicManager` (加载 Mock 数据)。 3. 搭建收藏页面及本地逻辑。	1. 实现 `EditProfile.vue` 中更新 Mock Store 的逻辑。 2. 完善登录 -> 查看信息 -> 编辑信息 -> 登出的完整 Mock 流程。
Day 7	独立验收	1. 使用 Postman 完整测试所有 API 接口，确保逻辑正确。	1. 在模拟器上运行 App，确保所有页面导航流畅，Mock 数据和本地 Room 数据显示正确。	1. 本地运行 Web App，确保用户管理（登录、注册、资料修改）的 Mock 流程完整。

5. 分工计划

角色	姓名 & 学号	Alpha 冲刺任务
后端 (Backend)	102300433 袁昊	负责 `InsightNews-backend` 的全部 Alpha 任务： 1. 实现所有 Controller (User, Topic, Detection)。 2. 实现所有 Service (含 AI, SMS, OSS)。 3. 确保 API 逻辑通过 Postman 测试。
前端 (Android) A	102300316 蒋嘉会	负责 `InsightNewsAndroid-frontend`： 1. 认证与个人中心 (Auth, Profile, EditProfile)。 2. 核心检测流 (Home, Credibility, History, Room DB)。
前端 (Android) B	102300203 郭昀琪	负责 `InsightNewsAndroid-frontend`： 1. 专题探究流 (Explore, Detail, ViewPager, Mock Data)。 2. 收藏与互动 (News/Topic Collection, Comments UI)。
前端 (Web)	102300430 胡喆昶	负责 Web 端用户管理的独立开发： 1. 搭建 Vue + Pinia 项目。 2. 构建认证 (Login/Register) 和资料 (Profile/Edit) 的 UI 组件。 3. 使用 Pinia Store 跑通 Mock 数据下的用户管理全流程。