The @SpringJUnitConfig annotation is a composed annotation provided by the Spring TestContext Framework for use with JUnit Jupiter (JUnit 5). It combines the functionality of @ExtendWith(SpringExtension.class) and @ContextConfiguration (last tutorial) into a single, convenient annotation. By using @SpringJUnitConfig, a test class is automatically registered with the SpringExtension and supplied with configuration metadata for loading the Spring ApplicationContext.
Definition of SpringJUnitConfigVersion: 7.0.3 package org.springframework.test.context.junit.jupiter;
@ExtendWith(SpringExtension.class)
@ContextConfiguration
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface SpringJUnitConfig {
@AliasFor(annotation = ContextConfiguration.class, attribute = "classes")
Class<?>[] value() default {}; 1
@AliasFor(annotation = ContextConfiguration.class)
Class<?>[] classes() default {}; 2
@AliasFor(annotation = ContextConfiguration.class)
String[] locations() default {}; 3
@AliasFor(annotation = ContextConfiguration.class)
Class<? extends ApplicationContextInitializer<?>>[] initializers()
default {}; 4
@AliasFor(annotation = ContextConfiguration.class)
boolean inheritLocations() default true; 5
@AliasFor(annotation = ContextConfiguration.class)
boolean inheritInitializers() default true; 6
@AliasFor(annotation = ContextConfiguration.class)
Class<? extends ContextLoader> loader()
default ContextLoader.class; 7
@AliasFor(annotation = ContextConfiguration.class)
String name() default ""; 8
}
This annotation simplifies test configuration by reducing boilerplate and making Spring-based tests easier to read and maintain. It supports the same configuration options as @ContextConfiguration, including specifying configuration classes or locations, while still enabling all TestContext features such as dependency injection, context caching, and transactional test execution.
Example
AppConfig
package com.logicbig.example;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan("com.logicbig.example")
public class AppConfig {
}
GreetingService
package com.logicbig.example;
import org.springframework.stereotype.Service;
@Service
public class GreetingService {
public String greet() {
return "Hello, World!";
}
}
GreetingServiceTest
package com.logicbig.example;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import static org.junit.jupiter.api.Assertions.assertEquals;
@SpringJUnitConfig(GreetingService.class)
class GreetingServiceTest {
@Autowired
GreetingService greetingService;
@Test
void testGreet() {
assertEquals("Hello, World!", greetingService.greet());
}
}
$ mvn test -Dtest=GreetingServiceTest
[INFO] Scanning for projects...
[INFO]
[INFO] ----< com.logicbig.example:spring-junit-config-annotation-example >-----
[INFO] Building spring-junit-config-annotation-example 1.0-SNAPSHOT
[INFO] from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- resources:3.3.1:resources (default-resources) @ spring-junit-config-annotation-example ---
[INFO] skip non existing resourceDirectory D:\example-projects\spring-core-testing\spring-junit-config-annotation-example\src\main\resources
[INFO]
[INFO] --- compiler:3.14.1:compile (default-compile) @ spring-junit-config-annotation-example ---
[INFO] Nothing to compile - all classes are up to date.
[INFO]
[INFO] --- resources:3.3.1:testResources (default-testResources) @ spring-junit-config-annotation-example ---
[INFO] skip non existing resourceDirectory D:\example-projects\spring-core-testing\spring-junit-config-annotation-example\src\test\resources
[INFO]
[INFO] --- compiler:3.14.1:testCompile (default-testCompile) @ spring-junit-config-annotation-example ---
[INFO] Nothing to compile - all classes are up to date.
[INFO]
[INFO] --- surefire:3.2.5:test (default-test) @ spring-junit-config-annotation-example ---
[INFO] Using auto detected provider org.apache.maven.surefire.junitplatform.JUnitPlatformProvider
[WARNING] file.encoding cannot be set as system property, use <argLine>-Dfile.encoding=...</argLine> instead
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.logicbig.example.GreetingServiceTest
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.595 s -- in com.logicbig.example.GreetingServiceTest
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.497 s
[INFO] Finished at: 2026-01-30T11:42:55+08:00
[INFO] ------------------------------------------------------------------------
Example ProjectDependencies and Technologies Used: - spring-context 7.0.3 (Spring Context)
Version Compatibility: 5.0.0.RELEASE - 7.0.3 Version compatibilities of spring-context with this example: Versions in green have been tested.
- spring-test 7.0.3 (Spring TestContext Framework)
- junit-jupiter-engine 6.0.2 (Module "junit-jupiter-engine" of JUnit)
- JDK 25
- Maven 3.9.11
|
