个人项目
| 作业所属课程 | |
|---|---|
| 作业要求 | |
| 作业目标 | 做一个论文查重项目，学习在github仓库建立文件夹，使用合适工具进行性能分析。 |
我的 Github 链接：https://github.com/Jannie-Wei/Jannie-Wei
一、需求分析：
需求：
题目：论文查重
描述如下：
设计一个论文查重算法，给出一个原文文件和一个在这份原文上经过了增删改的抄袭版论文的文件，在答案文件中输出其重复率。
原文示例：今天是星期天，天气晴，今天晚上我要去看电影。
抄袭版示例：今天是周天，天气晴朗，我晚上要去看电影。
要求输入输出采用文件输入输出，规范如下：
从命令行参数给出：论文原文的文件的绝对路径。
从命令行参数给出：抄袭版论文的文件的绝对路径。
从命令行参数给出：输出的答案文件的绝对路径。
总结为以下两点：
1.对输入的原文文件和抄袭版文件进行重复率分析计算；
2.使用命令行将重复率输出到答案文件内，其中数字精确到小数点后两位。
分析：
1.可以设置路径读取两个文件
2.将读取到的内容化为向量用余弦相似度来计算
二、PSP2表格
| Personal | Software Process Stages | 预估耗时（分钟） | 实际耗时（分钟） |
|---|---|---|---|
| Planning | 计划 | 20 | 15 |
| Estimate | 估计这个任务需要多少时间 | 845 | 1107 |
| Development | 开发 | 790 | 1042 |
| Analysis | 需求分析 (包括学习新技术) | 100 | 190 |
| Design Spec | 生成设计文档 | 40 | 27 |
| Design Review | 设计复审 | 20 | 20 |
| Coding Standard | 代码规范 (为目前的开发制定合适的规范) | 30 | 40 |
| Design | 具体设计 | 40 | 35 |
| Coding | 具体编码 | 400 | 550 |
| Code Review | 代码复审 | 30 | 40 |
| Test | 测试（自我测试，修改代码，提交修改） | 100 | 120 |
| Reporting | 报告 | 30 | 25 |
| Test Repor | 测试报告 | 20 | 20 |
| Size Measurement | 计算工作量 | 15 | 20 |
| Postmortem & Process Improvement Plan | 事后总结, 并提出过程改进计划 | 20 | 20 |
| 合计 | 865 | 1122 |
三 、计算模块接口的设计与实现：
分为四个类：Main , MainTest , SimilarityMain , SimilarityMainTest .
包含的方法：main(String[] args) 方法，testSimilarity() 方法，setUp() 方法，calculateVector(String str, int index) 方法，cosineSimilarity() 方法，
similarity()方法，testMain 方法等
注解：@Timeout 注解，@Test 注解
类的执行流程：
1.用户首先运行 Main 类中的 main 方法。
2.main 方法中创建了一个 Scanner 对象，用于从控制台获取用户输入的文件路径。
3.用户输入原始论文文件路径、抄袭版论文文件路径和要保存相似度结果的文件路径。
4.如果用户输入的文件路径为空，则程序输出相应的提示信息并结束。
5.否则，程序会创建一个 DecimalFormat 实例，然后使用输入的文件路径创建 SimilarityMain 实例。
6.SimilarityMain 实例的 similarity() 方法被调用来计算两篇论文的相似度。
7.计算得到的相似度结果会被打印到控制台。
8.程序将相似度结果写入用户指定的输出文件，并在控制台上显示操作结果。
9.如果在写入文件时出现异常（IOException），则捕获异常并输出错误信息。
算法关键：
计算输入的两篇论文的相似度。
四、计算模块接口部分的性能改进
改进计算模块思路：
在这个地方花费的时间较多，改进时我增加了异常处理机制，引入了语义信息。
性能分析图
五、计算模块部分单元测试展示
部分单元测试代码
@Test
public void testSimilarity() {
// 运行测试
final double result = similarityMainUnderTest.similarity();// 调用待测试对象的 similarity 方法得到相似度计算结果
// 验证结果
double expected = 0.4364357804719848;// 预期的相似度计算结果
assertEquals(expected, result, 0.001);// 使用断言验证实际结果和预期结果是否一致，允许误差为0.001
// 打印实际结果和预期结果
System.out.println("实际结果：" + result);
System.out.println("预期结果：" + expected);
}
测试的函数： testSimilarity函数
构建测试数据的思路：
测试数据：在这个测试中，测试数据主要是一个已经初始化好的vectorMap对象，其中包含了字符及其对应的向量。
思路：
1.在setUp方法中，首先创建一个vectorMap对象，并使用put方法将字符及其对应的向量加入到vectorMap中。
2.使用反射将创建的实际vectorMap对象设置到SimilarityMain类中的vectorMap字段中。
3.在testSimilarity方法中，通过调用待测试对象的similarity方法得到实际的相似度计算结果。
4.将预期结果赋值给expected变量，即预计的相似度计算结果。
5.使用assertEquals断言来比较实际结果和预期结果是否相等，允许误差为0.001。
6.打印实际结果和预期结果，用于查看测试结果。
部分测试结果截图
六、测试单元的异常处理
@Test
@Timeout(value = 2000, unit = TimeUnit.MILLISECONDS)
public void testMain() {
DecimalFormat df = new DecimalFormat("0.00");
double d1 = 0.342453;
String formattedValue = df.format(d1);
// 检查格式化后的值是否符合预期
assertEquals("0.34", formattedValue);
}
}
这个测试中，我一开始断言 assertEquals(0.0, result, 0.0001)， 导致 java.lang.AssertionError，我调整精度：增大允许的误差范围，即调整最后一个参数（delta）的值，以容忍更大的差异。
并且使用更合适的方法来比较浮点数，同时更改了d1的值。
