为什么我的 org.springframework.test.web.servlet.MockMvc 框架无法解析控制器的构造函数参数 1.更改控制器的构造函数以接受可为空的参数，例如：2.将“订单”模拟变量添加到“用户”单元测试3.在 ComponentScan 中设置显式包名

编程问答 2022-05-24

问题描述

我想为我的 Spring Boot 应用创建一个单元测试，但在启动 UserControllerTest 测试之一时收到以下错误：

***************************
APPLICATION Failed TO START
***************************

Description:

Parameter 0 of constructor in com.sample.order.OrderController required a bean of type 'com.sample.order.OrderRepository' that Could not be found.


Action:

Consider defining a bean of type 'com.sample.order.OrderRepository' in your configuration.

当我尝试从 UserControllerTest 运行测试时，OrderController 无法满足构造函数参数，反之亦然。

该应用程序很简单，只有两个控制器，用于管理订单和用户。源代码结构如下：

src/
├── main
│   ├── kotlin
│   │   └── com
│   │       └── sample
│   │           ├── OrderApplication.kt
│   │           ├── order
│   │           │   ├── Order.kt
│   │           │   ├── OrderAssembler.kt
│   │           │   ├── OrderController.kt
│   │           │   └── OrderRepository.kt
│   │           └── user
│   │               ├── User.kt
│   │               ├── UserAssembler.kt
│   │               ├── UserController.kt
│   │               └── UserRepository.kt
│   └── resources
│       └── application.properties
└── test
    └── kotlin
        └── com
            └── sample
                ├── order
                │   └── OrderControllerTest.kt
                └── user
                    └── UserControllerTest.kt

总的来说，为了构建我的应用程序，我试图遵循 docs。

应用程序本身运行没有任何问题。问题出在运行测试时。

我看到框架提出的动作很明显：

考虑在您的配置中定义一个“com.sample.order.OrderRepository”类型的 bean。

，但是为什么我要在配置中定义一个“com.sample.order.OrderRepository”类型的bean？当应用程序本身可以工作并且不需要任何配置时，测试不应该开箱即用吗？ 除此之外，OrderRepository 是接口类型：

interface OrderRepository: CrudRepository<Order,Long>

当 Spring 发挥其魔力时，我不想提供它的实例化。

我尝试了什么：

1.更改控制器的构造函数以接受可为空的参数，例如：

来自：

class OrderController(private val repository: OrderRepository,private val assembler: OrderAssembler) {
...

致：

class OrderController(private val repository: OrderRepository? = null,private val assembler: OrderAssembler? = null) {
...

它解决了问题，但出于明显的原因，我不想使用此解决方案。

2.将“订单”模拟变量添加到“用户”单元测试

class UserControllerTest(@Autowired val mockmvc: mockmvc) {

    @MockkBean
    private lateinit var userRepository: UserRepository

    @SpykBean
    private lateinit var userAssembler: UserAssembler

    // !!!!!! NOTE: orderRepository inside user tests ¯\_(ツ)_/¯ 
    @MockkBean
    private lateinit var orderRepository: OrderRepository

    // !!!!!! NOTE: orderAssembler inside user tests ¯\_(ツ)_/¯ 
    @SpykBean
    private lateinit var orderAssembler: OrderAssembler
    

    @Test
    fun `Should form expected json response with user data`(){
        val user = User(id = 5,login="[email protected]",firstname = "John",lastname = "Doe")
        every { userRepository.findAll() } returns listof(user)
        mockmvc.perform(get("/api/v1/users/").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk)
    }
}

它也解决了这个问题，但它是丑陋的解决方法。

3.在 ComponentScan 中设置显式包名

@SpringBootApplication
@ComponentScan("com.sample.order")
class OrderApplication

fun main(args: Array<String>) {
    runApplication<OrderApplication>(*args)
}

UserController 的代码：

@RestController
class UserController(private val repository: UserRepository,private val assembler: UserAssembler) {

