アノテーションインターフェース SpringBootTest
@TargetSE(TYPESE)
@RetentionSE(RUNTIMESE)
@DocumentedSE
@InheritedSE
@BootstrapWith(SpringBootTestContextBootstrapper.class)
@ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class)
public @interface SpringBootTest
Spring Boot ベースのテストを実行するテストクラスで指定できるアノテーション。通常の Spring TestContext フレームワークに加えて、次の機能を提供します。
- 特定の
@ContextConfiguration(loader=...)
が定義されていない場合、SpringBootContextLoader
をデフォルトのContextLoader
として使用します。 - ネストされた
@Configuration
が使用されておらず、明示的なclasses
が指定されていない場合、@SpringBootConfiguration
を自動的に検索します。 properties attribute
を使用して、カスタムEnvironment
プロパティを定義できます。args attribute
を使用してアプリケーション引数を定義できます。defined
またはrandom
ポートでリッスンしている完全に実行されている Web サーバーを開始する機能を含む、さまざまなwebEnvironment
モードのサポートを提供します。- 完全に実行されている Web サーバーを使用している Web テストで使用するために、
TestRestTemplate
および / またはWebTestClient
Bean を登録します。
- 導入:
- 1.4.0
- 作成者:
- Phillip Webb, Andy Wilkinson
- 関連事項:
ネストされたクラスのサマリー
修飾子と型クラス説明static enum
テスト対象のSpringApplication
を作成および実行するときに、@SpringBootConfiguration
アノテーション付きクラスのメインメソッドがどのように使用されるかの列挙。static enum
列挙 Web 環境モード。オプション要素のサマリー
修飾子と型オプションの要素説明StringSE[]
テスト対象のアプリケーションに渡す必要のあるアプリケーション引数。ClassSE<?>[]
ApplicationContext
のロードに使用するコンポーネントクラス。StringSE[]
テストの実行前に SpringEnvironment
に追加する必要がある key = value 形式のプロパティ。テスト対象のSpringApplication
を作成するときに使用するメインメソッドの使用メソッドの型。StringSE[]
properties()
のエイリアス。該当する場合に作成する Web 環境の型。
要素の詳細
value
properties()
のエイリアス。- 戻り値:
- 適用するプロパティ
- デフォルト:
- {}
properties
テストの実行前に SpringEnvironment
に追加する必要がある key = value 形式のプロパティ。- 戻り値:
- 追加するプロパティ
- デフォルト:
- {}
args
StringSE[] argsテスト対象のアプリケーションに渡す必要のあるアプリケーション引数。- 戻り値:
- テスト対象のアプリケーションに渡すアプリケーション引数。
- 導入:
- 2.2.0
- 関連事項:
- デフォルト:
- {}
classes
ClassSE<?>[] classesApplicationContext
のロードに使用するコンポーネントクラス。@ContextConfiguration(classes=...)
を使用して指定することもできます。明示的なクラスが定義されていない場合、テストは、@SpringBootConfiguration
検索にフォールバックする前に、ネストされた@Configuration
クラスを探します。- 戻り値:
- アプリケーションコンテキストのロードに使用されるコンポーネントクラス
- 関連事項:
- デフォルト:
- {}
webEnvironment
SpringBootTest.WebEnvironment webEnvironment該当する場合に作成する Web 環境の型。デフォルトはSpringBootTest.WebEnvironment.MOCK
です。- 戻り値:
- Web 環境の種類
- デフォルト:
- MOCK
useMainMethod
SpringBootTest.UseMainMethod useMainMethodテスト対象のSpringApplication
を作成するときに使用するメインメソッドの使用メソッドの型。- 戻り値:
- メインメソッドの使用の型
- 導入:
- 3.0.0
- デフォルト:
- NEVER