Package org.springframework.test.context.bean.override.mockito

Annotation Interface MockitoBean

@Target(FIELD)
@Retention(RUNTIME)
@Documented
@BeanOverride(org.springframework.test.context.bean.override.mockito.MockitoBeanOverrideProcessor.class)
public @interface MockitoBean

@MockitoBean is an annotation that can be applied to a non-static field in a test class to override a bean in the test's ApplicationContext using a Mockito mock.

By default, the bean to mock is inferred from the type of the annotated field. If multiple candidates exist, a @Qualifier annotation can be used to help disambiguate. In the absence of a @Qualifier annotation, the name of the annotated field will be used as a fallback qualifier. Alternatively, you can explicitly specify a bean name to mock by setting the value or name attribute.

A bean will be created if a corresponding bean does not exist. However, if you would like for the test to fail when a corresponding bean does not exist, you can set the enforceOverride attribute to true — for example, @MockitoBean(enforceOverride = true).

Dependencies that are known to the application context but are not beans (such as those registered directly) will not be found, and a mocked bean will be added to the context alongside the existing dependency.

NOTE: Only singleton beans can be mocked. Any attempt to mock a non-singleton bean will result in an exception. When mocking a bean created by a FactoryBean, the FactoryBean will be replaced with a singleton mock of the type of object created by the FactoryBean.

There are no restrictions on the visibility of a @MockitoBean field. Such fields can therefore be public, protected, package-private (default visibility), or private depending on the needs or coding practices of the project.

Since:

6.2

Author:

Simon Baslé, Sam Brannen

See Also:

• @MockitoSpyBean
• @TestBean

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
org.mockito.Answers	answers	The Answers type to use in the mock.
boolean	enforceOverride	Whether to require the existence of the bean being mocked.
Class<?>[]	extraInterfaces	Extra interfaces that should also be declared by the mock.
String	name	Name of the bean to mock.
MockReset	reset	The reset mode to apply to the mock.
boolean	serializable	Whether the generated mock is serializable.
String	value	Alias for name().

Element Details

value

@AliasFor("name")
String value

Alias for name().

Intended to be used when no other attributes are needed — for example, @MockitoBean("customBeanName").

See Also:

• name()

Default:

""

name

@AliasFor("value")
String name

Name of the bean to mock.

If left unspecified, the bean to mock is selected according to the annotated field's type, taking qualifiers into account if necessary. See the class-level documentation for details.

See Also:

• value()

Default:

""

extraInterfaces

Class<?>[] extraInterfaces

Extra interfaces that should also be declared by the mock.

Defaults to none.

Returns:

any extra interfaces

See Also:

• MockSettings.extraInterfaces(Class...)

Default:

{}

answers

org.mockito.Answers answers

The Answers type to use in the mock.

Defaults to Answers.RETURNS_DEFAULTS.

Returns:

the answer type

Default:

RETURNS_DEFAULTS

serializable

boolean serializable

Whether the generated mock is serializable.

Defaults to false.

Returns:

true if the mock is serializable

See Also:

• MockSettings.serializable()

Default:

false

reset

MockReset reset

The reset mode to apply to the mock.

The default is MockReset.AFTER meaning that mocks are automatically reset after each test method is invoked.

Returns:

the reset mode

Default:

AFTER

enforceOverride

boolean enforceOverride

Whether to require the existence of the bean being mocked.

Defaults to false which means that a mock will be created if a corresponding bean does not exist.

Set to true to cause an exception to be thrown if a corresponding bean does not exist.

See Also:

• BeanOverrideStrategy.REPLACE_OR_CREATE
• BeanOverrideStrategy.REPLACE

Default:

false