    @GetMapping("/api/v1/user/{id}")
    fun findOne(@PathVariable id: Long): EntityModel<User> {
        val user = repository.findById(id)
        if (user.isPresent) {
            return assembler.toModel(user.get())
        }
        throw ResponseStatusException(HttpStatus.NOT_FOUND,"This user does not exist")
    }

    @GetMapping("/api/v1/users")
    fun all(): CollectionModel<EntityModel<User>> {
        val users = repository.findAll().map {
            assembler.toModel(it)
        }
        return CollectionModel.of(users,//
                linkTo<UserController>{all()}.withRel("all"))
    }
}

它没有帮助。除此之外，我的应用程序可以毫无问题地运行，所以我认为组件扫描不是原因。

使用的版本：

  • Java：14
  • 科特林：1.4.0
  • Spring Boot：2.4.1
  • springmockk：1.1.3
  • 模拟：1.10.5

以下是完整的调用堆栈：

Failed to resolve parameter [org.springframework.test.web.servlet.mockmvc mockmvc] in constructor [public com.sample.user.UserControllerTest(org.springframework.test.web.servlet.mockmvc)]
org.junit.jupiter.api.extension.ParameterResolutionException: Failed to resolve parameter [org.springframework.test.web.servlet.mockmvc mockmvc] in constructor [public com.sample.user.UserControllerTest(org.springframework.test.web.servlet.mockmvc)]
    at org.junit.jupiter.engine.execution.ExecutableInvoker.resolveParameter(ExecutableInvoker.java:221)
    at org.junit.jupiter.engine.execution.ExecutableInvoker.resolveParameters(ExecutableInvoker.java:174)
    at org.junit.jupiter.engine.execution.ExecutableInvoker.resolveParameters(ExecutableInvoker.java:135)
    at org.junit.jupiter.engine.execution.ExecutableInvoker.invoke(ExecutableInvoker.java:61)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.invokeTestClassConstructor(ClasstestDescriptor.java:342)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.instantiateTestClass(ClasstestDescriptor.java:289)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.instantiateTestClass(ClasstestDescriptor.java:281)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.instantiateAndPostProcesstestInstance(ClasstestDescriptor.java:269)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.lambda$testInstanceProvider$2(ClasstestDescriptor.java:259)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.lambda$testInstanceProvider$3(ClasstestDescriptor.java:263)
    at java.base/java.util.Optional.orElseGet(Optional.java:369)
    at org.junit.jupiter.engine.descriptor.ClasstestDescriptor.lambda$testInstanceProvider$4(ClasstestDescriptor.java:262)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.prepare(TestMethodTestDescriptor.java:82)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.prepare(TestMethodTestDescriptor.java:59)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$prepare$1(NodeTestTask.java:111)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.prepare(NodeTestTask.java:111)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:79)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1540)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:143)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:129)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:127)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1540)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:143)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:129)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:127)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:32)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:51)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:248)
    at org.junit.platform.launcher.core.DefaultLauncher.lambda$execute$5(DefaultLauncher.java:211)
    at org.junit.platform.launcher.core.DefaultLauncher.withInterceptedStreams(DefaultLauncher.java:226)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:199)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:132)
    at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassprocessor$CollectAllTestClassesExecutor.processAllTestClasses(JUnitPlatformTestClassprocessor.java:99)
    at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassprocessor$CollectAllTestClassesExecutor.access$000(JUnitPlatformTestClassprocessor.java:79)
    at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassprocessor.stop(JUnitPlatformTestClassprocessor.java:75)
    at org.gradle.api.internal.tasks.testing.SuiteTestClassprocessor.stop(SuiteTestClassprocessor.java:61)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:566)
    at org.gradle.internal.dispatch.Reflectiondispatch.dispatch(Reflectiondispatch.java:36)
    at org.gradle.internal.dispatch.Reflectiondispatch.dispatch(Reflectiondispatch.java:24)
    at org.gradle.internal.dispatch.ContextClassLoaderdispatch.dispatch(ContextClassLoaderdispatch.java:33)
    at org.gradle.internal.dispatch.ProxydispatchAdapter$dispatchingInvocationHandler.invoke(ProxydispatchAdapter.java:94)
    at com.sun.proxy.$Proxy2.stop(UnkNown Source)
    at org.gradle.api.internal.tasks.testing.worker.TestWorker.stop(TestWorker.java:133)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:566)
    at org.gradle.internal.dispatch.Reflectiondispatch.dispatch(Reflectiondispatch.java:36)
    at org.gradle.internal.dispatch.Reflectiondispatch.dispatch(Reflectiondispatch.java:24)
    at org.gradle.internal.remote.internal.hub.MessageHubBackedobjectConnection$dispatchWrapper.dispatch(MessageHubBackedobjectConnection.java:182)
    at org.gradle.internal.remote.internal.hub.MessageHubBackedobjectConnection$dispatchWrapper.dispatch(MessageHubBackedobjectConnection.java:164)
    at org.gradle.internal.remote.internal.hub.MessageHub$Handler.run(MessageHub.java:414)
    at org.gradle.internal.concurrent.ExecutorPolicy$CatchAndRecordFailures.onExecute(ExecutorPolicy.java:64)
    at org.gradle.internal.concurrent.ManagedExecutorImpl$1.run(ManagedExecutorImpl.java:48)
    at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
    at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
    at org.gradle.internal.concurrent.ThreadFactoryImpl$ManagedThreadRunnable.run(ThreadFactoryImpl.java:56)
    at java.base/java.lang.Thread.run(Thread.java:834)
