这个作业属于哪个课程 | 软件工程-23年春季学期 |
---|---|
这个作业要求在哪里 | 软件工程实践第二次作业—文件读取 |
这个作业的目标 | 完成对澳大利亚网球公开赛相关数据的收集,并实现一个能够对赛事数据进行统计的控制台程序 |
其他参考文献 | 《构建之法》 |
1.Gitcode项目地址
2.PSP表格
PSP | Personal Software Process Stages | 预估耗时(分钟) | 实际耗时(分钟) |
---|---|---|---|
Planning | 计划 | 20 | 25 |
• Estimate | • 估计这个任务需要多少时间 | 20 | 25 |
Development | 开发 | 1370 | 1290 |
• Analysis | • 需求分析 (包括学习新技术) | 500 | 390 |
• Design Spec | • 生成设计文档 | 60 | 70 |
• Design Review | • 设计复审 | 40 | 25 |
• Coding Standard | • 代码规范 (为目前的开发制定合适的规范) | 60 | 30 |
• Design | • 具体设计 | 150 | 160 |
• Coding | • 具体编码 | 400 | 350 |
• Code Review | • 代码复审 | 100 | 125 |
• Test | • 测试(自我测试,修改代码,提交修改) | 60 | 140 |
Reporting | 报告 | 120 | 115 |
• Test Repor | • 测试报告 | 60 | 50 |
• Size Measurement | • 计算工作量 | 30 | 25 |
• Postmortem & Process Improvement Plan | • 事后总结, 并提出过程改进计划 | 30 | 40 |
合计 | 1510 | 1430 |
3.解题思路描述
3.1从网页获取数据
从澳大利亚网球公开赛官网爬取数据
工具:火狐浏览器
3.2解析数据
以下为获取到的json文件的结构
players
results
按照结构分步解析后即可获取想要的数据
4.设计与实现过程
整个项目由5个类构成,分别为:工具类Lib,实现数据写入的printPlayer类和printPlayer类,指令检测类,以及主类
在Lib中实现了一些通用功能,这里是在该类中用到技术的参考链接
使用fastjson解析json文件
依赖如下:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>2.0.24</version>
</dependency>
代码:
//把一个文件中的内容读取成一个String字符串
public static String getStr(File jsonFile){
String jsonStr = "";
try {
FileReader fileReader = new FileReader(jsonFile);
Reader reader = new InputStreamReader(new FileInputStream(jsonFile),"utf-8");
int ch = 0;
StringBuffer sb = new StringBuffer();
while ((ch = reader.read()) != -1) {
sb.append((char) ch);
}
fileReader.close();
reader.close();
jsonStr = sb.toString();
return jsonStr;
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
将字符串存入txt文件
//将字符串输入到txt文档中
public static void stringWriteToTxt(String s) {
try {
BufferedWriter bw = new BufferedWriter(new FileWriter("output.txt", true));
bw.write(String.valueOf(s));
bw.close();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
PrintPlayer类较为简单,只有一个函数,在该函数中只需要查询一个players关键字就可以完成将运动员信息存入txt的功能
public void printPlayers() throws FileNotFoundException {
if (Cache.containsKey("players")) {
lib.stringWriteToTxt(Cache.get("players"));
return;
}
String json = "222000427\\src\\data\\players.json";
File jsonFile = new File(json);
//通过getStr方法获取json文件的内容
String jsonData = lib.getStr(jsonFile);
if (!jsonFile.exists())//检查json文件是否存在
throw new FileNotFoundException("未找到" + json);
//转json对象
JSONObject js1 = (JSONObject) JSONObject.parse(jsonData);
//获取主要数据
JSONArray players = js1.getJSONArray("players");
//遍历运动员数组,把相关信息加入文件输出
StringBuilder playersMsg = new StringBuilder();
for (int i = 0; i < players.size(); i++) {
JSONObject js2 = players.getJSONObject(i);
playersMsg.append("full_name:" + js2.getString("full_name") + "\n");
playersMsg.append("gender:" +
(js2.getString("gender").equals("M") ? "Male" : "Female") + "\n");
playersMsg.append("nationality:" +
js2.getJSONObject("nationality").getString("name") + "\n");
playersMsg.append("-----\n");
}
Cache.put("players", playersMsg.toString());
lib.stringWriteToTxt(playersMsg.toString());
}
PrintResult类就比较复杂了,由于想要查询到比赛时间,获胜者信息,以及比分需要查询不同的关键字,有些关键字甚至需要嵌套查询。所以在该类中根据查询信息类型不同,分别相对应的写了函数。
部分代码示例如下
public static void printResults(String date) throws Exception {
if (PrintPlayer.Cache.containsKey(date)) {
Lib.stringWriteToTxt(PrintPlayer.Cache.get(date));
return;
}
String json = "222000427\\src\\data\\schedule\\";
String smallDate = "0116";
String bigDate = "0129";
if (smallDate.compareTo(date) <= 0 && bigDate.compareTo(date) >= 0 || date.equals("Q1")
|| date.equals("Q2") || date.equals("Q3") || date.equals("Q4")) {
File jsonFile = new File(json + date + ".json");
//通过上面那个方法获取json文件的内容
String jsonData = lib.getStr(jsonFile);
//检查json文件是否存在
if (!jsonFile.exists())
throw new FileNotFoundException("未找到" + json);
//转json对象
JSONObject js1 = (JSONObject) JSONObject.parse(jsonData);
//获取主要数据
JSONArray matches = js1.getJSONArray("matches");
StringBuilder resultsMsg = new StringBuilder();
//遍历运动员数组,把相关信息加入文件输出
for (int i = 0; i < matches.size(); i++) {
JSONObject match = matches.getJSONObject(i);
getTime(match, resultsMsg);
getWinners(match, resultsMsg, js1);
getScore(match, resultsMsg);
resultsMsg.append("\n-----\n");
}
PrintPlayer.Cache.put(date, resultsMsg.toString());
lib.stringWriteToTxt(resultsMsg.toString());
} else
Lib.stringWriteToTxt("N/A\n-----\n");
//throw new IOException("输入的日期格式有误");
}
指令检测类中主要实现了对命令行参数的检验以及报错形式的规范
public static void senseCommand(String[] args){
PrintPlayer player = new PrintPlayer();
PrintResult result = new PrintResult();
try {
if (args.length != 2)
throw new IOException("参数的数量必须为2");
//读取输入文件
BufferedReader reader = new BufferedReader(new FileReader(args[0]));
String lineTxt;
while ((lineTxt = reader.readLine()) != null) {
//忽略空行,如果为空则结束遍历
if (lineTxt.isEmpty())
continue;
//分割指令
//空是”\s”,是转义字符,需要使用”\s”,“+”代表一个或者多个空格
String[] command = lineTxt.split("\\s+");
System.out.println("指令数:" + command.length);
//检查输入错误
try {
if (command.length == 1) {
if (command[0].equals("players"))
player.printPlayers();
else if (command[0].equals("result")) {
Lib.stringWriteToTxt("N/A\n-----\n");
//throw new IOException("输入的日期格式有误");
} else {
Lib.stringWriteToTxt("Error\n-----\n");
//throw new IOException("输入的文件名格式有误");
}
} else if (command[0].equals("result")) {
if (command.length == 2)
result.printResults(command[1]);
else {
Lib.stringWriteToTxt("N/A\n-----\n");
//throw new IOException("输入的日期格式有误");
}
} else {
Lib.stringWriteToTxt("Error\n-----\n");
//throw new IOException("输入的文件名格式有误");
}
} catch (Exception e) {
e.printStackTrace();
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
主函数主要用来调用检测类以及记录程序运行时间
public static void main(String[] args) {
//程序开始时间
Long start = System.currentTimeMillis();
SenseCommand.senseCommand(args);
//程序结束时间
Long end = System.currentTimeMillis();
System.out.println("程序的运行时间为: " + (end - start) + "ms");
}
5.接口封装
部分代码示例
public interface PrintResultInterface {
public static void printResults(String date){}
public static void getTime(JSONObject match, StringBuilder resultsMsg){}
public static void getWinners(JSONObject match, StringBuilder resultsMsg, JSONObject js1){}
public static JSONObject searchTeams(String teamID, JSONArray teams){
return null;
}
public static JSONArray searchPlayers(String winnerUID, JSONArray players){
return null;
}
public static void getScore(JSONObject match, StringBuilder resultsMsg){}
}
6.程序性能改进
使用chche暂存数据,减少对重复指令的读取以免浪费时间
if (PrintPlayer.Cache.containsKey(date)) {
Lib.stringWriteToTxt(PrintPlayer.Cache.get(date));
return;
}
使用前,进行一万条数据测试
使用后,程序运行时间大幅度下降
7.单元测试展示
文件名输入的测试,对printResults函数参数的正确性测试
@Test
public void testMain() {
try {
AOSearch.main(new String[]{"input.txt", "output.txt", "sadadasdasd"});
AOSearch.main(new String[]{"input.txt"});
AOSearch.main(new String[]{"input.txt", "output.txt"});
PrintResult.printResults("1231");
PrintResult.printResults("0116 13");
PrintResult.printResults("1231");
PrintResult.printResults("121wd");
PrintResult.printResults("0116 aa");
PrintResult.printResults("0116 0116");
PrintResult.printResults("0129 Q1");
PrintResult.printResults("Q2");
PrintResult.printResults("Q2 Q2");
} catch (Exception e) {
e.printStackTrace();
}
}
覆盖率指标
8.异常处理
使用try catch
try {
if (command.length == 1) {
if (command[0].equals("players"))
player.printPlayers();
else if (command[0].equals("result")) {
Lib.stringWriteToTxt("N/A\n-----\n");
//throw new IOException("输入的日期格式有误");
} else {
Lib.stringWriteToTxt("Error\n-----\n");
//throw new IOException("输入的文件名格式有误");
}
} else if (command[0].equals("result")) {
if (command.length == 2)
result.printResults(command[1]);
else {
Lib.stringWriteToTxt("N/A\n-----\n");
//throw new IOException("输入的日期格式有误");
}
} else {
Lib.stringWriteToTxt("Error\n-----\n");
//throw new IOException("输入的文件名格式有误");
}
} catch (Exception e) {
e.printStackTrace();
}
}
} catch (Exception e) {
e.printStackTrace();
}
9.心路历程与收获
在刚看完这次作业的要求后,第一感受就是感觉无从下手,如何解析json文件?如何通过命令行控制函数调用?如何使用单元测试对项目进行测试?这些以前没有遇到过的问题都扑面而来。
起初只能硬着头皮在网上寻找教程,但随着时间流逝这些问题也都迎刃而解。通过这次作业,加强了我对项目构建的理解,也学会了一些新的知识。