如何通过 MockMvc 使用构造函数注入测试控制器

Question

我有一个带有构造函数注入的控制器

@RestController
@RequestMapping("/user")
public class MainController {

    private final UserMapper userMapper; // autowired by constructor below

    public MainController(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @RequestMapping("/getChannels")
    public String index() {
        LoginUser user = userMapper.getUserByName("admin");
        return "Channels: " + user.getChannels();
    }
}

这是一个运行良好的简单类。但是，当我尝试使用以下类运行 JUnit 测试时，出现错误。

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
public class MainControllerTest {

    private MockMvc mvc;
    private final UserMapper userMapper;

    public MainControllerTest(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @Before
    public void setUp() throws Exception {
        mvc = MockMvcBuilders.standaloneSetup(new MainController(userMapper)).build();
    }

    ......

错误是：

java.lang.Exception: Test class should have exactly one public zero-argument constructor

我对上面的错误消息感到困惑，我怎么能用零参数构造函数注入 userMapper？ 我知道可以在 MainController 中为 userMapper 添加@Autowired，但是不建议使用字段注入。 请任何人指导我一种适合构造函数注入和 MockMvc 测试的方法。谢谢。

Answer 1

其他答案谈论使用注释，但在这里您的问题与使用注释没有任何关系。请记住，作为 spring 4.3+，您不需要为依赖项注释构造函数，see more here。

事实上，您不需要尝试在您的测试类中模拟构造函数注入 (MainControllerTest)。 您只需要在应用程序上下文中将UserMapper 声明为弹簧组件，在您的测试类中，它将作为正在运行的应用程序自动注入到您的控制器中。

您的错误是什么意思：错误消息中的所有 Junit Test 类应该只有一个公共零参数构造函数，这是因为在您的场景这样的情况下，Junit Test 套件不知道如何实例化测试类。

Answer 2

在现场使用@Autowire。在生产代码中不建议使用字段注入，因为它会使推理变得混乱（在哪里注入什么以及为什么注入）。但是测试环境（尤其是像这样的环境）很简单，因此不存在硬推理的陷阱。

@Autowired
private final UserMapper userMapper;

public MainControllerTest() { //remove me, implicit
}

此更改将解决问题，因为 jUnit 将拥有一个它可以理解的构造函数，并且能够实例化测试类。

Answer 3

您缺少 @Autowired 的 MainController 构造函数，并始终使用构造函数注入来解决问题，如下所示：

@RestController
@RequestMapping("/user")
public class MainController {

    private final UserMapper userMapper;

    @Autowired
    public MainController(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    //add methods here
}

使用字段注入不是最佳做法，请查看here 了解更多详情。

另外，要解决此问题，您需要更新您的测试类，如下所示：

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
public class MainControllerTest {

    private MockMvc mvc;

    @Mock
    private UserMapper userMapper;

    @InjectMocks
    private MainController mainController = new MainController(userMapper);

    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
        mvc = MockMvcBuilders.standaloneSetup(mainController)..build();
    }

    ......
}