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

@MockitoBean は、テストクラスで使用して、テストの ApplicationContext 内の Bean を Mockito モックでオーバーライドできるアノテーションです。

@MockitoBean は次のように適用できます。

• テストクラスまたはそのスーパークラスの非静的フィールド。
• @Nested テストクラスの包含クラス内の非静的フィールド、または @Nested テストクラスの上位の型階層または包含クラス階層内の任意のクラス。
• テストクラスの型レベル、またはテストクラスの上位の型階層内の任意のスーパークラスまたは実装されたインターフェース。
• @Nested テストクラスの包含クラスの型レベル、または @Nested テストクラスの上位の型階層または包含クラス階層内の任意のクラスまたはインターフェース。

フィールドで @MockitoBean が宣言されている場合、モックする Bean はアノテーション付きフィールドの型から推論されます。ApplicationContext に複数の候補が存在する場合は、曖昧さを解消するために、フィールドに @Qualifier アノテーションを宣言できます。@Qualifier アノテーションがない場合、アノテーション付きフィールドの名前がフォールバック修飾子として使用されます。または、value または name 属性を設定することで、モックする Bean 名を明示的に指定することもできます。

@MockitoBean が型 レベルで宣言されている場合、モックする Bean (または Bean) の型は、types 属性を介して指定する必要があります。ApplicationContext に複数の候補が存在する場合は、name 属性を設定することで、モックする Bean 名を明示的に指定できます。ただし、明示的な Bean name が構成されている場合、types 属性には単一の型が含まれている必要があることに注意してください。

対応する Bean が存在しない場合は、Bean が作成されます。ただし、対応する Bean が存在しない場合にテストを失敗させたい場合は、enforceOverride 属性を true (たとえば、@MockitoBean(enforceOverride = true)) に設定できます。

アプリケーションコンテキストに認識されているが Bean ではない依存関係 ( 直接登録されているものなど) は検出されず、既存の依存関係とともにモック Bean がコンテキストに追加されます。

警告 : @MockitoBean を @ContextHierarchy と組み合わせて使用すると、各 @MockitoBean がデフォルトですべてのコンテキスト階層レベルに適用されるため、望ましくない結果が生じる可能性があります。特定の @MockitoBean が単一のコンテキスト階層レベルに適用されるようにするには、contextName を、設定された @ContextConfiguration name と一致するように設定してください。詳細と例については、@ContextHierarchy の Javadoc を参照してください。

注意 : シングルトン Bean のみをモックできます。非シングルトン Bean をモックしようとすると例外が発生します。FactoryBean によって作成された Bean をモックする場合、FactoryBean は FactoryBean によって作成されたオブジェクトの型のシングルトンモックに置き換えられます。

@MockitoBean フィールドの可視性に制限はありません。このようなフィールドは、プロジェクトのニーズやコーディング方法に応じて、public、protected、パッケージプライベート (デフォルトの可視性)、または private になります。

@MockitoBean フィールドと型レベルの @MockitoBean 宣言は、デフォルトで、囲んでいるテストクラスから継承されます。詳細については、@NestedTestConfiguration を参照してください。

@MockitoBean は、カスタム合成アノテーションを作成するためのメタアノテーションとして使用できます。たとえば、テストスイート全体で再利用できる単一のアノテーションで共通のモック構成を定義することができます。@MockitoBean は、型レベルで繰り返し可能なSEアノテーションとしても使用できます。たとえば、name で複数の Bean をモックすることができます。