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

类 AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

java.lang.Object

cn.taketoday.test.web.servlet.MockMvcBuilderSupport

cn.taketoday.test.web.servlet.setup.AbstractMockMvcBuilder<B>

类型参数:

B - a self reference to the builder type

所有已实现的接口:

MockMvcBuilder, ConfigurableMockMvcBuilder<B>

直接已知子类:

DefaultMockMvcBuilder, StandaloneMockMvcBuilder

public abstract class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>
extends MockMvcBuilderSupport
implements ConfigurableMockMvcBuilder<B>

Abstract implementation of MockMvcBuilder with common methods for configuring filters, default request properties, global expectations and global result actions.

Subclasses can use different strategies to prepare the Infra WebApplicationContext that will be passed to the DispatcherServlet.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Stephane Nicoll, Sam Brannen, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private final List<MockMvcConfigurer>	configurers
private RequestBuilder	defaultRequestBuilder
private Charset	defaultResponseCharacterEncoding
private final List<DispatcherServletCustomizer>	dispatcherServletCustomizers
private final List<jakarta.servlet.Filter>	filters
private final List<ResultHandler>	globalResultHandlers
private final List<ResultMatcher>	globalResultMatchers

构造器概要

构造器

构造器	说明
AbstractMockMvcBuilder()

方法概要

修饰符和类型	方法	说明
final <T extends B> T	addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)	A more advanced that allows customizing any DispatcherServlet property.
final <T extends B> T	addFilter(jakarta.servlet.Filter filter, String... urlPatterns)	Add a filter mapped to specific patterns.
<T extends B> T	addFilter(jakarta.servlet.Filter filter, String filterName, Map<String,String> initParams, EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes, String... urlPatterns)	Add a filter that will be initialized via Filter.init(FilterConfig) with the given init parameters, and will also apply only to requests that match the given dispatcher types and URL patterns.
final <T extends B> T	addFilters(jakarta.servlet.Filter... filters)	Add filters mapped to all requests.
final <T extends B> T	alwaysDo(ResultHandler resultHandler)	Define a global action that should always be applied to every response.
final <T extends B> T	alwaysExpect(ResultMatcher resultMatcher)	Define a global expectation that should always be applied to every response.
final <T extends B> T	apply(MockMvcConfigurer configurer)	Add a MockMvcConfigurer that automates MockMvc setup and configures it for some specific purpose (e.g. security).
final MockMvc	build()	Build a MockMvc instance.
final <T extends B> T	defaultRequest(RequestBuilder requestBuilder)	Define default request properties that should be merged into all performed requests.
final <T extends B> T	defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)	Define the default character encoding to be applied to every response.
protected abstract cn.taketoday.web.servlet.WebApplicationContext	initWebAppContext()	A method to obtain the WebApplicationContext to be passed to the DispatcherServlet.
protected <T extends B> T	self()

从类继承的方法 cn.taketoday.test.web.servlet.MockMvcBuilderSupport

createMockMvc, createMockMvc

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

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

从接口继承的方法 cn.taketoday.test.web.servlet.MockMvcBuilder

perform

字段详细资料

filters

private final List<jakarta.servlet.Filter> filters

defaultRequestBuilder

@Nullable
private RequestBuilder defaultRequestBuilder

defaultResponseCharacterEncoding

@Nullable
private Charset defaultResponseCharacterEncoding

globalResultMatchers

private final List<ResultMatcher> globalResultMatchers

globalResultHandlers

private final List<ResultHandler> globalResultHandlers

dispatcherServletCustomizers

private final List<DispatcherServletCustomizer> dispatcherServletCustomizers

configurers

private final List<MockMvcConfigurer> configurers

构造器详细资料

AbstractMockMvcBuilder

public AbstractMockMvcBuilder()

方法详细资料

addFilters

public final <T extends B> T addFilters(jakarta.servlet.Filter... filters)

从接口复制的说明: ConfigurableMockMvcBuilder

Add filters mapped to all requests. Filters are invoked in the same order.

Note: if you need the filter to be initialized with Filter.init(FilterConfig), please use ConfigurableMockMvcBuilder.addFilter(Filter, String, Map, EnumSet, String...) instead.

