软件工程第五次作业

1. 题目要求

我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：

• 能够自动生成四则运算练习题
• 可以定制题目数量
• 用户可以选择运算符
• 用户设置最大数（如十以内、百以内等）
• 用户选择是否有括号、是否有小数
• 用户选择输出方式（如输出到文件、打印机等）
• 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主

2. 结对同学

本次结对作业，我结对的同学是吕宏林

本次我和吕宏林进行了角色互换，每个人既当了驾驶员又当了领航员

3.驾驶员部分

本次作业，我作为驾驶员的部分，选择java语言开发程序，开发工具是myeclipse和netbeans，之所以选择两个开发工具是因为写具体类用myeclipse比较方便，而视图部分用netbeans比较方便

本次作业，具体代码的编写一共有8个类，截图如下,其中Contact是实体类，DBUtils是工具类，FileOpera是文件操作类，PrintOpera是打印机操作类，Topic是题目生成类，Verify是结果生成类，View是开始选择界面类，ViewContent是屏幕输出类

本次作为驾驶员的部分，代码是由我一人编写，其中在写代码中也遇到了许多问题，比如括号个数究竟如何能达到随机，正确，并且可以人为控制。最后采用一个特殊的处理并且选用了一个栈做二次处理。结果生成的时候用什么方式，采用逆波兰识别字符串，运算符优先级，还是递归识别字符串，最后还是选择了逆波兰。等等吧，写程序碰到了很多难点，也都一一解决了。这个程序的优点是可以选择文件的保存路径，路径的选择是通过配置文件设置的，而不是指定的文件。缺点是代码可能过于丑陋，view部分做的不是很友好，健壮性编写的不是很好，以前没有系统的做过这方面的训练，不知道如何做才是做好的界面，其次就是只能实现展示功能，太单调，还有一点就是程序没有注释，难懂。

通过这次结对作业，也使我懂得了很多。譬如在编写大的应用程序时，要提前有设计。否者程序会乱。程序中参数传递是重要的一个环节，实体类的访问权限是一个问题，要保证程序的内聚性和耦合度的适当。程序的健壮性要好，打印文件要快并且正确，不能只把文件内容打印在一页。要考虑复杂情况。

这次作业领航员吕宏林起到了至关重要的作用，帮我复审代码，帮我查找Bug，多次想放弃，但是在他的鼓励下都坚持下来了。他在分析题意，测试用例，后期工作中做出了至关重要的作用

[代码托管平台地址](https://dev.tencent.com/u/dailluck/p/cn_dailluck_pro_2/git)

最后附上几张运行截图和工作照

开始选择界面

打印界面

保存页面

保存的pdf展示

屏幕输出展示

文件输出展示

工作照

4. 领航员部分

吕宏林的代码很清晰明确，而且在上次结伴指出他不写注释的错误后，也改正了他的错误。在程序的实现工程中我没能帮助他设计，因为他的view是用servlet写的，虽然我会写这些东西，但是不是很熟悉，怕自己不成熟的想法主导别人，导致不必要的错误。但是从程序的健壮性和完成效果来说都很不错。我在这次领航员的工作上，可能不是很合格，只帮他复审了代码检查表，和在没进行编写之前给出一些建议。他的代码中也有很多不足的，在生成括号的时候没有考虑括号的个数。程序设计过程过于依赖工具生成的东西，导致自己书写的东西过少。当然这是个人的想法，其实web本来就是这样，工具生成的东西比较多。

附上测试用例，及其结果

测试用例一，验证输出题目到屏幕，选择题目设置如下图，程序能正常运行，正确输出结果。

测试用例一结果

测试用例二，验证程序数据用例小，存在的偶然性，设置不同参数，输出到屏幕，选择题目设置如下图，程序能正常运行，正确输出结果。

测试用例二结果

测试用例三，验证程序输出文件功能，程序能正常运行，有提示内容。

测试用例三结果

测试用例四，验证程序输入参数不全时的健壮性，程序崩了

测试用例四结果

测试的时候我选用了多组样例，这里仅展示了四组样例，从测试结果来看，程序的功能实现的全面。程序中没有Bug。这里指出一点，吕宏林同学的程序设置了健壮性的检查，他的检查是所有参数全部不输入，会提示出错，但是我输入了一些参数，一些参数没有输入，会出现问题。这也是一个程序的健壮性的问题。Web应用常常出现这种情况，希望他以后能注意吧。

最后附上吕宏林同学代码的细节方面的审查结果

功能模块名称
审查人	陈敬男	审查日期	2019.5.4
代码名称	四则运算	代码作者	吕宏林
重要性	激活	级别	检查项
命名
重要	Y	20	命名规则是否与所采用的规范保持一致？
	Y	20	是否遵循了最小长度最多信息原则？
重要	Y	50	has/can/is前缀的函数是否返回布尔型？
注释
重要	Y	10	注释是否较清晰且必要？
重要	N	10	复杂的分支流程是否已经被注释？
	Y	10	距离较远的}是否已经被注释？
	Y	10	非通用变量是否全部被注释？