Caused by: java.lang.IllegalStateException: Failed to load ApplicationContext
    at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:132)
    at org.springframework.test.context.support.DefaultTestContext.getApplicationContext(DefaultTestContext.java:123)
    at org.springframework.test.context.junit.jupiter.SpringExtension.getApplicationContext(SpringExtension.java:271)
    at org.springframework.test.context.junit.jupiter.SpringExtension.resolveParameter(SpringExtension.java:257)
    at org.junit.jupiter.engine.execution.ExecutableInvoker.resolveParameter(ExecutableInvoker.java:207)
    ... 74 more
Caused by: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'orderController' defined in file [.../webapp/build/classes/kotlin/main/com/sample/order/OrderController.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.NoSuchBeanDeFinitionException: No qualifying bean of type 'com.sample.order.OrderRepository' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
    at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:800)
    at org.springframework.beans.factory.support.ConstructorResolver.autowireConstructor(ConstructorResolver.java:229)
    at org.springframework.beans.factory.support.AbstractAutowireCapablebeanfactory.autowireConstructor(AbstractAutowireCapablebeanfactory.java:1356)
    at org.springframework.beans.factory.support.AbstractAutowireCapablebeanfactory.createBeanInstance(AbstractAutowireCapablebeanfactory.java:1206)
    at org.springframework.beans.factory.support.AbstractAutowireCapablebeanfactory.doCreateBean(AbstractAutowireCapablebeanfactory.java:571)
    at org.springframework.beans.factory.support.AbstractAutowireCapablebeanfactory.createBean(AbstractAutowireCapablebeanfactory.java:531)
    at org.springframework.beans.factory.support.Abstractbeanfactory.lambda$doGetBean$0(Abstractbeanfactory.java:335)
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234)
    at org.springframework.beans.factory.support.Abstractbeanfactory.doGetBean(Abstractbeanfactory.java:333)
    at org.springframework.beans.factory.support.Abstractbeanfactory.getBean(Abstractbeanfactory.java:208)
    at org.springframework.beans.factory.support.DefaultListablebeanfactory.preInstantiateSingletons(DefaultListablebeanfactory.java:944)
    at org.springframework.context.support.AbstractApplicationContext.finishbeanfactoryInitialization(AbstractApplicationContext.java:923)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:588)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:767)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:759)
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:426)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:326)
    at org.springframework.boot.test.context.SpringBootContextLoader.loadContext(SpringBootContextLoader.java:122)
    at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContextInternal(DefaultCacheAwareContextLoaderDelegate.java:99)
    at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:124)
    ... 78 more
