摸鱼事务所——α冲刺代码规范、冲刺任务与计划

102300426陈炜滨 2025-10-30 00:07:43

摸鱼事务所——α冲刺代码规范、冲刺任务与计划

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

摸鱼事务所——α冲刺代码规范、冲刺任务与计划
1. 代码规范
1.1 前端代码规范
1.1.1 项目结构
1.1.2 组件规范
1.1.3 状态管理
1.1.4 路由配置
1.1.5 代码风格
1.1.6 其他最佳实践
1.1.7 版本控制
1.2 后端代码规范
1.2.1 命名规范
1.2.2 代码格式
1.2.3 编码规范
2. 冲刺任务与计划
2.1 冲刺任务
登录/注册模块
卫生任务管理模块
同舍沟通管理模块
积分与勋章模块
2.2 时间计划
2.3 分工计划

1. 代码规范

1.1 前端代码规范

1.1.1 项目结构

src/
├── components/          # 公共组件
│   ├── common/         # 通用组件
│   └── business/       # 业务组件
├── views/              # 页面组件
├── router/             # 路由配置
├── store/              # 状态管理
├── utils/              # 工具函数
├── assets/             # 静态资源
├── styles/             # 全局样式
├── api/                # API接口
└── constants/          # 常量定义

1.1.2 组件规范

组件采用PascalCase命名，如UserLogin.vue
组件必须包含明确的props验证和文档注释
遵循单一职责原则，每个组件只负责一个特定功能

1.1.3 状态管理

使用Vuex/Pinia进行状态管理
状态变更必须通过mutation/action
模块化状态管理，按功能拆分store

1.1.4 路由配置

// 路由懒加载，提高首屏加载速度
const routes = [
  {
    path: '/login',
    name: 'Login',
    component: () => import('@/views/Login.vue')
  }
]

1.1.5 代码风格

使用ESLint + Prettier统一代码格式
缩进使用2个空格
字符串使用单引号
每行代码不超过100字符

1.1.6 其他最佳实践

使用TypeScript增强类型安全
组件样式使用Scoped CSS
合理使用异步组件和代码分割

1.1.7 版本控制

提交信息遵循Conventional Commits规范
功能分支命名：feature/功能描述
修复分支命名：fix/问题描述

1.2 后端代码规范

1.2.1 命名规范

类名使用PascalCase：UserService
方法名使用camelCase：getUserInfo
常量使用UPPER_SNAKE_CASE：MAX_LOGIN_ATTEMPTS
包名使用全小写：com.dormitory.service

1.2.2 代码格式

// 遵循阿里巴巴Java开发手册
public class UserServiceImpl implements UserService {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserServiceImpl.class);
    
    @Override
    public UserDTO getUserById(Long userId) {
        // 方法体不超过50行
        if (userId == null) {
            throw new IllegalArgumentException("用户ID不能为空");
        }
        return userMapper.selectById(userId);
    }
}

1.2.3 编码规范

所有Controller必须添加@RestController和@RequestMapping
Service层接口与实现分离
数据库操作必须使用MyBatis Plus
统一异常处理，使用全局异常处理器

2. 冲刺任务与计划

2.1 冲刺任务

登录/注册模块

手机号验证登录
微信/QQ第三方登录
用户注册与信息完善
登录状态保持与token管理

卫生任务管理模块

值日排班算法实现
值日任务分配与提醒
卫生检查评分系统
值日历史记录查询

同舍沟通管理模块

宿舍群聊功能
实时消息发送与接收
@成员提醒功能
群公告发布与管理

积分与勋章模块

个人积分计算与显示
积分排行榜
勋章获取与展示系统
积分变动记录

2.2 时间计划

日期	主要任务	负责人	完成标准
10.29	登录/注册模块开发	前端A、后端A	完成登录注册功能联调
10.30	卫生任务管理模块	前端B、后端B	完成值日排班功能
10.31	同舍沟通模块 + 第一阶段测试	全体成员	完成群聊基础功能，进行集成测试
11.1	积分勋章模块开发	数据库、前端A	完成积分计算与展示
11.2	功能优化与整合	全体成员	各模块联调，界面优化
11.3	系统测试与部署	测试员、AI技术员	完成系统测试，部署到服务器

2.3 分工计划

学号姓名	任务
042301118赵俊强	前端开发A：登录/注册模块、积分勋章模块界面，辅助前端B完成任务
102300106陈思焓	前端开发B：卫生管理模块、消息沟通模块界面，辅助前端A完成任务
102300425郭育铭	后端开发A：用户认证接口、积分系统接口，辅助后端B完成任务
102300110尹肇兴	后端开发B：卫生管理接口、消息沟通接口，辅助后端A完成任务
102300103刘子祎	数据库开发：数据库设计、SQL优化、Redis缓存
102300426陈炜滨	AI技术员：利用AI工具辅助开发、代码优化
102300123鲁申如	测试员：编写测试用例、进行系统测试
102300125林浩宇	博客撰写员：记录开发过程、撰写技术文档