パッケージ org.springframework.boot.test.autoconfigure.web.client

アノテーションインターフェース RestClientTest

@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE @InheritedSE @BootstrapWith(org.springframework.boot.test.autoconfigure.web.client.RestClientTestContextBootstrapper.class) @ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class) @OverrideAutoConfiguration(enabled=false) @TypeExcludeFilters(RestClientTypeExcludeFilter.class) @AutoConfigureCache @AutoConfigureWebClient @AutoConfigureMockRestServiceServer @ImportAutoConfiguration public @interface RestClientTest
RestTemplateBuilder または RestClient.Builder を使用する Bean のみに焦点を当てた Spring 残りのクライアントテストのアノテーション。

このアノテーションを使用すると、REST クライアントテストに関連する自動構成のみが有効になります。同様に、コンポーネントスキャンは、次のアノテーションが付けられた Bean に制限されます。

  • @JsonComponent

また、次のものを実装する Bean もあります。

  • Module（Jackson が利用可能な場合）

デフォルトでは、RestClientTest でアノテーションが付けられたテストも MockRestServiceServer を自動構成します。より細かい制御のために、@AutoConfigureMockRestServiceServer アノテーションを使用できます。

RestTemplateBuilder を使用せずに RestTemplate を直接注入する Bean をテストする場合は、@AutoConfigureWebClient(registerRestTemplate=true) を追加できます。

JUnit 4 を使用する場合、このアノテーションは @RunWith(SpringRunner.class) と組み合わせて使用する必要があります。

導入:
1.4.0
作成者:
Stephane Nicoll, Phillip Webb, Artsiom Yudovin

  • オプション要素のサマリー

    オプション要素
    修飾子と型
    オプションの要素
    説明
    ClassSE<?>[]
    components
    テストするコンポーネントを指定します。
    ClassSE<?>[]
    excludeAutoConfiguration
    このテストに適用する必要がある自動構成の除外。
    ComponentScan.Filter[]
    excludeFilters
    それ以外の場合はアプリケーションコンテキストに追加される Bean のフィルタリングに使用できる除外フィルターのセット。
    ComponentScan.Filter[]
    includeFilters
    他の方法でフィルタリングされた Bean をアプリケーションコンテキストに追加するために使用できる一連の組み込みフィルター。
    StringSE[]
    properties
    テストの実行前に Spring Environment に追加する必要がある key = value 形式のプロパティ。
    boolean
    useDefaultFilters
    @SpringBootApplication でデフォルトのフィルタリングを使用するかどうかを決定します。
    ClassSE<?>[]
    value
    テストするコンポーネントを指定します。

  • 要素の詳細

    • properties

      StringSE[] properties
      テストの実行前に Spring Environment に追加する必要がある key = value 形式のプロパティ。
      戻り値:
      追加するプロパティ
      導入:
      2.1.0
      デフォルト:
      {}

    • value

      @AliasFor("components") ClassSE<?>[] value
      テストするコンポーネントを指定します。これは components() のエイリアスであり、他の属性が定義されていない場合に簡潔にするために使用できます。詳細については、components() を参照してください。
      戻り値:
      テストするコンポーネント
      関連事項:
      デフォルト:
      {}

    • components

      @AliasFor("value") ClassSE<?>[] components
      テストするコンポーネントを指定します。コンポーネントを手動でインポートまたは直接作成する場合は、空白のままにすることができます。
      戻り値:
      テストするコンポーネント
      関連事項:
      デフォルト:
      {}

    • useDefaultFilters

      boolean useDefaultFilters
      デフォルトのフィルタリングを @SpringBootApplication で使用するかどうかを決定します。デフォルトでは、@JsonComponent および Module Bean のみが含まれています。
      戻り値:
      デフォルトのフィルターを使用する必要がある場合
      関連事項:
      デフォルト:
      true

    • includeFilters

      ComponentScan.Filter[] includeFilters
      他の方法でフィルタリングされた Bean をアプリケーションコンテキストに追加するために使用できる一連の組み込みフィルター。
      戻り値:
      適用するフィルターを含める
      デフォルト:
      {}

    • excludeFilters

      ComponentScan.Filter[] excludeFilters
      それ以外の場合はアプリケーションコンテキストに追加される Bean のフィルタリングに使用できる除外フィルターのセット。
      戻り値:
      適用するフィルターを除外する
      デフォルト:
      {}

    • excludeAutoConfiguration

      @AliasFor(annotation=ImportAutoConfiguration.class, attribute="exclude") ClassSE<?>[] excludeAutoConfiguration
      このテストに適用する必要がある自動構成の除外。
      戻り値:
      適用する自動構成除外
      デフォルト:
      {}