| 这个作业属于哪个课程 | 班级的链接 |
|---|---|
| 这个作业要求在哪里 | 作业要求的链接 |
| 这个作业的目标 | 制定好计划，清楚把握敏捷模型的流程 |
| 小组的组号和队名 | 组号：3 队名：合理 |
| 小组的队长姓名 | 何磊 |
冲刺的时间计划安排
| 开始时间 | 结束时间 | 天数 | 事件 |
|---|---|---|---|
| 6/1 | 6/2 | 一天 | 改进团队分工 |
| 6/2 | 6/4 | 两天 | 学习需要使用的技术 |
| 6/4 | 6/5 | 一天 | 落实数据库 |
| 6/5 | 6/8 | 三天 | 编写前端界面 |
| 6/8 | 6/11 | 三天 | 编写后端逻辑代码 |
| 6/11 | 6/12 | 一天 | 测试各种数据 |
| 6/12 | 6/133 | 一天 | 制作PPT，准备答辩 |
针对前几次作业的不足的地方进行思考和总结
1.软件需求规格说明书中的功能需求不具体，不完善，没能清楚的描述每一个功能的具体需求，原型图能很好的表达软件的功能需求，应制作必要的原型图，采用图文结合的方式表述软件功能需求。
2.软件需求规格说明书中的验收验证标准未给出，随着软件开发进程的推进，应对此项进行补充。
3.有些UML图是以前的，随着软件需求的变化，UML图并没有更新。
需要改进的团队分工
| 模块 | 前端 | 后端 |
|---|---|---|
| 登录注册模块 | 何磊 | 李代传 |
| 搜索模块 | 何磊 | 李代传 |
| 主页模块 | 何磊 | 李代传 |
| 发布任务模块 | 何磊 | 李代传 |
| 聊天模块 | 何磊 | 李代传 |
团队的代码规范
一、命名风格
【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：name / name / $name / name / name$ / name
【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。国际通用的名称，可视同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
【强制】杜绝完全不规范的缩写，避免望文不知义。
反例：AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随 意缩写严重降低了代码的可阅读性。
【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。
反例：变量 int a 的随意命名方式。
二、代码格式
【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
【强制】采用 4 个空格缩进，禁止使用 tab 字符。
【推荐】每一个文件不能超过300行代码，最好不超过200行；
【推荐】每一个方法不能超过30行代码；
三、注释规约
【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/* */注释，注意与代码对齐。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
说明：代码被注释掉有两种可能性：
后续会恢复此段代码逻辑。
永久不用。
前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
| 使用了阿里巴巴编程规约插件，代码风格等同于阿里巴巴编程风格。 |
|---|
| (一) 命名规约 |
| 1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 |
| 反例： _name / _name / $Object / name / name$ / Object$ |
| 2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 |
| 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。 注意，即使纯拼音命名方式也要避免采用。 |
| 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int某变量 = 3 |
| 正例： alibaba / taobao / youku / hangzhou等国际通用的名称，可视同英文。 |
| 3.【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。 |
| 正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion |
| 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion |
| 4.【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。 |
| 正例： localValue / getHttpMessage() / inputUserId |
| 5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 |
| 正例： MAX_STOCK_COUNT |
| 反例： MAX_COUNT |
| 6.【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。 |
| 7.【强制】中括号是数组类型的一部分，数组定义如下：String[] args; |
| 反例：请勿使用String args[]的方式来定义。 |
| 8.【强制】POJO类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。 |
| 反例：定义为基本数据类型boolean isSuccess；的属性， |
| 它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异 |
| 常。 |
| 9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。 |
| 正例：应用工具类包名为com.alibaba.open.util、类名为MessageUtils（此规则参考spring的框架结构） |
| 10.【强制】杜绝完全不规范的缩写，避免望文不知义。 |
| 反例： AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。 |
| 11.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。 |
| 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 |
| 正例：public class OrderFactory; |
| public class LoginProxy; |
| public class ResourceObserver; |
| 12.【推荐】接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。 |
| 正例：接口方法签名：void f(); |
| 接口基础常量表示：String COMPANY = "alibaba"; |
| 反例：接口方法定义：public abstract void f(); |
| 说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。 |
| 13.接口和实现类的命名有两套规则： |
| 【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。 |
| 正例：CacheServiceImpl实现CacheService接口。 |
| 【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。 |
| 正例：AbstractTranslator实现 Translatable。 |
| 14.【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。 |
| 说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。 |
| 正例：枚举名字：DealStatusEnum，成员名称：SUCCESS / UNKNOWN_REASON。 |
| 15.【参考】各层命名规约： |
| ####Service/DAO层方法命名规约 |
| 获取单个对象的方法用get做前缀。 |
| 获取多个对象的方法用list做前缀。 |
| 获取统计值的方法用count做前缀。 |
| 插入的方法用save（推荐）或insert做前缀。 |
| 删除的方法用remove（推荐）或delete做前缀。 |
| 修改的方法用update做前缀。 |
| ####领域模型命名规约 |
| 数据对象：xxxDO，xxx即为数据表名。 |
| 数据传输对象：xxxDTO，xxx为业务领域相关的名称。 |
| 展示对象：xxxVO，xxx一般为网页名称。 |
| POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。 |
