java - 使用 mockito 在另一种方法中测试方法的使用

Question

我正在编写一个简单的应用程序，它从一个文本文件中检索联系人，从另一个文本文件中检索消息，然后使用检索到的数据通过网关发送消息。我想使用 Mockito 对此应用程序进行测试。我创建了 ContactDetailRetriever 类，其中包含两个方法:retrieveContactDetails() 和 mapOfContact()。

public class ContactDetailRetriever implements AutoCloseable {
private LinkedHashMap<String, String> contacts = new LinkedHashMap<>();
private ArrayList<String> arrOfContacts = new ArrayList<>();
private final String FILE_NAME;

public ContactDetailRetriever() {
    this.FILE_NAME = "contacts.txt";
}

public ContactDetailRetriever(String fileName) {
    this.FILE_NAME = fileName;
}

public ArrayList<String> retrieveContactDetails() {
    try(BufferedReader reader = new BufferedReader(new FileReader(new File(FILE_NAME)))) {
        String line;
        while((line = reader.readLine()) != null) {
            arrOfContacts.add(line);
        }
     }
    catch (IOException e) {
        System.out.println(e.getMessage());
        e.printStackTrace();
    }
    return arrOfContacts;
}

public LinkedHashMap<String, String> mapOfContact() {
    //Here I want to use method
    //retrieveContactDetails();
    String key = "";
    String value = "";
    int lineNo;
    for (lineNo = 0; lineNo < arrOfContacts.size(); lineNo++) {
        if(lineNo % 2 == 0) {
            key = arrOfContacts.get(lineNo);
        }
        if(lineNo % 2 == 1) {
            value = arrOfContacts.get(lineNo);
        }
        contacts.put(key, value);
    }
    return contacts;
}

我想做的是在 mapOfContact() 中使用 retrieveContactDetails() ，它按我想要的方式工作，但我在测试 的使用时遇到问题retrieveContactDetails()。我最终得到的是重构 MessageSender 类中的代码，它间接使用 mapOfContact() 所以 retrieveContactDetails() 没有在 中使用mapOfContact() 了。

public class MessageSender implements SendingTool {

private LinkedHashMap<String, String> contactsMap;
private FileInjector fileInjector;

public MessageSender() {
    this.fileInjector = new FileInjector();
}

public MessageSender(FileInjector fileInjector) {
    this.fileInjector = fileInjector;
}

public LinkedHashMap<String, String> retrieveContactsMap(String fileName) {
    try(ContactDetailRetriever contactDetailRetriever = fileInjector.buildContactDetailRetriever(fileName)) {
        //Two assignments instead of one
        contactArr = contactDetailRetriever.retrieveContactDetails();
        contactsMap = contactDetailRetriever.mapOfContact();
    }

    return contactsMap;
}

它仍然可以正常工作，但在我看来这不是一种优雅的方式。这也意味着我编辑我的测试代码，据我所知，情况不应该如此。测试 retrieveContactDetails() 是否在 mapOfContact() 内部使用的最佳方法是什么？

可能相关的另一件事是 ContactDetailRetriever 依赖项被另一个类注入(inject)到 MessageSender:

public class FileInjector {
public ContactDetailRetriever buildContactDetailRetriever(String fileName) {
    return new ContactDetailRetriever(fileName);
}

public ContactDetailRetriever buildContactDetailRetriever() {
    return new ContactDetailRetriever();
}

Answer 1

改变您的逻辑以使您的代码更易于测试并不是坏事，事实上应该鼓励这样做。你会发现，如果正确地进行可测试性重构，通常会使你的代码更干净、更简单。在你的情况下，重构是你想要做的，但我认为你改变的部分不是你应该寻找的地方。我在你的代码中做的第一件事是删除“重新发明轮子”的大块逻辑，你所有的 retrieveContactDetails() 方法正在做的是从文件中读取行，除非你是使用 1.7 之前的 Java 版本只需使用 1 行 Files.readAllLines(Paths.get(filename))。这样做的好处是因为现在您还没有编写任何自己的文件读取逻辑，测试变得更简单，这成为您唯一需要模拟的行以使其余逻辑完全可测试。

如果您使用的 Java 版本早于 1.7，则根本不用费心使用 mockito...取而代之的是拥有一个包含已知测试数据的“TestContacts.txt”静态测试文件，因为您需要测试您的逻辑无论如何，我们已经用 retrieveContactDetails() 编写了......

如果您使用的是更文明的 java 版本，则有几种方法可以模拟该方法，我个人不喜欢“PowerMockito”方法来模拟静态方法，我个人更喜欢在该方法前面添加一个接口(interface)。

如果我正在考虑测试您的逻辑，这可能是我要使其可测试的“第一步”:

public class ContactDetailRetriever {
    private static final String DEFAULT_FILE_NAME = "contacts.txt";
    private final String fileName;
    private final FileLinesReader fileLinesReader;

    public ContactDetailRetriever() {
        this(DEFAULT_FILE_NAME);
    }

    public ContactDetailRetriever(String fileName) {
        this(fileName, new DefaultFileLinesReader());
    }

    // Visible for testing
    ContactDetailRetriever(String fileName, FileLinesReader fileLinesReader) {
        this.fileName = fileName;
        this.fileLinesReader = fileLinesReader;
    }

    public List<String> retrieveContactDetails() {
        return fileLinesReader.readAllLines(fileName);
    }

    public Map<String, String> mapOfContact() {
        List<String> details = retrieveContactDetails();
        Map<String, String> result = new HashMap<>();
        for (int i = 0; i < details.size() - 1; i += 2) {
            result.put(details.get(i), details.get(i + 1));
        }
        return result;
    }

    public interface FileLinesReader {
        public List<String> readAllLines(String filename);
    }

    private static class DefaultFileLinesReader implements FileLinesReader {
        public List<String> readAllLines(String filename) {
            try {
                return Files.readAllLines(Paths.get(filename));
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    }
}

然后你的测试逻辑变成:

@RunWith(MockitoJUnitRunner.class)
public class ContactDetailRetrieverTest {

    private ContactDetailRetriever testSubject;

    @Mock
    private FileLinesReader fileLinesReader;

    @Test
    public void testMapOfContact() {
        when(fileLinesReader.readAllLines("contacts.txt"))
            .thenReturn(Arrays.asList("contactKey1", "contactValue1", "contactKeyA", "contactValueA"));
        Map<String, String> result = testSubject.mapOfContact();
        assertThat(result.size(), equalTo(2));
        assertThat(result.get("contactKey1"), equalTo("contactValue1"));
        assertThat(result.get("contactKeyA"), equalTo("contactValueA"));
    }

    @Before
    public void setup() throws Exception {
        testSubject = new ContactDetailRetriever("contacts.txt", fileLinesReader);
    }
}