Java中的单元测试多行字符串

Question

我想对一个用于解析特定模式的文件的 API 进行单元测试。
返回的文本片段可能是多行的并包含选项卡等。即文件中的文本使用新行和制表符进行格式化以供用户阅读（就像我们很好地缩进 xml 文件一样）。
问题：因为Java 不提供该选项定义这样的字符串（这将是对 API 输出的Assert 检查的预期结果）如何处理这些问题？
我想例如将所有预期的输出保存在带有某种特殊字符的文件中，以标记每个预期片段的开始和结束，但我认为也许有一个标准的方法来解决这个问题。
有更好的选择吗？

更新： 示例：

This is an example String.    
     This is an inner part of the string.        Another part.           Another also.    
                      This is also an inner part.   
     Now an outer.   This is the outer example       string.

Answer 1

更新：基于@Code-Guru 的回答（他说的显而易见）：您可以轻松地做到这一点，以便 Eclipse 可以正确插入并自动转义您的文字，如果您愿意走内联路线：Windows->Preferences->Java->Editor->Typing->粘贴文字时转义文本。

遗憾的是，Java 没有像 Scala 或 Groovy 这样的多行字符串。

我找到的最好的解决方案是在你的类路径中放一个文本文件并做一个

getClass().getResourceAsStream("filename");
//Then convert to string.

这将从相对于getClass() 类的类路径中加载一个名为filename 的文件（即在同一个包中）。

您可以在这里使用我的要点：https://gist.github.com/4041855，它使用 Guava 可以更轻松地将文件作为字符串从类路径加载并进行一些性感的缓存。

如果您使用 Maven 或 Gradle，您需要将这些文件放入 src/test/resources 而不是 src/test/java。

如果您不想生成很多文件，显然可以对字符串（即 XML）进行一些解析。另一个稍微有点矫枉过正的选择是制作一个只读的 SQLite 数据库甚至是 CSV。我见过有人这样做，如果他们想要测试 1000 多个不同的参数。如果那是你的问题，你应该谷歌 JUnit 参数化测试。

Answer 2

我不明白 Java 不允许在代码中使用“多行”字符串这一事实有什么问题。您应该能够与其中包含 '\n' 和 '\t' 字符的字符串进行比较。这些“预期”字符串是在您的测试中硬编码还是来自输入文件是您的测试套件的设计决定。

Answer 3

我会支持@Adam Gent 的建议，添加一些示例代码以将资源读入字符串：

final InputStream is = StringFromFile.class.getResourceAsStream("data.txt");
final byte[] b = new byte[is.available()];
is.read(b);
System.out.println(new String(b, "UTF-8"));

您可以嵌入格式占位符（例如 %s、%d 等），然后使用 String.format 将它们替换为实际值。

如果你想拥有一个包含所有字符串的文件，你可以维护一个 xml 文件：

<strings>
    <string name="error 1"><![CDATA[Multiline
error
message 1]]></string>
    <string name="error 2"><![CDATA[Multiline
error
message 2]]></string>
    <string name="error 3"><![CDATA[Multiline
error
message 3]]></string>
</strings>

并将其导入地图 - 这样您就可以使用 map.get(name); 调用它

你可以找到类似here的例子