java - Mockito:如何验证来自另一个单例类的单例类的方法调用

Question

我是单元测试和 Mockito 的新手，如何为给定的单例代码片段编写测试代码。

<强>1。我想为 XYZ 类编写单元测试。
2.我想验证方法是否被调用。
3.我想编写测试代码来检查临时变量的状态。
4.我也想为私有(private)方法计算器编写测试代码。

类 ABC 是单例，有两个字段 num 和 square。

class ABC{
      private static ABC instance;
      private int num;
      private int square;

      private ABC() {}

      public static ABC getInstance() {
          if (instance == null) {
              instance = new ABC();
          }
          return instance;
      }

      public int getSquar() {
          return square;
      }

      public void setSquar(int square) {
          this.square = square;
      }

      public int getNum() {
          return num;
      }

      public void setNum(int num) {
          this.num = num;
      }
}

类 XYZ 是单例，从类 ABC 调用 getter 和 setter 也是单例。

class XYZ{
     private static XYZ instance;
     private int result;

     private XYZ(){}

     public static XYZ getInstance(){
          if (instance == null) {
              instance = new XYZ();
          }
          return instance;
     }

     public void calculateSquare(){
         ABC.getInstance().setNum(5);
         int n = ABC.getInstance().getNum();
         result = calculator(n);
         ABC.getInstance().setSquare(result);

     }  

     private int calculator(int n){
         return n*n;
     }
}

这里我调用 XYZ 类的calculateSquare方法。

XYZ.getInstance().calculateSquare();

Answer 1

尝试回答

Mockito: How to verify a method call in a singleton triggered by a method invocation of another singleton?

关于

XYZ.getInstance().calculateSquare();

假设您只想使用 Mockito 和 JUnit。

答案:您的“虚拟代码”是不可测试代码的完美示例。

• 您的示例代码不会向外部公开任何可观察到的行为。 “外部”将是您尚未编写的周围测试代码，用于执行您的“虚拟代码”。 (因此)您不能对您的“虚拟代码”做出任何断言(JUnit/Hamcrest)。

• 通过使用单例，您将无法在测试时控制“虚拟代码”的“内部状态”。 (因此)您无法对“虚拟代码”的行为进行任何验证(Mockito)。

• 您无法直接测试私有(private)方法，因为您无法调用它们。如果您觉得需要测试 private 方法，那么它不应该是 private。

  私有(private)方法隐藏了您永远不应该编写任何测试的内部实现。针对预期行为的公共(public) API 测试编写测试，而不是针对该行为的实现方式(无论出于何种原因，该行为都可能随时发生变化，从而很容易破坏您的测试)。

如果您想测试您的代码，那么您必须对其进行设计/编码，使其可测试。 JUnit/Mockito 无法使不可测试的代码可供您测试。

<小时/>

关于做什么的提示:

用一个简单的构造函数替换 Singleton 方法，采用实例完成其工作所需的任何依赖协作者。其结果为

public Xyz(final Abc yourCollaborator) {
    this.collaborator = yourCollaborator;
}

使用 Mockito，您可以创建 Abc.class 的 Mock 或 Spy 实例。您需要这样一个模拟的 Abc 实例将其传递到您的 Xyz 构造函数中以进行验证。像这样:

@Test
public void calculateSquareShouldSetNumTo5() throws Exception {
    Abc mockedAbc = Mockito.mock(Abc.class);
    Xyz xyz = new Xyz(mockedAbc);
    
    // method under test
    xyz.calculateSquare();
    
    Mockito.verify(mockedAbc).setNum(5); // expect setNum(5) to be called once
}

要真正对您的实现进行断言，您需要 Abc 类的真实实例。因为它是您可以观察 calculateSquare() 方法调用效果的“部分”。 (请注意，您不能为此使用 Mockito 模拟 Abc 实例!)您的测试可能如下所示:

 @Test
 public void calculateSquareShouldAlwaysResult25() throws Exception {
     Abc abc = new Abc();
     Xyz xyz = new Xyz(abc);

     // method under test
     xyz.calculateSquare();

     assertThat(abc.getSquare(), is(25));
 }

事实上，最后一个测试也可以为您的“虚拟代码”编写，如下所示:

 @Test
 public void calculateSquareShouldAlwaysResult25() throws Exception {
     // method under test
     XYZ.getInstance().calculateSquare();

     assertThat(ABC.getInstance().getSquare(), is(25));
 }

那么为什么单例仍然不适合测试？出于测试目的，单例不能轻易地用“占位符”实例替换。这样的占位符可以是 Abc TestAbc extends Abc 的特殊测试实现，或者是 Mockito 模拟的 Abc 实例。

最后，如果您先编写测试(!)，您将永远不会以这种方式编写“虚拟代码”。

免责声明:以上代码旨在让您了解如何进行测试以及您的“虚拟代码”需要进行哪些更改才能使其可测试。这并不意味着有意义的测试，也不意味着这些示例可以按原样编译。