インターフェース ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>>
- 型パラメーター:
B- ビルダー型への自己参照
- すべてのスーパーインターフェース:
MockMvcBuilder
public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>>
extends MockMvcBuilder
MockMvc を構築するための一般的な方法を定義します。- 導入:
- 4.1
- 作成者:
- Rossen Stoyanchev, Sam Brannen
方法の概要
修飾子と型メソッド説明<T extends B>
TDispatcherServletプロパティのカスタマイズを可能にするdispatchOptions(boolean)のより高度なバリアント。<T extends B>
T特定のパターンセットにマップされたフィルターを追加します。<T extends B>
TaddFilters(FilterEE... filters) リクエストにマップされたフィルターを追加します(つまり<T extends B>
TalwaysDo(ResultHandler resultHandler) すべてのレスポンスに常に適用されるグローバルアクションを定義します。<T extends B>
TalwaysExpect(ResultMatcher resultMatcher) すべてのレスポンスに常に適用されるグローバルな期待を定義します。<T extends B>
Tapply(MockMvcConfigurer configurer) MockMvc のセットアップを自動化し、特定の目的のために設定するMockMvcConfigurerを追加します (例<T extends B>
TdefaultRequest(RequestBuilder requestBuilder) 実行されたすべてのリクエストにマージされるデフォルトのリクエストプロパティを定義します。default <T extends B>
TdefaultResponseCharacterEncoding(CharsetSE defaultResponseCharacterEncoding) すべてのレスポンスに適用されるデフォルトの文字エンコードを定義します。<T extends B>
TdispatchOptions(boolean dispatchOptions) HTTP OPTIONS リクエストの処理を許可する DispatcherServlet プロパティdispatchOptionsRequestを有効にするかどうか。インターフェース org.springframework.test.web.servlet.MockMvcBuilder から継承されたメソッド
build
方法の詳細
addFilters
任意のリクエストにマッピングされたフィルターを追加します(つまり、"/*" )。例:mockMvcBuilder.addFilters(springSecurityFilterChain);
これは、次の web.xml 構成と同等です。
<filter-mapping> <filter-name>springSecurityFilterChain</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>フィルターは、提供された順に呼び出されます。
- パラメーター:
filters- 追加するフィルター
addFilter
特定のパターンセットにマップされたフィルターを追加します。例:mockMvcBuilder.addFilter(myResourceFilter, "/resources/*");
これは次と同等です。
<filter-mapping> <filter-name>myResourceFilter</filter-name> <url-pattern>/resources/*</url-pattern> </filter-mapping>フィルターは、提供された順に呼び出されます。
- パラメーター:
filter- 追加するフィルターurlPatterns- マップする URL パターン。空の場合、デフォルトで "/*" が使用されます
defaultRequest
実行されたすべてのリクエストにマージされるデフォルトのリクエストプロパティを定義します。実際、これは、コンテンツ型、リクエストパラメーター、セッション属性、その他のリクエストプロパティなど、すべてのリクエストに共通の初期化を定義するメカニズムを提供します。リクエストの実行時に指定されたプロパティは、ここで定義されたデフォルトのプロパティをオーバーライドします。
- パラメーター:
requestBuilder- RequestBuilder;MockMvcRequestBuildersの静的ファクトリメソッドを参照してください
defaultResponseCharacterEncoding
default <T extends B> T defaultResponseCharacterEncoding(CharsetSE defaultResponseCharacterEncoding) すべてのレスポンスに適用されるデフォルトの文字エンコードを定義します。このメソッドのデフォルトの実装は
UnsupportedOperationExceptionSE をスローします。具体的な実装では、このメソッドをオーバーライドすることをお勧めします。- パラメーター:
defaultResponseCharacterEncoding- デフォルトのレスポンス文字エンコード- 導入:
- 5.3.10
alwaysExpect
すべてのレスポンスに常に適用されるグローバルな期待を定義します。例: ステータスコード 200(OK)、コンテンツ型"application/json"など。- パラメーター:
resultMatcher- ResultMatcher;MockMvcResultMatchersの静的ファクトリメソッドを参照してください
alwaysDo
すべてのレスポンスに常に適用されるグローバルアクションを定義します。例:System.outに対して実行されたリクエストと結果のレスポンスに関する詳細情報を書き込む。- パラメーター:
resultHandler- ResultHandler;MockMvcResultHandlersの静的ファクトリメソッドを参照してください
dispatchOptions
HTTP OPTIONS リクエストの処理を許可する DispatcherServlet プロパティdispatchOptionsRequestを有効にするかどうか。addDispatcherServletCustomizer
DispatcherServletプロパティのカスタマイズを可能にするdispatchOptions(boolean)のより高度なバリアント。- 導入:
- 5.3
apply
MockMvc のセットアップを自動化し、特定の目的(セキュリティなど)用に構成するMockMvcConfigurerを追加します。リクエスト全体で HTTP セッションを再利用するために使用できる組み込み
SharedHttpSessionConfigurerがあります。Spring Security のようなサードパーティのフレームワークもこのメカニズムを使用して、設定のショートカットを提供します。