结对项目

结对项目

这个作业是属于哪个课程	软件工程
作业要求	作业要求
作业目标	实现一个自动生成小学四则运算题目的命令行程序
团队成员	周华娟3219005498，郑宝柔3219005497

1.GitHub地址

项目地址

2.需求

1.使用 -n 参数控制生成题目的个数，例如 Myapp.exe -n 10 将生成10个题目。

2.使用 -r 参数控制题目中数值（自然数、真分数和真分数分母）的范围，例如 Myapp.exe -r 10 将生成10以内（不包括10）的四则运算题目。该参数可以设置为1或其他自然数。该参数必须给定，否则程序报错并给出帮助信息。

3.生成的题目中计算过程不能产生负数，也就是说算术表达式中如果存在形如e1− e2的子表达式，那么e1≥ e2。

4.生成的题目中如果存在形如e1÷ e2的子表达式，那么其结果应是真分数。

5.每道题目中出现的运算符个数不超过3个。

6.程序一次运行生成的题目不能重复，即任何两道题目不能通过有限次交换+和×左右的算术表达式变换为同一道题目。例如，23 + 45 = 和45 + 23 = 是重复的题目，6 × 8 = 和8 × 6 = 也是重复的题目。3+(2+1)和1+2+3这两个题目是重复的，由于+是左结合的，1+2+3等价于(1+2)+3，也就是3+(1+2)，也就是3+(2+1)。但是1+2+3和3+2+1是不重复的两道题，因为1+2+3等价于(1+2)+3，而3+2+1等价于(3+2)+1，它们之间不能通过有限次交换变成同一个题目。
生成的题目存入执行程序的当前目录下的Exercises.txt文件，格式如下：

四则运算题目1
四则运算题目2
……

其中真分数在输入输出时采用如下格式，真分数五分之三表示为3/5，真分数二又八分之三表示为2’3/8。

7.在生成题目的同时，计算出所有题目的答案，并存入执行程序的当前目录下的Answers.txt文件，格式如下：

答案1
答案2

特别的，真分数的运算如下例所示：1/6 + 1/8 = 7/24。

8.程序应能支持一万道题目的生成。

9.程序支持对给定的题目文件和答案文件，判定答案中的对错并进行数量统计，输入参数如下：
Myapp.exe -e .txt -a .txt
统计结果输出到文件Grade.txt，格式如下：

Correct: 5 (1, 3, 5, 7, 9)
Wrong: 5 (2, 4, 6, 8, 10)

其中“:”后面的数字5表示对/错的题目的数量，括号内的是对/错题目的编号。为简单起见，假设输入的题目都是按照顺序编号的符合规范的题目。

3.实现方案

1.流程图

生成题目集流程图：

getStringList()流程图：

main()方法流程图：

2.核心思想和代码

1.OperatorUtil.java

• 随机生成运算符的数量num，范围是1-3
• 随机生成num个运算符（+，-，×，÷）

2.NumbersUtil.java

随机生成numberSize范围内的操作数。

• 先是随机生成[0,numberSize)的随机数num1和[1,numberSize+1)的随机数num2
• 将二者相除，得到的就是在0-numberSize范围内的整数和真分数
• 注意这里的形式，如果num1%num2 != 0，说明就是分数，值若大于1说明是假分数，转换为x'y/z的形式
• 并且所有的分数化到最简，不存在2/4或者2'2/6的情况。

3.ExerciseUtil.java

将随机生成的运算符数组和操作数数组顺序打乱，得到一个乱序的数组。

这是创建题目的部分代码。

• 先创建随机的运算符数组
• 创建随机的操作数数组
• 将运算符数组和操作数数组打乱顺序
• 根据运算符的个数，题目的组成有好几种可能，随机抽取一种类型题目返回

4.ArithmaticUtil.java

1. operatorMap:运算符Map，里面存各运算符对应的优先级，比如("+", 1), ("×",2)
2. calculate：对外暴露calculate方法，参数为表达式，直接返回计算结果
3. parseSuffixExpressionList：中缀表达式转换成逆波兰表达式
4. getListString:转换成中缀表达式
5. calculatePostfix:计算逆波兰表达式
6. toFraction:将数值转化为分数
7. toFormalForm:将结果转换成作业要求的格式，比如假分数转换成带分数
8. add:计算逆波兰表达式结果中的加法运算
9. division:除法运算
10. minus：减法运算
11. multiplication：加法运算

