Junit 5 与 Spring Boot:何时使用 @ExtendWith Spring 或 Mockito?

jav*_*900 23 java spring mockito junit5

我有以下抽象单元测试类,我的所有具体单元测试类都扩展了它:

@ExtendWith(SpringExtension.class)
//@ExtendWith(MockitoExtension.class)
@SpringBootTest(
    classes = PokerApplication.class,
    webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT
)
public abstract class AbstractUnitTests {

    @MockBean
    public RoundService roundService;

    @MockBean
    public RoundRepository roundRepository;
}
Run Code Online (Sandbox Code Playgroud)

@ExtendWith(SpringExtension.class)使用or 和有什么不一样@ExtendWith(MockitoExtension.class)

我问,使用任何一个注释似乎都没有什么区别,并且两者在我的代码中分别工作 - 允许我使用 Junit5。那么为什么两者都有效呢?

具体测试类:

    @DisplayName("Test RoundService")
    public class RoundsServiceTest extends AbstractUnitTests {

        private static String STUB_USER_ID = "user3";

        // class under test
        @InjectMocks
        RoundService roundService;

        private Round round;

        private ObjectId objectId;

        @BeforeEach //note this replaces the junit 4 @Before
        public void setUp() {

            initMocks(this);
            round = Mocks.round();
            objectId = Mocks.objectId();
        }

        @DisplayName("Test RoundService.getAllRoundsByUserId()")
        @Test
        public void shouldGetRoundsByUserId() {

            // setup
            given(roundRepository.findByUserId(anyString())).willReturn(Collections.singletonList(round));

            // call method under test
            List<Round> rounds = roundService.getRoundsByUserId(STUB_USER_ID);

            // asserts
            assertNotNull(rounds);
            assertEquals(1, rounds.size());
            assertEquals("user3", rounds.get(0).userId());
        }
}
Run Code Online (Sandbox Code Playgroud)

相关的 Build.gradle 部分

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
    compile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '2.2.2.RELEASE'

    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'

    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
    implementation 'junit:junit:4.12'
}

test {
    useJUnitPlatform()
}
Run Code Online (Sandbox Code Playgroud)

R.G*_*R.G 32

什么是 Junit 扩展

Junit 5 扩展的目的是扩展测试类或方法的行为

来源

阅读Junit 5 扩展模型@ExtendWith注释:此处

SpringExtension

SpringExtension 将 Spring TestContext 框架集成到 JUnit 5 的 Jupiter 编程模型中。

public class SpringExtension
extends Object
implements BeforeAllCallback, AfterAllCallback, TestInstancePostProcessor, BeforeEachCallback, AfterEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback, ParameterResolver{..}
Run Code Online (Sandbox Code Playgroud)

MockitoExtension

此扩展相当于我们的 JUnit4 MockitoJUnitRunner 的 JUnit Jupiter

public class MockitoExtension
extends java.lang.Object
implements BeforeEachCallback, AfterEachCallback, ParameterResolver{..}
Run Code Online (Sandbox Code Playgroud)

可以看出,SpringExtension实现的扩展比MockitoExtension.

@SpringBootTest用 和 进行元注释@ExtendWith(SpringExtension.class),这意味着每次您的测试都用 进行扩展SpringExtension@MockBean是一个 Spring 测试框架注释并与@ExtendWith(SpringExtension.class)

要观察差异,请尝试以下操作

ExtendWith仅有的MockitoExtension

@ExtendWith(MockitoExtension.class)
class TestServiceTest {

    @MockBean
    TestService service;

    @Test
    void test() {
        assertNotNull(service); // Test will fail
    }

}
Run Code Online (Sandbox Code Playgroud)

ExtendWith仅有的SpringExtension

@ExtendWith(SpringExtension.class)
class TestServiceTest {

    @MockBean
    TestService service;

    @Test
    void test() {
        assertNotNull(service); // Test succeeds
    }

}
Run Code Online (Sandbox Code Playgroud)

ExtendWith与两者SpringExtensionMockitoExtension

@ExtendWith(MockitoExtension.class)
@ExtendWith(SpringExtension.class)
class TestServiceTest {

    @MockBean
    TestService service;

    @Test
    void test() {
        assertNotNull(service); // Test succeeds
    }

}
Run Code Online (Sandbox Code Playgroud)

@SpringBootTest由于测试类的注释,两者都适用于您的情况,如所解释的。

回答这个问题:什么时候使用@ExtendWithSpring 还是 Mockito?,

当测试需要 Spring Test Context(自动装配 bean/使用@MockBean)以及 JUnit 5 的 Jupiter 编程模型时使用@ExtendWith(SpringExtension.class)。这也将通过 TestExecutionListener 支持 Mockito 注释。

当测试使用Mockito并且需要JUnit 5的Jupiter编程模型支持时使用@ExtendWith(MockitoExtension.class)

希望这可以帮助

  • 何时使用`@ExtendWith(SpringExtension.class)`或`@SpringBootTest`? (5认同)
  • 你曾经读过一些东西,然后想,我希望他们能写出这样的文档。 (2认同)

小智 18

何时使用@ExtendWith(SpringExtension.class)或@SpringBootTest?

  • 当您使用集成测试 - @SpringBootTest 注释 - 或任何切片测试 - @xxxTest 注释 - 您不需要 @ExtendWith(SpringExtension.class) 注释,因为提到的注释包含它。

  • 如果您测试@ConfigurationProperties,@Service,@Component注释的类(未在切片测试用例中定义 - 参考:Spring Boot参考文档测试/自动配置/切片测试项-,您可以使用@ExtendWith(SpringExtension.class)而不是@SpringBootTest。

观察:我希望使用 @ExtendWith(SpringExtension.class) 进行的测试比使用 @SpringBootTest 进行的相同测试更快。当我在 Eclipse 中执行测试时,我观察到相反的情况。

  • 在我们的例子中,我们使用 @SpringBootTest 并传入测试所需的特定配置类。如果我们只使用 @ExtendWith(SpringExtension.class),它会构建整个应用程序上下文,这当然需要更长的时间。 (3认同)