重要	Y	50	函数是否已经有文档注释？（功能、输入、返回及其他可选）
	N	10	特殊用法是否被注释？
声明、空白、缩进
	Y	20	每行是否只声明了一个变量？（特别是那些可能出错的类型）
重要	Y	40	变量是否已经在定义的同时初始化？
重要	N	40	类属性是否都执行了初始化？
	Y	20	代码段落是否被合适地以空行分隔？
	N	20	是否合理地使用了空格使程序更清晰？
	Y	20	代码行长度是否在要求之内？
	Y	20	折行是否恰当？
语句/功能分布/规模
	N	20	包含复合语句的{}是否成对出现并符合规范？
	Y	20	是否给单个的循环、条件语句也加了{}？
	N	20	if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？
	Y	40	单个变量是否只做单个用途？
重要	Y	20	单行是否只有单个功能？（不要使用；进行多行合并）
重要	Y	40	单个函数是否执行了单个功能并与其命名相符？
	Y	20	操作符＋＋和— —操作符的应用是否复合规范？
规模
重要	Y	20	单个函数不超过规定行数？
重要	Y	100	缩进层数是否不超过规定？
重要	Y	100	是否已经消除了所有警告？
重要	Y	40	常数变量是否声明为final？
重要	Y	80	对象使用前是否进行了检查？
重要	N	80	局部对象变量使用后是否被复位为NULL？
重要	Y	70	对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。
重要	Y	20	是否确认没有同名变量局部重复定义问题?
	N	20	程序中是否只使用了简单的表达式？
重要	N	20	是否已经用（）使操作符优先级明确化？
重要	N	20	所有判断是否都使用了（常量==变量）的形式？
	Y	80	是否消除了流程悬挂？
重要	Y	80	是否每个if-else if-else语句都有最后一个else以确保处理了全集？
重要	Y	80	是否每个switch-case语句都有最后一个default以确保处理了全集？
	Y	80	for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX）
重要	Y	40	XML标记书写是否完整，字符串的拼写是否正确?
	Y	40	对于流操作代码的异常捕获是否有finally操作以关闭流对象?
	N	20	退出代码段时是否对临时对象做了释放处理?
重要	Y	40	对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断）
可靠性（函数）
重要	N	60	入口对象是否都被进行了判断不为空？
重要	N	60	入口数据的合法范围是否都被进行了判断？(尤其是数组)
重要	Y	20	是否对有异常抛出的方法都执行了try...catch保护？
重要	N	80	是否函数的所有分支都有返回值？
重要	Y	50	int的返回值是否合理？（负值为失败，非负值成功）
	Y	20	对于反复进行了int返回值判断是否定义了函数来处理？
	N	60	关键代码是否做了捕获异常处理?
重要	N	60	是否确保函数返回CORBA对象的任何一个属性都不能为null?
重要	N	60	是否对方法返回值对象做了null检查，该返回值定义时是否被初始化?
重要	Y	60	是否对同步对象的遍历访问做了代码同步?
重要	Y	80	是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？
重要	Y	60	线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出?
	Y	20	原子操作代码异常中断，使用的相关外部变量是否恢复先前状态?
重要	N	100	函数对错误的处理是恰当的？
可维护性
重要	Y	100	实现代码中是否消除了直接常量？（用于计数起点的简单常数例外）
	Y	20	是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )）
	N	20	是否每个return前都要有日志记录?
	N	20	是否有冗余判断语句？（如：if (b) return true; else return false;）
	Y	20	是否把方法中的重复代码抽象成私有函数?