如何在 Java 中测试写入文件？答案

【问题标题】：How to test write to file in Java?如何在 Java 中测试写入文件？
【发布时间】：2013-01-12 15:30:56
【问题描述】：

我是初学者，请自行掌握。我有一些简单的程序，我需要对 write 方法进行 junit 测试。我有一些输入。我怎么能做到这一点？这是我的代码：

// write to file
public void write(String fileName, 
        List<FigureGeneral> figuresList) {
    try {
        PrintWriter out = new PrintWriter(
                new File(fileName).getAbsoluteFile());
        try {
            for (int i = 0; i < figuresList.size(); i++) {
                out.println(figuresList.get(i).toString());
            }
        } finally {
            out.close();
        }
    } catch (IOException e) {
        System.out.println("Cannot write to file!");
    }
}

而且我想知道，因为在此之后我从文件中读取，我们可以加入两个测试（写入/读取）还是更好地单独执行此操作（因为如果我们的测试失败，我们不知道问题出在哪里 - 在读取或写）？应该如何在junit正确地做到这一点（准备测试，并测试自己）？更好地展示示例，这样更容易理解。

谢谢，纳扎尔。

【问题讨论】：

如果您要打印某些内容，则无需致电toString()，因为无论如何它都会这样做。

标签： java unit-testing file-io junit

【解决方案1】：

您可能根本不需要模拟。尝试在测试中使用 StringWriter。

// write to file
public void write(String fileName, List<FigureGeneral> figuresList) {
  try {
    Writer out = new FileWriter(new File(fileName).getAbsoluteFile());
    write(out, figuresList);
  } catch (IOException e) {
    System.out.println("Cannot write to file!");
  }
}

@VisibleForTesting void write(Writer writer, List<FigureGeneral> figuresList) {
  PrintWriter out = new PrintWriter(writer);
  try {
    for (int i = 0; i < figuresList.size(); i++) {
      out.println(figuresList.get(i).toString());
    }
  } finally {
    out.close();
  }
}

@Test public void testWrite() {
  List<FigureGeneral> list = Lists.newArrayList();
  list.add(...); // A
  list.add(...); // B
  list.add(...); // C
  StringWriter stringWriter = new StringWriter();
  write(stringWriter, list);
  assertEquals("A.\nB.\nC.\n", stringWriter.toString()); 
}

【讨论】：

@VisibleForTesting 是Guava 中一个方便的文档注释。代码根本不需要，它只是警告您的用户不要在测试之外调用该方法。

【解决方案2】：

我建议您围绕 IO 类（在您的情况下为 PrintWriter 类）制作一个接口包装器，以便您可以使用模拟对象进行输出。你不必测试 Java PrintWriter，你想测试你的功能，对吧？

所以你的班级将是

class MyClass {

    MyWriter out;

    public void setOut(MyWriter out) {
        this.out = out;
    }

    // write to file
    public void write(String fileName, List<FigureGeneral> figuresList) {
        try {
            try {
                for (int i = 0; i < figuresList.size(); i++) {
                    out.println(figuresList.get(i).toString());
                }
            } finally {
                out.close();
            }
        } catch (IOException e) {
            System.out.println("Cannot write to file!");
        }
    }
}

MyWriter 接口的签名非常简单。

interface MyWriter {

    void println(Object x); // You can add other println methods here.

    void close();

}

然后你可以使用EasyMock 来写一个测试。测试方法类似于

@Test
public void testWrite() {
    MyWriter out = EasyMock.createMock(MyWriter.class);
    EasyMock.expect(mock.println(EasyMock.anyObject())).times(3);
    EasyMock.expect(mock.close()).times(1);

    List<FigureGeneral> list = ...
    list.add(...);
    list.add(...);
    list.add(...);

    replay(mock);

    MyClass myClass = new MyClass();
    myClass.setOut(out);
    myClass.write("mockFileName", list);        

    verify(mock);
}

【讨论】：

您可以用类似的方式测试阅读。在我的示例中，没有与真正的 IO 进行交互。这取决于您到底想测试什么：您的存储逻辑或与操作系统的交互是否顺利并且数据是否正确存储？ Easymock 只是测试使用特定参数等调用特定方法。
另一个想法是创建您自己的模拟实现，它会记住您在（可能是静态的）映射Map<String, List<FigureGeneral>> fileNameToContentsMap 中编写的内容。在这种情况下，您将能够模拟读写，就好像它与真实的文件系统一起工作。
看看这个，它可能会有所帮助。我记得我回答了一个类似的问题。 stackoverflow.com/questions/11849728/simulate-file-in-java/…
你能推荐一些关于 Mocking 的教程吗？
我不知道。我是从 EasyMock 的文档中了解到的：easymock.org/Documentation.html.

【解决方案3】：

您似乎有正确的想法，所以我不确定您需要什么帮助...

我们可以同时加入两个测试吗（写/读）

是的。

或者更好地单独执行（因为如果我们的测试失败，我们不知道问题出在哪里 - 是读取还是写入）？

更好但更难维护。

应该如何在junit正确地做到这一点（准备测试，并测试自己）？

在代码或文本文件中创建一些虚拟数据。

在第一种情况下，写出文件并重新读入，以检查它是否相同。

第二种情况，你可以读取文本文件再写出来，检查是否一样。

【讨论】：