实现四则运算器的具体过程

1. 利用getListString()将运算式中的运算符和数值拆分来开装入一个List中，即转化成一个中缀表达式
2. 将中缀表达式转化为逆波兰表达式
3. 计算逆波兰表达式的值

private static List<String> getListString(String suffixExpression) {
        //将suffixExpression 分割
        String[] split = suffixExpression.split(" ");
        List<String> list = new ArrayList<>();
        for (String ele : split) {
            //表示是否有 ")"
            String suffix = null;
            //如果ele有多个"("的话，就依次添加到list中
            while (ele.contains("(")) {
                list.add(ele.substring(0, 1));
                ele = ele.substring(1);

            }
            //如果ele有")"，比如说"4))"，那么就需要把4和"))"分隔开
            if (ele.contains(")")) {
                //获取数字
                String num = StrUtil.subBefore(ele, ")", false);
                //获取")"
                suffix = StrUtil.subAfter(ele, num, true);
                ele = num;
            }
            list.add(ele);
            //如果有")"，则需要依次添加到list中
            if (suffix != null) {
                for (char c : suffix.toCharArray()) {
                    list.add(String.valueOf(c));
                }
            }
        }
        return list;
    }

中缀表达式转化为逆波兰表达式

//中缀表达式的list转成后缀表达式
    private static List<String> parseSuffixExpressionList(List<String> list) {
        //定义两个栈
        Stack<String> s1 = new Stack<>();

        //储存中间结果的栈s2
        List<String> s2 = new ArrayList<>();

        //遍历s1
        for (String item : list) {
            //利用正则表达式判断是否含有数字，有则加入s2
            if (item.matches(".*[0-9]{1,}.*")) {
                s2.add(item);
            } else if ("(".equals(item)) {
                s1.push(item);
            } else if (")".equals(item)) {
                //一次弹出s1栈顶的运算符，并压入s2，直到遇到左括号为止
                while (!"(".equals(s1.peek())) {
                    s2.add(s1.pop());
                }
                //将( 弹出s1，消除小括号
                s1.pop();
            } else {
                //当item的优先级小于等于s1栈顶运算符，将s1栈顶的运算符弹出并压入到s2中，再次转到循环中与s1中的新的栈顶元素比较
                while (s1.size() != 0 && operatorMap.getOrDefault(s1.peek(), 0) >= operatorMap.getOrDefault(item, 0)) {
                    s2.add(s1.pop());
                }
                //还需要将item压入栈
                s1.push(item);
            }
        }
        //将s1中剩余的运算符依次弹出并加入s2
        while (s1.size() != 0) {
            s2.add(s1.pop());
        }
        return s2;
    }

加法运算

 /**
     * 加法
     * @param num1 被加数
     * @param num2 加数
     * @return
     */
    private static String add(String num1, String num2) {
        String[] fraction1 = num1.split("/");
        String[] fraction2 = num2.split("/");
        String result = null;

        //获取num1的分子
        int numerator1 = Integer.parseInt(fraction1[0]);
        //获取num2的分母
        int denominator1 = Integer.parseInt(fraction1[1]);

        //获取num2的分子
        int numerator2 = Integer.parseInt(fraction2[0]);
        //获取num2的分母
        int denominator2 = Integer.parseInt(fraction2[1]);

        //如果num1和num2都是整数，则直接相加
        if (denominator1 == 1 && denominator2 == 1) {
            result = String.valueOf(numerator1 + numerator2);
        } else {
            //获取分母的最小公倍数
            int denominatorLCM = MathUtil.lcm(denominator1, denominator2);
            //获取相加后的分子
            int addNumerator = numerator1 * denominatorLCM / denominator1 + numerator2 * denominatorLCM / denominator2;

            //获取分子分母的最大公因数
            int fractionGCD = MathUtil.gcd(Math.max(denominatorLCM, addNumerator), Math.min(denominatorLCM, addNumerator));
            //化简
            int newNumerator = addNumerator / fractionGCD;
            int newDenominator = denominatorLCM / fractionGCD;

            result = newNumerator + "/" + newDenominator;
        }
        return result;
    }

