Spring MVC控制器单元测试不调用@ControllerAdvice

时间:2013-03-08 19:57:22

标签: spring spring-mvc junit

我在应用程序中有一组控制器和一个注释为@ControllerAdvice的类,它设置了每个控制器中使用的某些数据元素。我正在使用Spring MVC 3.2并拥有这些控制器的Junits。当我运行Junit时,如果我在ControllerAdvice中部署应用程序并通过浏览器提交请求,则控件不会转到Tomcat类。

有什么想法吗?。

12 个答案:

答案 0 :(得分:74)

在使用@ eugene-to和另一个类似的here的答案后,我发现了限制并在Spring上引发了一个问题:https://jira.spring.io/browse/SPR-12751

因此,Spring测试引入了在4.2中的构建器中注册@ControllerAdvice类的功能。如果您使用 Spring Boot ,则需要1.3.0或更高版本。

通过这种改进,如果您使用的是独立设置,那么您可以设置一个或多个ControllerAdvice个实例,如下所示:

mockMvc = MockMvcBuilders.standaloneSetup(yourController)
            .setControllerAdvice(new YourControllerAdvice())
            .build();

注意:名称setControllerAdvice()可能无法立即显示,但您可以向其传递许多实例,因为它具有var-args签名。

答案 1 :(得分:41)

假设您的类MyControllerAdvice使用@ControllerAdvice注释,该类具有使用@ExceptionHandler注释的方法。对于MockMvc,您可以轻松地将此类添加为异常解析程序。

@Before
public void beforeTest() {
    MockMvc mockMvc = standaloneSetup(myControllers)
        .setHandlerExceptionResolvers(createExceptionResolver())
        .build();
}

private ExceptionHandlerExceptionResolver createExceptionResolver() {
    ExceptionHandlerExceptionResolver exceptionResolver = new ExceptionHandlerExceptionResolver() {
        protected ServletInvocableHandlerMethod getExceptionHandlerMethod(HandlerMethod handlerMethod, Exception exception) {
            Method method = new ExceptionHandlerMethodResolver(MyControllerAdvice.class).resolveMethod(exception);
            return new ServletInvocableHandlerMethod(new MyControllerAdvice(), method);
        }
    };
    exceptionResolver.afterPropertiesSet();
    return exceptionResolver;
}

答案 2 :(得分:18)

尝试使用ExceptionHandler进行注释@ControllerAdvice时,我遇到了类似的问题。在我的情况下,我必须将@Configuration文件与@EnableWebMvc注释一起添加到测试类的@ContextConfiguration

所以我的测试看起来像这样:

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration(classes = {
  RestProcessingExceptionHandler.class,
  TestConfiguration.class,
  RestProcessingExceptionThrowingController.class })
public class TestRestProcessingExceptionHandler {


  private MockMvc mockMvc;
  @Autowired
  WebApplicationContext wac;


  @Before
  public void setup() {
    mockMvc = webAppContextSetup(wac).build();
  }


  @Configuration
  // !!! this is very important - conf with this annotation 
  //     must be included in @ContextConfiguration
  @EnableWebMvc
  public static class TestConfiguration { }


  @Controller
  @RequestMapping("/tests")
  public static class RestProcessingExceptionThrowingController {


    @RequestMapping(value = "/exception", method = GET)
    public @ResponseBody String find() {
      throw new RestProcessingException("global_error_test");
    }
  }


  @Test
  public void testHandleException() throws Exception {
    mockMvc.perform(get("/tests/exception"))
        .andExpect(new ResultMatcher() {


          @Override
          public void match(MvcResult result) throws Exception {
            result.getResponse().getContentAsString().contains("global_error_test");
          }
        })
        .andExpect(status().isBadRequest());
  }
}

@EnableWebMvc配置我的测试通过了。

答案 3 :(得分:6)

我在相当长的一段时间里一直在努力。经过深入挖掘,最好的参考资料是Spring文档:

http://static.springsource.org/spring/docs/3.2.x/spring-framework-reference/html/testing.html#spring-mvc-test-framework

简而言之,如果您只是测试控制器及其方法,那么您可以使用'standaloneSetup'方法创建一个简单的Spring MVC配置。这将包含您使用@ControllerAdvice注释的错误处理程序。

private MockMvc mockMvc;

@Before
public void setup() {
    this.mockMvc = MockMvcBuilders.standaloneSetup(new AccountController()).build();
}

// ...

要创建一个更完整的Spring MVC配置,确实包含您的错误处理程序,您应该使用以下设置:

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration("test-servlet-context.xml")
public class AccountTests {

    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

    @Autowired
    private AccountService accountService;

    // ...

}

答案 4 :(得分:3)

这对我有用

