クラス ServletTestExecutionListener
- 実装されたすべてのインターフェース:
Ordered
,TestExecutionListener
WebApplicationContexts
にモックサーブレット API サポートを提供する TestExecutionListener
具体的には、ServletTestExecutionListener
は、テストインスタンスの準備中および各テストメソッドの前に、 Spring Web の RequestContextHolder
を介してスレッドローカル状態を設定し、WebApplicationContext
に存在する MockServletContext
に基づいて MockHttpServletRequest
、MockHttpServletResponse
、ServletWebRequest
を作成します。このリスナーは、MockHttpServletResponse
および ServletWebRequest
がテストインスタンスに挿入できることも保証し、テストが完了すると、このリスナーはスレッドローカル状態をクリーンアップします。
ServletTestExecutionListener
はデフォルトで有効になっていますが、テストクラスに @WebAppConfiguration
アノテーションが付けられていない場合、通常は何もしません。詳細については、このクラスの個々のメソッドの javadoc を参照してください。
- 導入:
- 3.2
- 作成者:
- Sam Brannen, Phillip Webb
フィールドサマリー
修飾子と型フィールド説明static final StringSE
ServletTestExecutionListener
をアクティブ化する必要があることを示すTestContext
属性の属性名。static final StringSE
Spring Web のRequestContextHolder
のRequestAttributes
に格納されているMockHttpServletRequest
が TestContext フレームワークによって作成されたことを示すリクエスト属性の属性名。static final StringSE
ServletTestExecutionListener
が Spring Web のRequestContextHolder
にすでに入力されていることを示すTestContext
属性の属性名。static final StringSE
ServletTestExecutionListener
がafterTestMethod(TestContext)
で Spring Web のRequestContextHolder
をリセットする必要があるかどうかを示すTestContext
属性の属性名。インターフェース org.springframework.core.Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
afterTestMethod
(TestContext testContext) 提供されたTestContext
のRESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
の値がBoolean.TRUE
SE である場合、このメソッドは、(1)Spring Web のRequestContextHolder
をリセットして各テストメソッドの後にスレッドローカル状態をクリーンアップし、(2) 新しいモックが後続のテストインスタンスに確実に挿入されるようにします。テストコンテキストのDependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE
をtrue
に設定してテストします。void
beforeTestMethod
(TestContext testContext) Spring Web のRequestContextHolder
を介して各テストメソッドの前にスレッドローカル状態を設定します。ただし、テストクラスに@WebAppConfiguration
アノテーションが付けられている場合のみです。final int
getOrder()
1000
を返します。void
prepareTestInstance
(TestContext testContext) Spring Web のRequestContextHolder
を介したテストインスタンス準備コールバックフェーズ中にスレッドローカル状態をセットアップしますが、テストクラスに@WebAppConfiguration
アノテーションが付けられている場合のみです。クラス org.springframework.test.context.support.AbstractTestExecutionListener から継承されたメソッド
afterTestClass, afterTestExecution, beforeTestClass, beforeTestExecution
フィールドの詳細
RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
ServletTestExecutionListener
がafterTestMethod(TestContext)
で Spring Web のRequestContextHolder
をリセットする必要があるかどうかを示すTestContext
属性の属性名。許容値には、
Boolean.TRUE
SE およびBoolean.FALSE
SE が含まれます。POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
ServletTestExecutionListener
が Spring Web のRequestContextHolder
にすでに入力されていることを示すTestContext
属性の属性名。許容値には、
Boolean.TRUE
SE およびBoolean.FALSE
SE が含まれます。CREATED_BY_THE_TESTCONTEXT_FRAMEWORK
Spring Web のRequestContextHolder
のRequestAttributes
に格納されているMockHttpServletRequest
が TestContext フレームワークによって作成されたことを示すリクエスト属性の属性名。許容値には、
Boolean.TRUE
SE およびBoolean.FALSE
SE が含まれます。- 導入:
- 4.2
ACTIVATE_LISTENER
ServletTestExecutionListener
をアクティブ化する必要があることを示すTestContext
属性の属性名。true
に設定されていない場合、テストクラスに@WebAppConfiguration
アノテーションが付けられるとアクティブ化が行われます。許容値には、
Boolean.TRUE
SE およびBoolean.FALSE
SE が含まれます。- 導入:
- 4.3
コンストラクターの詳細
ServletTestExecutionListener
public ServletTestExecutionListener()
メソッドの詳細
getOrder
public final int getOrder()1000
を返します。- 次で指定:
- インターフェース
Ordered
のgetOrder
- オーバーライド:
- クラス
AbstractTestExecutionListener
のgetOrder
- 戻り値:
- オーダー額
- 関連事項:
prepareTestInstance
Spring Web のRequestContextHolder
を介したテストインスタンス準備コールバックフェーズ中にスレッドローカル状態をセットアップしますが、テストクラスに@WebAppConfiguration
アノテーションが付けられている場合のみです。- 次で指定:
- インターフェース
TestExecutionListener
のprepareTestInstance
- オーバーライド:
- クラス
AbstractTestExecutionListener
のprepareTestInstance
- パラメーター:
testContext
- テストのテストコンテキスト。null
- 例外:
ExceptionSE
- 例外の伝播を許可します- 関連事項:
TestExecutionListener.prepareTestInstance(TestContext)
setUpRequestContextIfNecessary(TestContext)
beforeTestMethod
Spring Web のRequestContextHolder
を介して各テストメソッドの前にスレッドローカル状態を設定します。ただし、テストクラスに@WebAppConfiguration
アノテーションが付けられている場合のみです。- 次で指定:
- インターフェース
TestExecutionListener
のbeforeTestMethod
- オーバーライド:
- クラス
AbstractTestExecutionListener
のbeforeTestMethod
- パラメーター:
testContext
- テストメソッドが実行されるテストコンテキスト。非null
- 例外:
ExceptionSE
- 例外の伝播を許可します- 関連事項:
TestExecutionListener.beforeTestMethod(TestContext)
setUpRequestContextIfNecessary(TestContext)
afterTestMethod
提供されたTestContext
のRESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
の値がBoolean.TRUE
SE である場合、このメソッドは、(1)Spring Web のRequestContextHolder
をリセットして各テストメソッドの後にスレッドローカル状態をクリーンアップし、(2) 新しいモックが後続のテストインスタンスに確実に挿入されるようにします。テストコンテキストのDependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE
をtrue
に設定してテストします。RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
およびPOPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
は、それらの値に関係なく、その後テストコンテキストから削除されます。- 次で指定:
- インターフェース
TestExecutionListener
のafterTestMethod
- オーバーライド:
- クラス
AbstractTestExecutionListener
のafterTestMethod
- パラメーター:
testContext
- テストメソッドが実行されたテストコンテキスト ; 決してnull
- 例外:
ExceptionSE
- 例外の伝播を許可します- 関連事項: