java - 如何在 JUnit Test Java 中替代 Mockito 来 stub 类

Question

我试图在 JUnit 的测试 session 期间正确使用 Mockito，以代替对类进行 stub 。 不幸的是，网上有很多关于 Mockito 的教程，但是关于 stub 方法的教程较少，我想学习这项技术。

此测试由 Mockito 进行:

 @Test
public void addWrongNewUserSpaceInUsername() throws Exception {

    when(userValidator.isValidUsername(user.getUsername())).thenReturn(false);

    try {
        mockMvc.perform(
                post("/register")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(asJsonString(user)
                        ));
    } catch (Exception e) {
        Assert.assertTrue(e.getCause() instanceof UsernameNotValidException);
    }
}

为了澄清这些涉及的类:

1) Controller

   @RestController
public class UserController {

    @Autowired
    RepositoryUserDB repositoryUserDB;

    @Autowired
    UserValidator userValidator;

    @RequestMapping(value = "/register", method = RequestMethod.POST)
    public User createUser(@RequestBody User user) {


        if (userValidator.isValidUsername(user.getUsername())) {

            if(!userValidator.isValidPassword(user.getPassword())){
                throw new PasswordNotValidException();
            }

            if(userValidator.isValidDateOfBirth(user.getDateOfBirth()) == false){
                throw new DOBNotValidException();
            }

            // se lo user e' gia' presente
            if (repositoryUserDB.getUserByUsername(user.getUsername()) == null) {
                return repositoryUserDB.createUser(user);
            }
            throw new UsernameAlreadyExistException();
        } else throw new UsernameNotValidException();

    }
}

2)repo接口(interface):

public interface RepositoryUserDB {

    User getUserByUsername(String username);

    User createUser(User user);
}

3) repo :

@Component

    public class MemoryUserDB implements RepositoryUserDB{

        Map<String, User> repo;

        public MemoryUserDB() {
            this.repo = new HashMap<>();
        }

        @Override
        public  User getUserByUsername(String username) {
            return repo.get(username);
        }

        @Override
        public User createUser(User user) {
            repo.put(user.getUsername(),user);
            return repo.get(user.getUsername());
        }
    }

4) validator :

   @Component
public class UserValidator {

    public boolean isValidUsername(String username) {
        return username.matches("^[a-zA-Z0-9]+$");
    }

    public boolean isValidPassword(String pwd) {
        if (pwd == null)
            return false;
        return pwd.matches("^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d){4,}.+$");
    }

    public boolean isValidDateOfBirth(String DOB) {
        return DOB.matches("^(?:(?:(?:0?[13578]|1[02])(\\/|-|\\.)31)\\1|(?:(?:0?[1,3-9]|1[0-2])(\\/|-|\\.)(?:29|30)\\2))(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$|^(?:0?2(\\/|-|\\.)29\\3(?:(?:(?:1[6-9]|[2-9]\\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:(?:0?[1-9])|(?:1[0-2]))(\\/|-|\\.)(?:0?[1-9]|1\\d|2[0-8])\\4(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$");
    }
}

5)ResEntityExceptionHandler

    @ControllerAdvice
public class RestEntityExceptionHandler {

    @ExceptionHandler(UsernameNotValidException.class)
    @ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "username wrong")
    public void handleUsernameException() {
    }

    @ExceptionHandler(UsernameAlreadyExistException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "the username is already presents")
    public void handleUsername() {
    }

    @ExceptionHandler(PasswordNotValidException.class)
    @ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "password wrong")
    public void handlePasswordException() {
    }

    @ExceptionHandler(DOBNotValidException.class)
    @ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "Date Of Birth wrong")
    public void handleDOBException(){
    }

}

Answer 1

理论上，对于您的用例， stub 方法应该相当简单。
但是，当您依赖于使用 Spring beans 容器的 Spring Boot 测试时，设置起来确实更加困难，因为您应该找到一种方法将模拟的 bean 注入(inject)容器中以替换实际的 bean:UserValidator 。
Spring Boot测试中的Mock通常依赖Spring Boot MockBean .
这不是一个mockito模拟，但也不是很远。
要了解与 Mockito 模拟的差异，您可以引用 to this question .

使用框架提供了许多开箱即用的功能，但也会限制您自己，因为您想绕过框架功能。

---

假设您没有使用 Spring Boot 进行集成测试，而是进行真正的单元测试(因此没有 Spring boot 容器)，则可以通过这种方式执行。

您无需模拟 UserValidator.isValidUsername()，而是定义 UserValidator 的自定义实现，该实现按测试中的预期对方法返回进行 stub 。
最后，Mockito 或任何模拟框架可以为您做什么。

所以这是 stub 类:

public class UserValidatorStub extends UserValidator {

    private String expectedUsername;
    private boolean isValidUsername;

    public UserValidatorStub(String expectedUsername, boolean isValidUsername){
          this.expectedUsername = expectedUsername;
          this.isValidUsername = isValidUsername;
    }
    public boolean isValidUsername(String username) {
        if (username.equals(expectedUsername)){
           return isValidUsername;
        }
        // as fallback, it uses the default implementation but you may return false or null as alternative
       return super.isValidUsername(username);
    }

}

它接受一个构造函数来存储传递给 stub 方法的预期参数以及要返回的 stub 结果。

现在，这里是如何编写测试的:

 @Test
public void addWrongNewUserSpaceInUsername() throws Exception {

    // inject the mock in the class under test
    UserController userController = new UserController(new UserValidatorStub(user.getUsername(), false));
    try {
        userController.createUser(user);
    } catch (Exception e) {
        Assert.assertTrue(e.getCause() instanceof UsernameNotValidException);
    }
}

请注意，该示例依赖于 UserController 中的构造函数注入(inject)来设置依赖项。