public class MyGlobalExceptionHandlerTest {

    private MockMvc mockMvc;

    @Mock
    HealthController healthController;

    @BeforeTest
    public void setUp() {
        MockitoAnnotations.initMocks(this);
        mockMvc = MockMvcBuilders.standaloneSetup(healthController).setControllerAdvice(new GlobalExceptionHandler())
            .build();
    }

    @Test(groups = { "services" })
    public void testGlobalExceptionHandlerError() throws Exception {

        Mockito.when(healthController.health()).thenThrow(new RuntimeException("Unexpected Exception"));

        mockMvc.perform(get("/health")).andExpect(status().is(500)).andReturn();

    }

}

答案 5 :(得分:1)

@tunguski示例代码可以正常工作,但了解事情的运作方式是值得的。这只是设置方法的一种方式。

@EnableWebMvc相当于弹出配置文件中的跟随

<mvc:annotation-driven />

基本上,对于要工作的东西,您需要初始化Spring Mvc并加载所有控制器和bean引用。因此,以下可能是有效的设置以及备用

以下是如何设置测试类

    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = { "classpath: "classpath:test-context.xml" })
    @WebAppConfiguration    
    public class BaseTest {

        @Autowired
        WebApplicationContext wac;

        private MockMvc mockMvc;

        @Before
        public void setUp()  {
            mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
        }
    }

以下可能是测试的弹簧配置

<mvc:annotation-driven />
<context:component-scan base-package="com.base.package.controllers" />

答案 6 :(得分:1)

ControllerAdvice应该由@WebMvcTest拿起,Spring-Doc到目前为止对我来说仍然有效。

示例:

@RunWith(SpringRunner.class)
@WebMvcTest(ProductViewController.class)

答案 7 :(得分:0)

在您需要特定答案之前,您需要提供更多信息,可能还有一些实际的代码和/或配置文件。也就是说,根据你提供的一点点,听起来好像没有加载带注释的bean。

尝试将以下内容添加到测试applicationContext.xml(或等效的spring配置文件,如果您使用的话)。

<context:component-scan base-package="com.example.path.to.package" />

或者,您可能需要通过在测试类之前包含以下注释来“手动”加载测试中的上下文:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/applicationContext.xml")
祝你好运!

答案 8 :(得分:0)

我在用spock(groovy)编写控制器测试时遇到了这个问题。我的测试类最初编写如下:

 @d9mach_ = common global %structd9mach_  zeroinitializer, align 64

这导致ControllerAdvice被忽略。将代码更改为自动修改模拟可以解决问题。

@AutoConfigureMockMvc(secure = false)
@SpringBootTest
@Category(RestTest)
class FooControllerTest extends Specification {
  def fooService = Mock(FooService)
  def underTest = new FooController(FooService)
  def mockMvc = MockMvcBuilders.standaloneSetup(underTest).build()
....
}

答案 9 :(得分:0)

我怀疑您需要在测试中使用asyncDispatch;常规的测试框架被异步控制器破坏了。

尝试以下方法:https://github.com/spring-projects/spring-framework/blob/master/spring-test/src/test/java/org/springframework/test/web/servlet/samples/standalone/AsyncTests.java

答案 10 :(得分:0)

最简单的方法是将您的@ControllerAdvice 注释类添加到@ContextConfiguration。

我不得不改变这个

@AutoConfigureMockMvc
@ContextConfiguration(classes = OrderController.class)
@WebMvcTest
class OrdersIntegrationTest

为此:

@AutoConfigureMockMvc
@ContextConfiguration(classes = {OrderController.class, OrdersExceptionHandler.class})
@WebMvcTest
class OrdersIntegrationTest

答案 11 :(得分:0)

我使用的是 Spring Boot 2.x,但似乎不再需要 MockMvcBuilders,或者当我们将 ControllerAdvice 定义为配置的一部分时,它会被加载。

@WebMvcTest
@ContextConfiguration(classes = {
  UserEndpoint.class, //the controller class for test
  WebConfiguration.class, //security configurations, if any
  StandardRestExceptionInterpreter.class. //<-- this is the ControllerAdvice class
})
@WithMockUser(username = "test@asdf.com", authorities = {"DEFAULT"})
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class UserEndpointTests {

@Test
@Order(3)
public void shouldThrowExceptionWhenRegisteringDuplicateUser() throws Exception {
    //do setup...
    Mockito.doThrow(EntityExistsException.class).when(this.userService).register(user);

    this.mockMvc
            .perform(MockMvcRequestBuilders
                    .post("/users")
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(this.objectMapper.writeValueAsString(user)))
            .andDo(MockMvcResultHandlers.print())
            .andExpect(MockMvcResultMatchers.status().isConflict());
    }
}