程序包 cn.taketoday.test.web.servlet

类 MockMvc

java.lang.Object

cn.taketoday.test.web.servlet.MockMvc

public final class MockMvc
extends Object

Main entry point for server-side Web MVC test support.

Example

 import static cn.taketoday.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static cn.taketoday.test.web.servlet.result.MockMvcResultMatchers.*;
 import static cn.taketoday.test.web.servlet.setup.MockMvcBuilders.*;

 // ...

 WebApplicationContext wac = ...;

 MockMvc mockMvc = webAppContextSetup(wac).build();

 mockMvc.perform(get("/form"))
     .andExpectAll(
         status().isOk(),
         content().contentType("text/html"),
         forwardedUrl("/WEB-INF/layouts/main.jsp")
     );
 

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Rob Winch, Sam Brannen

字段概要

字段

修饰符和类型	字段	说明
private RequestBuilder	defaultRequestBuilder
private Charset	defaultResponseCharacterEncoding
private List<ResultHandler>	defaultResultHandlers
private List<ResultMatcher>	defaultResultMatchers
private final jakarta.servlet.Filter[]	filters
private final TestDispatcherServlet	servlet
private final jakarta.servlet.ServletContext	servletContext

构造器概要

构造器

构造器	说明
MockMvc(TestDispatcherServlet servlet, jakarta.servlet.Filter... filters)	Private constructor, not for direct instantiation.

方法概要

修饰符和类型	方法	说明
private void	applyDefaultResultActions(MvcResult mvcResult)
cn.taketoday.web.servlet.DispatcherServlet	getDispatcherServlet()	Return the underlying DispatcherServlet instance that this MockMvc was initialized with.
ResultActions	perform(RequestBuilder requestBuilder)	Perform a request and return a type that allows chaining further actions, such as asserting expectations, on the result.
(专用程序包) void	setDefaultRequest(RequestBuilder requestBuilder)	A default request builder merged into every performed request.
(专用程序包) void	setDefaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)	The default character encoding to be applied to every response.
(专用程序包) void	setGlobalResultHandlers(List<ResultHandler> resultHandlers)	General actions to apply after every performed request.
(专用程序包) void	setGlobalResultMatchers(List<ResultMatcher> resultMatchers)	Expectations to assert after every performed request.
private MockHttpServletResponse	unwrapResponseIfNecessary(jakarta.servlet.ServletResponse servletResponse)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

servlet

private final TestDispatcherServlet servlet

filters

private final jakarta.servlet.Filter[] filters

servletContext

private final jakarta.servlet.ServletContext servletContext

defaultRequestBuilder

@Nullable
private RequestBuilder defaultRequestBuilder

defaultResponseCharacterEncoding

@Nullable
private Charset defaultResponseCharacterEncoding

defaultResultMatchers

private List<ResultMatcher> defaultResultMatchers

defaultResultHandlers

private List<ResultHandler> defaultResultHandlers

构造器详细资料

MockMvc

MockMvc(TestDispatcherServlet servlet,
 jakarta.servlet.Filter... filters)

Private constructor, not for direct instantiation.

另请参阅:

• MockMvcBuilders

方法详细资料

setDefaultRequest

void setDefaultRequest(@Nullable
 RequestBuilder requestBuilder)

A default request builder merged into every performed request.

另请参阅:

• AbstractMockMvcBuilder.defaultRequest(RequestBuilder)

setDefaultResponseCharacterEncoding

void setDefaultResponseCharacterEncoding(@Nullable
 Charset defaultResponseCharacterEncoding)

The default character encoding to be applied to every response.

另请参阅:

• ConfigurableMockMvcBuilder.defaultResponseCharacterEncoding(Charset)

setGlobalResultMatchers

void setGlobalResultMatchers(List<ResultMatcher> resultMatchers)

Expectations to assert after every performed request.

另请参阅:

• AbstractMockMvcBuilder.alwaysExpect(ResultMatcher)

setGlobalResultHandlers

void setGlobalResultHandlers(List<ResultHandler> resultHandlers)

General actions to apply after every performed request.

另请参阅:

• AbstractMockMvcBuilder.alwaysDo(ResultHandler)

getDispatcherServlet

public cn.taketoday.web.servlet.DispatcherServlet getDispatcherServlet()

Return the underlying DispatcherServlet instance that this MockMvc was initialized with.

This is intended for use in custom request processing scenario where a request handling component happens to delegate to the DispatcherServlet at runtime and therefore needs to be injected with it.

For most processing scenarios, simply use perform(cn.taketoday.test.web.servlet.RequestBuilder), or if you need to configure the DispatcherServlet, provide a DispatcherServletCustomizer to the MockMvcBuilder.

perform

public ResultActions perform(RequestBuilder requestBuilder)
                      throws Exception

Perform a request and return a type that allows chaining further actions, such as asserting expectations, on the result.

参数:

requestBuilder - used to prepare the request to execute; see static factory methods in MockMvcRequestBuilders

返回:

an instance of ResultActions (never null)

抛出:

Exception

另请参阅:

• MockMvcRequestBuilders
• MockMvcResultMatchers

unwrapResponseIfNecessary

private MockHttpServletResponse unwrapResponseIfNecessary(jakarta.servlet.ServletResponse servletResponse)

applyDefaultResultActions

private void applyDefaultResultActions(MvcResult mvcResult)
                                throws Exception

抛出:

Exception