使用Powermock模拟构造函数

  在代码中经常会出现在一个类中去new另一个类对象，并且调用该对象的一些方法的情况，这时我们如果不想真正执行该对象的方法，就需要对new出来的对象进行mock，即对构造函数进行mock。
  我们首先看一个例子：

public class User {
    private String username;
    private String password;

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    public void insert() {
        throw new UnsupportedOperationException();
    }
}

public class UserService {
    public void saveUser(String username, String password) {
        User user = new User(username, password);
        user.insert();
    }
}

  UserService 的方法saveUser中new了一个User对象，并且调用user的insert方法进行保存。我们看下如何测试saveUser方法。

@RunWith(PowerMockRunner.class)
@PrepareForTest({UserService.class})
public class UserServiceTest {
    @Mock
    private User user;

    @Test
    public void saveUser() throws Exception {
        String username = "user1";
        String password = "aaa";
        PowerMockito.whenNew(User.class).withArguments(username, password).thenReturn(user);
        PowerMockito.doNothing().when(user).insert();

        UserService userService = new UserService();
        userService.saveUser(username, password);

        Mockito.verify(user).insert();
    }
}

  1、首先我们要注意的是在@PrepareForTest后面的是使用构造函数的类，而不是构造函数所在的类。
  2、使用下面的语句对构造函数进行mock，即当new User.class类且参数为username和password时返回user这个已经mock的对象：

PowerMockito.whenNew(User.class).withArguments(username, password).thenReturn(user);

  该语句使用的是Powermock提供的下面的接口，该接口要求根据方法的定义对相应的参数进行匹配：

public interface WithExpectedArguments<T> {
    OngoingStubbing<T> withArguments(Object firstArgument, Object... additionalArguments) throws Exception;
}

  由此可以看出mock构造函数非常简单，但是此处要强调一点，由于我们mock时指定了参数必须为username和password，如果参数不匹配时，该mock语句是不起作用的。比如我们如果修改下，如下所示：

userService.saveUser("user2", password);

  则该测试用例执行就是错误的，会提示java.lang.NullPointerException错误，这是因为模拟了user类，但是构造函数又不匹配，则返回默认值Null，从而导致调用saveUser方法时抛空指针异常。
  除了上述的withArguments接口外，Powermock还提供了另外的参数匹配接口：
  1、withAnyArguments接口，原型如下：

public interface WithAnyArguments<T> {
    OngoingStubbing<T> withAnyArguments() throws Exception;
}

  该接口不像withArguments那样对参数作精确匹配，如果使用该接口进行mock，则不论入参是什么，该mock构造函数都有效。
  2、withNoArguments接口，原型如下：

public interface WithoutExpectedArguments<T> {
    OngoingStubbing<T> withNoArguments() throws Exception;
}

  此接口主要适用于无参构造函数。
  3、withParameterTypes接口，原型如下：

public interface WithExpectedParameterTypes<T> {
    WithExpectedArguments<T> withParameterTypes(Class<?> parameterType, Class<?>... additionalParameterTypes);
}

  该接口主要是匹配方法的参数，可以看出其返回值不是OngoingStubbing，而是WithExpectedArguments，即意味这它必须后续要和withArguments配和使用，如下所示：

PowerMockito.whenNew(User.class).withParameterTypes(String.class, String.class).withArguments(username, password)
                .thenReturn(user);

  也就是说，此时匹配构造函数时，不仅要求参数要匹配，而且参数类型也要匹配。如果我们把String.class换成别的类，比如改为如下所示：

PowerMockito.whenNew(User.class).withParameterTypes(Integer.class, String.class).withArguments(username, password)
                .thenReturn(user);

  这个时候执行该测试用例就会提示如下错误：

org.powermock.reflect.exceptions.ConstructorNotFoundException: Failed to lookup constructor with parameter types [ java.lang.Integer, java.lang.String ] in class org.zte.com.User.

  最后，再补充一点，就是如果我们使用Jacoco来统计Java代码测试覆率的话，我们会发现不论我们写了多少测试用例，该UserService类的覆盖率始终是0。这个是因为我们把UserService.class放在了PrepareForTest的后面，这个时候该类就已经被PrepareForTest处理过了，此时Powermock框架会通过ClassLoader的方式改变UserService的行为。即产生一个新的类，在运行过程中凡是碰到使用UserService的时候，都是使用新建的类且提前模拟好的行为运行，并不会执行真正执行UserService类的代码，所以也就没有覆盖率的产生。