报备契约队文件 β冲刺代码规范

[报备契约队]

项目	内容
这个作业属于哪个课程	202501 福大-软件工程实践-w 班
这个作业要求在哪里	团队作业—bate冲刺
这个作业的目标	完成β冲刺

目录

• 报备契约队
• 组长 王胤杰
• 一、团队代码规范
• 二、命名规范
• 三、代码风格规范
• 四、安全与异常处理
• 五、分层开发准则

---

报备契约队

组长 王胤杰

---

一、团队代码规范

团队代码规范基于 《阿里巴巴Java开发手册（终极版v1.3.0）》 与 华为内部代码规范 的核心思想，结合项目实际情况进行约定。

二、命名规范

1.包名：采用语义化全小写组合，遵循项目域名反转的层级结构，避免无意义缩写
2.类名：使用大驼峰命名，按功能模块添加区分后缀，体现类的核心用途
3.方法 / 变量名：小驼峰命名，方法以动作动词开头，变量名需准确表达数据含义，禁止单字母命名（循环临时变量除外）
4.常量名：全大写格式，多单词用下划线分隔，确保语义直观无歧义

三、代码风格规范

1.单个函数代码行数控制在 80 行内，避免逻辑过度嵌套或冗余
2.统一使用 4 个空格缩进，禁止混合使用 Tab 与空格，保持编辑器间格式一致
3.关键业务逻辑、复杂判断前需加注释，说明设计思路与核心作用
4.禁止硬编码数值或字符串，需定义为常量并标注含义
5.遵循单一职责原则，接口与类仅聚焦单一功能，避免职责混杂

四、安全与异常处理

1.所有外部输入（含表单、接口参数、文件）需做合法性校验，过滤无效或恶意数据
2.异常捕获后需记录完整日志（含异常类型、上下文信息），禁止直接忽略或吞掉异常
3.数据库操作需启用事务管理，保障多表交互时的数据一致性
4.用户敏感信息（如密码、隐私数据）需加密存储，返回前端时需做脱敏处理

五、分层开发准则

1.控制器层：仅负责请求接收、参数初步校验与响应封装，业务逻辑委托服务层处理
2.服务层：封装核心业务逻辑，接口与实现类分离，多表操作或数据修改需添加事务控制
3.数据层：优先使用 ORM 框架通用方法，复杂查询通过框架提供的条件构造器实现，避免手写 SQL
4.通用组件：基础控制器仅保留全局响应方法，响应类统一返回格式，数据传输对象仅用于层间数据交互