乘法：

private static String multiplication(String num1, String num2) {
        String[] fraction1 = num1.split("/");
        String[] fraction2 = num2.split("/");
        String result = null;

        //获取num1的分子
        int numerator1 = Integer.parseInt(fraction1[0]);
        //获取num1的分母
        int denominator1 = Integer.parseInt(fraction1[1]);

        //获取num1的分子
        int numerator2 = Integer.parseInt(fraction2[0]);
        //获取num2的分母
        int denominator2 = Integer.parseInt(fraction2[1]);

        //如果num1和num2都是整数，就直接相乘
        if (denominator1 == 1 && denominator2 == 1) {
            result = String.valueOf(numerator1 * numerator2);
        } else {
            //分子之间相乘
            int mulNumerator = numerator1 * numerator2;
            //分母之间相乘
            int mulDenominator = denominator1 * denominator2;

            //获取最大公倍数
            int gcd = MathUtil.gcd(Math.max(mulDenominator, mulNumerator), Math.min(mulDenominator, mulNumerator));

            //进行化简
            int newNumerator = mulNumerator / gcd;
            int newDenominator = mulDenominator / gcd;

            result = newNumerator + "/" + newDenominator;
        }

        return result;
    }

3.测试类

1.OperatorTest

2.NumbersTest

3.ExerciseTest

4.ArithmaticTest

4.可视化页面

1.进入页面

2.输入题目的总数和操作数的范围

3.生成压缩包，里面包含Exercises.txt和Answers.txt

5.需求完成度

1.需求1和需求2：输入参数执行jar包

2.需求3：不产生负数

3.需求4：结果为真分数

4.需求5：运算符个数不超过3个

5.需求6和需求7：生成Exercises.txt和Answers.txt文件

6.需求8

7.需求9

6.PSP表格

PSP2.1	Personal Software Process Stages	预估耗时（分钟）	实际耗时（分钟）
Planning	计划	60	70
· Estimate	· 估计这个任务需要多少时间	20	15
Development	开发	1000	1440
· Analysis	· 需求分析 (包括学习新技术)	40	50
· Design Spec	· 生成设计文档	30	20
· Design Review	· 设计复审 (和同事审核设计文档)	50	40
· Coding Standard	· 代码规范 (为目前的开发制定合适的规范)	30	15
· Design	· 具体设计	40	30
· Coding	· 具体编码	240	360
· Code Review	· 代码复审	120	150
· Test	· 测试（自我测试，修改代码，提交修改）	360	240
Reporting	报告	120	150
· Test Report	· 测试报告	60	70
· Size Measurement	· 计算工作量	20	15
· Postmortem & Process Improvement Plan	· 事后总结, 并提出过程改进计划	30	35
合计		2220	2700

7.性能分析

1.全部性能

2.类的占用情况

3.CPU负载

8.总结

• 郑宝柔：在完成本次项目中，深刻体会到了合作的重要性，好处是在自己遇到困难时，可以求助队友一起解决，而需要解决的是两人之间的协作分工问题，在这个项目上，我负责实现四则运算器，网页的接口，命令行传参，附加题功能，在写代码的过程中，最常出现问题的是在命令行传参读取文件的编码不一致，导致读取Exercises.txt的内容是乱码，其次就是实现网页下载答案和问题文件时，一个响应只能下载一个文件，所以要想实现下载两个文件只有把两个文件加入到zip中，这部分的实现花的时间比较久。总的来说，收获还是非常大的，一次次的bug都是一次宝贵的经历，同时队友也非常给力，能在我遇到问题时及时提出自己的想法共同解决。
• 周华娟：我负责的模块是随机生成运算符和操作数，并实现创建题目和题目集的功能，因为我的题目是随机生成，有可能在拼接过程中拼接上括号，所以在后期判断题目是否在运算过程中出现负数难以复现，因为拆解题目比较麻烦。为了解决这个问题，和队友思考了一番，决定调用写好的运算器，若运算过程中出现-号则会抛出异常，而我这里接收异常并处理，这样就保证了生成的题目并不会出现运算过程有负数的情况。总的来说，这次项目遇到许许多多的问题，不过团队合作能集思广益，让我们一起解决了这些难顶的bug。