註冊@ControllerAdvice註解控制器在JUnitTest與MockMVC

Question

我@ControllerAdvice註解控制器是這樣的：

@ControllerAdvice 
public class GlobalControllerExceptionHandler { 

    @ResponseStatus(value = HttpStatus.UNAUTHORIZED) 
    @ExceptionHandler(AuthenticationException.class) 
    public void authenticationExceptionHandler() { 
    } 
} 

當然，我的開發測試驅動，我想用我的異常處理程序的JUnit測試。我的測試情況是這樣的：

public class ClientQueriesControllerTest { 

    private MockMvc mockMvc; 

    @InjectMocks 
    private ClientQueriesController controller; 

    @Mock 
    private AuthenticationService authenticationService; 

    @Before 
    public void setup() { 
     MockitoAnnotations.initMocks(this); 
     mockMvc = MockMvcBuilders.standaloneSetup(controller).build(); 
    } 

    @Test 
    public void findAllAccountRelatedClientsUnauthorized() throws Exception { 
     when(authenticationService.validateAuthorization(anyString())).thenThrow(AuthenticationException.class); 

     mockMvc.perform(get("/rest/clients").header("Authorization", UUID.randomUUID().toString())) 
       .andExpect(status().isUnauthorized()); 
    } 
} 

也許我需要註冊ControllerAdvice類。怎麼做？

Answer 1

爲了激活完整的Spring MVC配置，您需要使用MockMvcBuilders.webAppContextSetup而不是MockMvcBuilders.standaloneSetup。

檢查出this Spring文檔的一部分以獲取更多詳細信息。

你的代碼是這樣：

@RunWith(SpringJUnit4ClassRunner.class) 
@WebAppConfiguration 
@ContextConfiguration("test-config.xml") 
public class ClientQueriesControllerTest { 

    private MockMvc mockMvc; 

    @Autowired 
    private WebApplicationContext webApplicationContext; 

    @Autowired 
    private AuthenticationService authenticationService; 

    @Before 
    public void setup() { 
     MockitoAnnotations.initMocks(this); 
     mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build(); 
    } 

    @Test 
    public void findAllAccountRelatedClientsUnauthorized() throws Exception { 
     when(authenticationService.validateAuthorization(anyString())).thenThrow(AuthenticationException.class); 

     mockMvc.perform(get("/rest/clients").header("Authorization", UUID.randomUUID().toString())) 
       .andExpect(status().isUnauthorized()); 
    } 
} 

內。然後test-config.xml您將添加一個Spring bean的AuthenticationService這是一個模擬。

​​

---

你當然可以使用配置文件注入在測試中模擬AuthenticationService如果要重用，而不是創建test-config.xml你經常Spring配置文件。

---

UPDATE

了一下週圍挖後，我發現，通過（MockMvcBuilders.standaloneSetup）返回StandaloneMockMvcBuilder是完全可定製的。這意味着你可以插入你喜歡的任何異常解析器。

但是由於您使用的是@ControllerAdvice，下面的代碼將不起作用。 然而，如果你的@ExceptionHandler方法是相同的控制器內的代碼你就必須改變如下：

mockMvc = MockMvcBuilders.standaloneSetup(controller).setHandlerExceptionResolvers(new ExceptionHandlerExceptionResolver()).build(); 

---

更新2

一些更多的挖給出了答案如何你當您也使用@ControllerAdvice時，可以註冊一個正確的異常處理程序。

您需要更新測試設置代碼爲以下：

@Before 
    public void setUp() throws Exception { 
     final ExceptionHandlerExceptionResolver exceptionHandlerExceptionResolver = new ExceptionHandlerExceptionResolver(); 

     //here we need to setup a dummy application context that only registers the GlobalControllerExceptionHandler 
     final StaticApplicationContext applicationContext = new StaticApplicationContext(); 
     applicationContext.registerBeanDefinition("advice", new RootBeanDefinition(GlobalControllerExceptionHandler.class, null, null)); 

     //set the application context of the resolver to the dummy application context we just created 
     exceptionHandlerExceptionResolver.setApplicationContext(applicationContext); 

     //needed in order to force the exception resolver to update it's internal caches 
     exceptionHandlerExceptionResolver.afterPropertiesSet(); 

     mockMvc = MockMvcBuilders.standaloneSetup(controller).setHandlerExceptionResolvers(exceptionHandlerExceptionResolver).build(); 
    } 

Answer 2

了過去NestedServletException用以下解決方案...

final StaticApplicationContext applicationContext = new StaticApplicationContext(); 
    applicationContext.registerSingleton("exceptionHandler", GlobalControllerExceptionHandler.class); 

    final WebMvcConfigurationSupport webMvcConfigurationSupport = new WebMvcConfigurationSupport(); 
    webMvcConfigurationSupport.setApplicationContext(applicationContext); 

    mockMvc = MockMvcBuilders.standaloneSetup(controller). 
     setHandlerExceptionResolvers(webMvcConfigurationSupport.handlerExceptionResolver()). 
     build(); 

Answer 3

您可以將它添加到您的測試類

@Autowired 
@Qualifier("handlerExceptionResolver") 
void setExceptionResolver(HandlerExceptionResolver resolver) 
{ 
    this.exceptionResolver = resolver; 
} 

然後添加exceptionResolver您MockMvc

@Before 
public void setup() { 
    MockitoAnnotations.initMocks(this); 
    mockMvc = MockMvcBuilders.standaloneSetup(controller) 
       .setHandlerExceptionResolvers(this.exceptionResolver).build(); 
} 

Answer 4

從Spring 4.2，您可以將您的ControllerAdvice直接註冊到您的StandaloneMockMvcBuilder ：

MockMvcBuilders 
    .standaloneSetup(myController) 
    .setControllerAdvice(new MyontrollerAdvice()) 
    .build();