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

2022-09-01 00:35:12

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

@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;
}

使用 或 有什么区别?@ExtendWith(SpringExtension.class)@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());
        }
}

相关 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()
}

答案 1

什么是 Junit 扩展

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

阅读 Junit 5 扩展模型和注释:这里@ExtendWith

SpringExtension

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

public class SpringExtension
extends Object
implements BeforeAllCallback, AfterAllCallback, TestInstancePostProcessor, BeforeEachCallback, AfterEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback, ParameterResolver{..}

MockitoExtension

这个扩展是JUnit Jupiter相当于我们的JUnit4 MockitoJUnitRunner。

public class MockitoExtension
extends java.lang.Object
implements BeforeEachCallback, AfterEachCallback, ParameterResolver{..}

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

此外,@SpringBootTest是元注释的,这意味着每次使用 扩展测试时。@MockBean是一个Spring测试框架注释,与@ExtendWith(SpringExtension.class)SpringExtension@ExtendWith(SpringExtension.class)

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

ExtendWithMockitoExtension

@ExtendWith(MockitoExtension.class)
class TestServiceTest {

    @MockBean
    TestService service;

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

}

ExtendWithSpringExtension

@ExtendWith(SpringExtension.class)
class TestServiceTest {

    @MockBean
    TestService service;

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

}

ExtendWith同时包含和SpringExtensionMockitoExtension

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

    @MockBean
    TestService service;

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

}

两者都适用于您的情况,因为测试类的注释如前所述。@SpringBootTest

回答问题:什么时候使用Spring或Mockito?,@ExtendWith

当测试需要一个弹簧测试上下文(自动连接一个bean/使用)以及JUnit 5的Jupiter编程模型使用。这也将通过TestExecutionListeners支持Mockito注释。@MockBean@ExtendWith(SpringExtension.class)

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

希望这有帮助


答案 2

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

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

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

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


推荐