Annotation Type JsonTest
@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @BootstrapWith(org.springframework.boot.test.autoconfigure.json.JsonTestContextBootstrapper.class) @OverrideAutoConfiguration(enabled=false) @TypeExcludeFilters(org.springframework.boot.test.autoconfigure.json.JsonExcludeFilter.class) @AutoConfigureCache @AutoConfigureJson @AutoConfigureJsonTesters @ImportAutoConfiguration public @interface JsonTest
Annotation that can be used in combination with@RunWith(SpringRunner.class)
for a typical JSON test. Can be used when a test focuses only on JSON serialization.Using this annotation will disable full auto-configuration and instead apply only configuration relevant to JSON tests (i.e.
@JsonComponent
, JacksonModule
)By default, tests annotated with
JsonTest
will also initializeJacksonTester
,JsonbTester
andGsonTester
fields. More fine-grained control can be provided via the@AutoConfigureJsonTesters
annotation.- Since:
- 1.4.0
- See Also:
AutoConfigureJson
,AutoConfigureJsonTesters
,AutoConfigureCache
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Class<?>[]
excludeAutoConfiguration
Auto-configuration exclusions that should be applied for this test.org.springframework.context.annotation.ComponentScan.Filter[]
excludeFilters
A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.org.springframework.context.annotation.ComponentScan.Filter[]
includeFilters
A set of include filters which can be used to add otherwise filtered beans to the application context.String[]
properties
Properties in form key=value that should be added to the SpringEnvironment
before the test runs.boolean
useDefaultFilters
Determines if default filtering should be used with@SpringBootApplication
.
Element Detail
properties
String[] properties
Properties in form key=value that should be added to the SpringEnvironment
before the test runs.- Returns:
- the properties to add
- Since:
- 2.1.0
- Default:
- {}
useDefaultFilters
boolean useDefaultFilters
Determines if default filtering should be used with@SpringBootApplication
. By default only@JsonComponent
andModule
beans are included.- Returns:
- if default filters should be used
- See Also:
includeFilters()
,excludeFilters()
- Default:
- true
includeFilters
org.springframework.context.annotation.ComponentScan.Filter[] includeFilters
A set of include filters which can be used to add otherwise filtered beans to the application context.- Returns:
- include filters to apply
- Default:
- {}
excludeFilters
org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters
A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.- Returns:
- exclude filters to apply
- Default:
- {}
excludeAutoConfiguration
@AliasFor(annotation=org.springframework.boot.autoconfigure.ImportAutoConfiguration.class, attribute="exclude") Class<?>[] excludeAutoConfiguration
Auto-configuration exclusions that should be applied for this test.- Returns:
- auto-configuration exclusions to apply
- Default:
- {}