团队作业第二周
团队作业第二周
——油条只要半根
需求规格说明书
- 上次的《需求规格说明书》初稿有哪些不足？
- 上周是小组作业开始的第一周，我们对项目的理解还不够充分，大家的思路也没有能够很好地整理出来，所以写出来的《需求规格说明书》也有很多的不足。
像是格式不对，没有和码云或GitHub链接上，只是用简单的话说明了我们要开发的这个项目所要实现的功能和一些约束。 - 本周对《需求规格说明书》做出的修改：
- 1.《需求规格说明书》按要求实现了Markdown格式的编写
Markdown格式
2.本周的《需求规格说明书》更加的完善，绘制了我们所要完成APP的功能介绍图。
3.参考其他标准的《需求规格说明书》，描写了具体用户的使用场景和用户需求分析
码出高效——小组代码规范
编程规约
一.命名风格
- 1.代码中的命名不能以下划线、美元符号开头或结尾。
反例：_name/$name/name&/name_
- 2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式
也要避免采用。
正例：name/age/address等国际通用的可以使用。
反例：mingzi/getNiJi()/dizhi等不可使用。
- 3.【强制】类名使用 UpperCamelCase 风格，即首字母大写。
正例：MyBase/ViewPager/ViewPagerAdpter
反例：mybaseiewpageriewpageradpter
- 4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从
驼峰形式。
正例：myBase/getMessage()iewPager\
- 5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
- 6.【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类
命名以它要测试的类的名称开始，以 Test 结尾。
正例：AbstractAnimals/NotfoundException
- 【强制】类型与中括号紧挨相连来表示数组。
正例：定义整形数组 int[] arrayDemo;
反例：在 main 参数中，使用 String args[]来定义。
- 8.【参考】各层命名规约：\
- 获取单个对象的方法用 get 做前缀。
- 获取多个对象的方法用 list做前缀，复数形式结尾如：listObjects。
- 获取统计值的方法用 count 做前缀。
- 插入的方法用 save/insert 做前缀。
- 删除的方法用 remove/delete 做前缀。
- 修改的方法用 update 做前缀。
二.常量定义
- 1.【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
- 2.【强制】在 long 或者 Long 赋值时，数值后使用大写的
L，不能是小写的 l，小写容易跟数字
1 混淆，造成误解。
说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?
三.代码格式
- 1.【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果
是非空代码块则：\- 左大括号前不换行。
- 左大括号后换行。
- 右大括号前换行。
- 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
- 2.【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
- 3.【强制】注释的双斜线与注释内容之间有且仅有一个空格。
- 4.【强制】任何二目、三目运算符之间必须加一个空格。
- 5.采用四个空格缩进、严谨使用tab键缩进！
举例：
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左大括号前加空格且不换行；左大括号后换行
if (flag == 1) {
System.out.println("world");
// 右大括号前换行，右大括号后有 else，不用换行
} else {
System.out.println("ok");
// 在右大括号后直接结束，则必须换行
}
}
- 6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。
// 这是示例注释，请注意在双斜线之后有一个空格
String ygb = new String();
- 7.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
// 下例中实参的 args1，后边必须要有一个空格。
method(args1, args2, args3);
- 8.【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
// 反例：
int aa = 1;
int bb = 2;
int c = 3;// 没必要为了等号对齐而多添加空格。
四.控制语句
- 1.【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程
序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且
放在最后，即使空代码。 - 2.【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用
单行的编码方式：if (condition) statements;
五.注释语句
- 1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用
// xxx 方式。 - 2.【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、
异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
- 3.【强制】所有的类都必须添加创建者和创建日期。
安全规则
- 【强制】用户敏感数据禁止直接展示
例一：中国大陆个人手机号码显示为:158****9119，隐藏中间 4 位，防止隐私泄露。
例二：密码不能被看到,例如********。
参考资料
本文参考《阿里巴巴java开发手册》
代码规范理由：码出高效，码出质量
前言：
当今软件的复杂性要求了需要协同开发完成。无规矩不成方圆，无规范难以协同。对于开发一个APP，适当的规范和标准绝对不是消灭代码内容的创造性、优雅性，而是限度过度的个性化，以一种普遍认可的同一方式一起做事，提升协作效率、降低沟通成本。
为什么要代码规范？
- 规范的代码可以促进团队合作。
- 规范的代码可以减少bug处理。
- 规范的代码可以降低维护的成本。
- 规范的代码有助于代码的审查。
- 养成写规范代码的习惯，有助我们的成长。
联系自身
对于我们团队的五个人，有很多知识都是先前没有学到的。各部分都是由团队中的一个人写的，其他人为了项目相关的对接、学习相关知识，必然会阅读到他人写的代码，因此代码的规范就显得非常重要！当然，写规范的代码不仅仅是为了他人的阅读，更重要的是为了自己以后复习~
数据库设计
-
什么是数据库设计？
-
Powerdesigner完成的数据库设计
-
ER图（实体联系模型）
后端架构设计
- 用户登录时使用的后端架构
- 在用户登入APP后，会有四种不同类型的任务来让用户选择。用户可以根据自己的实际情况来对任务作出合理的选择。
用户在选定任务之后会进入相关任务的界面，用户可以了解该任务的相关信息，如：具体内容、限定时间等。。
用户可以查看自己的积分值，并自由支配自己的积分值
用户可以设置自己个人的相关信息。
团队分工
-
优先级
-
版本需求
-
WBS图
-
TODOList实现的燃尽图
因为安装的时候没有配置，所以这周的燃尽图没有办法设置开始时间，所以在最后是一天之间未完成的任务就结束了。
组员的分工和工作量比例。
总的项目分工
本周任务的分工
- 侯泽洋：确定UI框架，初步实现奖励页面（使用文件存储）
- 周亚杰：登录界面雏形，实现微信授权登录的相关资料查找和实践
- 王志伟：引导页面框架（完成），数据库基础
- 仇夏：APP用户登录注册的实现（使用不可逆加密算法在APP中存储用户及相应密码）
- 唐才铭：APP启动界面实现（后续会继续更改优化），需求规格说明书修改
参考资料
- Github项目生成燃尽图的方式
- 《阿里巴巴java开发手册》