Caused by: org.springframework.beans.factory.NoSuchBeanDeFinitionException: No qualifying bean of type 'com.sample.order.OrderRepository' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
    at org.springframework.beans.factory.support.DefaultListablebeanfactory.raiseNoMatchingBeanFound(DefaultListablebeanfactory.java:1777)
    at org.springframework.beans.factory.support.DefaultListablebeanfactory.doResolveDependency(DefaultListablebeanfactory.java:1333)
    at org.springframework.beans.factory.support.DefaultListablebeanfactory.resolveDependency(DefaultListablebeanfactory.java:1287)
    at org.springframework.beans.factory.support.ConstructorResolver.resolveAutowiredArgument(ConstructorResolver.java:887)
    at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:791)
    ... 97 more

测试源代码：

  1. OrderControllerTest.kt
package com.sample.order

import com.ninjasquad.springmockk.MockkBean
import com.ninjasquad.springmockk.SpykBean
import io.mockk.every
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.http.MediaType
import org.springframework.test.web.servlet.mockmvc
import org.springframework.test.web.servlet.request.mockmvcRequestBuilders.get
import org.springframework.test.web.servlet.result.mockmvcResultMatchers.jsonPath
import org.springframework.test.web.servlet.result.mockmvcResultMatchers.status
import java.util.*

@WebMvcTest
class OrderControllerTest(@Autowired val mockmvc: mockmvc) {

    //Why we need that to have test compilable ?
    /*
    @MockkBean
    private lateinit var userRepository: UserRepository

    @SpykBean
    private lateinit var userAssembler: UserAssembler
    */

    @MockkBean
    private lateinit var orderRepository: OrderRepository

    @SpykBean
    private lateinit var orderAssembler: OrderAssembler

    @Test
    fun `Should form expected json response with order data`(){
        val order = Order(id = 7,date = 1501212321)
        every { orderRepository.findById(any()) } returns Optional.of(order)
        mockmvc.perform(get("/api/v1/order/7").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk)
                .andExpect(jsonPath("$.id").value(order.id))
    }
}
  1. UserControllerTest.kt
package com.sample.user

import com.ninjasquad.springmockk.MockkBean
import com.ninjasquad.springmockk.SpykBean
import io.mockk.every
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.http.MediaType
import org.springframework.test.web.servlet.mockmvc
import org.springframework.test.web.servlet.request.mockmvcRequestBuilders.get
import org.springframework.test.web.servlet.result.mockmvcResultMatchers.status

@WebMvcTest
class UserControllerTest(@Autowired val mockmvc: mockmvc) {

    @MockkBean
    private lateinit var userRepository: UserRepository

    @SpykBean
    private lateinit var userAssembler: UserAssembler

    /*
    @MockkBean
    private lateinit var orderRepository: OrderRepository

    @SpykBean
    private lateinit var orderAssembler: OrderAssembler
    */

    @Test
    fun `Should form expected json response with user data`(){
        val user = User(id = 5,login = "[email protected]",lastname = "Doe")
        every { userRepository.findAll() } returns listof(user)
        mockmvc.perform(get("/api/v1/users").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk)
    }
}

源代码可在 the Spring Boot kotlin tutorial

解决方法

解决办法是改变测试注解

  • 添加@AutoConfigureMockMvc
  • 添加@SpringBootTest
  • 删除@WebMvcTest

工作测试注释如下所示：

@AutoConfigureMockMvc
@SpringBootTest
//@WebMvcTest
class UserControllerTest(@Autowired val mockMvc: MockMvc) {
    ...

@AutoConfigureMockMvc - 启用和配置 MockMvc 的自动配置

@SpringBootTest - 告诉 Spring Boot 去寻找一个主要的配置类（例如一个带有 @SpringBootApplication 的类），并使用它来启动一个 Spring 应用程序上下文。 SpringBootTest 加载完整的应用程序并注入所有可能很慢的 bean。

@WebMvcTest - 用于测试控制器层，您需要提供使用 Mock 对象所需的剩余依赖项。

可以在此处找到更多详细信息：

junitkotlinkotlinmockkspring-bootspring-mvc