指定者:

addFilters 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

filters - the filters to add

addFilter

public final <T extends B> T addFilter(jakarta.servlet.Filter filter,
 String... urlPatterns)

从接口复制的说明: ConfigurableMockMvcBuilder

Add a filter mapped to specific patterns.

Note: if you need the filter to be initialized with Filter.init(FilterConfig), please use ConfigurableMockMvcBuilder.addFilter(Filter, String, Map, EnumSet, String...) instead.

指定者:

addFilter 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

filter - the filter to add

urlPatterns - the URL patterns to map to; if empty, matches all requests

addFilter

public <T extends B> T addFilter(jakarta.servlet.Filter filter,
 @Nullable
 String filterName,
 Map<String,String> initParams,
 EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes,
 String... urlPatterns)

从接口复制的说明: ConfigurableMockMvcBuilder

Add a filter that will be initialized via Filter.init(FilterConfig) with the given init parameters, and will also apply only to requests that match the given dispatcher types and URL patterns.

指定者:

addFilter 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

filter - the filter to add

filterName - the name to use for the filter; if null, then MockFilterConfig is created without a name, which defaults to an empty String for the name

initParams - the init parameters to initialize the filter with

dispatcherTypes - dispatcher types the filter applies to

urlPatterns - the URL patterns to map to; if empty, matches all requests

另请参阅:

• MockFilterConfig

defaultRequest

public final <T extends B> T defaultRequest(RequestBuilder requestBuilder)

从接口复制的说明: ConfigurableMockMvcBuilder

Define default request properties that should be merged into all performed requests. In effect this provides a mechanism for defining common initialization for all requests such as the content type, request parameters, session attributes, and any other request property.

Properties specified at the time of performing a request override the default properties defined here.

指定者:

defaultRequest 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

requestBuilder - a RequestBuilder; see static factory methods in MockMvcRequestBuilders

defaultResponseCharacterEncoding

public final <T extends B> T defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)

Define the default character encoding to be applied to every response.

指定者:

defaultResponseCharacterEncoding 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

defaultResponseCharacterEncoding - the default response character encoding

alwaysExpect

public final <T extends B> T alwaysExpect(ResultMatcher resultMatcher)

从接口复制的说明: ConfigurableMockMvcBuilder

Define a global expectation that should always be applied to every response. For example, status code 200 (OK), content type "application/json", etc.

指定者:

alwaysExpect 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

resultMatcher - a ResultMatcher; see static factory methods in MockMvcResultMatchers

alwaysDo

public final <T extends B> T alwaysDo(ResultHandler resultHandler)

从接口复制的说明: ConfigurableMockMvcBuilder

Define a global action that should always be applied to every response. For example, writing detailed information about the performed request and resulting response to System.out.

指定者:

alwaysDo 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

参数:

resultHandler - a ResultHandler; see static factory methods in MockMvcResultHandlers

addDispatcherServletCustomizer

public final <T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)

从接口复制的说明: ConfigurableMockMvcBuilder

A more advanced that allows customizing any DispatcherServlet property.

指定者:

addDispatcherServletCustomizer 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

apply

public final <T extends B> T apply(MockMvcConfigurer configurer)

从接口复制的说明: ConfigurableMockMvcBuilder

Add a MockMvcConfigurer that automates MockMvc setup and configures it for some specific purpose (e.g. security).

There is a built-in SharedHttpSessionConfigurer that can be used to re-use the HTTP session across requests. 3rd party frameworks like Infra Security also use this mechanism to provide configuration shortcuts.

指定者:

apply 在接口中 ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

另请参阅:

• SharedHttpSessionConfigurer

self

protected <T extends B> T self()

build

public final MockMvc build()

Build a MockMvc instance.

指定者:

build 在接口中 MockMvcBuilder

initWebAppContext

protected abstract cn.taketoday.web.servlet.WebApplicationContext initWebAppContext()

A method to obtain the WebApplicationContext to be passed to the DispatcherServlet. Invoked from build() before the MockMvc instance is created.