这段代码还能如何针对防御性编程进行优化？

Question

对于我的数据结构项目，目标是读取提供的文件，其中包含 10000 多首歌曲，其中明确标记了艺术家、标题和歌词，并且每首歌曲均由带有单双引号的行分隔。我编写了这段代码来解析文本文件，并且它可以工作，运行时间不到 3 秒
读取 422K 行文本
创建一个 Song 对象
将所说的歌曲添加到 ArrayList

我编写的解析代码是：

if (songSource.canRead()) {  //checks to see if file is valid to read
    readIn= new Scanner(songSource);
    while (readIn.hasNextLine()) {
 do {
     readToken= readIn.nextLine();

             if (readToken.startsWith("ARTIST=\"")) {
  artist= readToken.split("\"")[1];
      } 
      if (readToken.startsWith("TITLE=\"")) {
  title= readToken.split("\"")[1];
      } 
      if (readToken.startsWith("LYRICS=\"")) {
  lyrics= readToken.split("\"")[1];
      } else {
  lyrics+= "\n"+readToken;
      }//end individual song if block
 } while (!readToken.startsWith("\"")); //end inner while loop

    songList.add(new Song(artist, title, lyrics));

    }//end while not EOF 
} //end if file can be read 

我正在与我的算法简介教授讨论该项目的代码，他表示我应该尝试在代码中更具防御性，以允许不一致在其他人提供的数据中。最初，我在艺术家、标题和歌词字段之间使用 if/else 块，根据他的建议，我更改为顺序 if 语句。虽然我可以理解他的观点，但使用此代码示例，我如何才能更加防御性地允许输入不一致？

Answer 1

我会将 例如： 替换

artist= readToken.split("\"")[1];

为

String[] parts = readToken.split("\"");
if(parts.length >= 2) artist = parts[1];
else continue;

其他修改将包括：

1. 重置局部变量（这样，如果在第一首歌曲之后没有为某些歌曲提供艺术家，您就不会意外地得到错误的艺术家）
2. 决定如果某些数据不正确该怎么办缺失 - 您是否仍想将歌曲添加到歌曲列表中？

Answer 2

您假设输入是完美的。如果您查看应用程序当前的设置方式，根据对算法的快速读取，数据将如下所示

ARTIST="John"
TITLE="HELLO WORLD"
LYRICS="Sing Song All night long"
"

但考虑这种情况

ARTIST="John"
TITLE="HELLO WORLD"
LYRICS="Sing Song All night long"
"
ARTIST="Peter"
LYRICS="Sing Song All night long"
"

根据您的算法，您现在有 2 首歌曲，其特征为

songList = { Song("JOHN", "HELLO WORLD", "Sing Song All night long"),
             Song("Peter", "HELLO WORLD", "Sing Song All night long") }

使用当前算法，艺术家和标题已公开并将出现在第二首歌曲中，即使它们尚未定义。您需要重置三个变量。

在你的 else 中，你只是将完整的台词倾倒到歌词中。如果你已经把歌词拿出来了怎么办，你现在就覆盖了它。测试用例

 ARTIST="John"
 LYRICS="Sing Song All night long"
 TILET="HELLO WORLD"
 "

考虑将此记录发送到错误状态。因此，当批量读取完成时，可以生成并修复错误报告。

另外，您只在读入艺术家后才考虑 EOF。如果在艺术家读取期间发生 EOF，并且文件不以“结尾，该怎么办。您将在那里得到一个异常。在您的 do/while 中添加另一个对 hasNextLine 的检查()

Answer 3

在现实世界中，对数据完整性做出了一些保证。在处理用户输入（无论是来自标准输入还是文件）的情况下，有一些项目定义的范例用于通知用户需要注意的问题。

例如，当编译器编译代码或执行脚本的 shell 遇到不一致时，它可能会停止并打印包含不一致的行，并在其下面使用“^”符号指示问题位置的第二行。

所以这里有一些基本问题要问自己：
1. 是否保证每一行都包含每个字段？
2. 字段的顺序是否有保证？

如果这些是输入合同的条件并且被违反，您应该忽略/报告该行。如果它们不是输入的条件，那么您需要处理它..您目前没有。

Answer 4

杰森，我发现这里缺少一些东西。

我认为 if/else 很好，它不会改变逻辑。但是，您应该尽可能限制变量的范围。通过在 while 循环内声明艺术家、标题等，它们将被初始化为 null（或其他），因此如果某个条目缺少艺术家，则它将无法获得最后一个条目的值。

另外，如果标题、艺术家等中有引用，会发生什么情况？那是怎么处理的呢？歌词好像是多行的，对吧？

如果有一个未知字段（可能是拼写错误）会发生什么？它会被添加到歌词的末尾，这似乎不正确。仅当找到 LYRICS 字段后，您才应将其附加到该字段。如果歌词为空，那么它将以“null”开头。

Answer 5

以下是一些可以解决的问题：

• 您的代码假设（例如）“ARTIST”之前没有空格，“=”符号周围没有空格等等。

• 您的代码假定关键字全部大写。有人可能会使用小写或混合大小写。

• 您的代码假定不以 keyword=\" 开头的行是歌曲歌词的延续。但是如果用户输入 ARTOST="Sting" 会怎样？ >？或者如果用户尝试使用两行作为艺术家姓名怎么办？

最后，我不相信在这种情况下用“if”替换“else if”会对代码的稳健性产生任何影响。

Answer 6

处理异常（我猜 Scanner 可能会因无效字符抛出 InputMismatchException ）。

如果文件格式错误，并且到达文件末尾，则看起来 do { } while (...) 可以无限循环。

没有什么可以阻止 artist 或 title 为空。