Spring Boot 基于 JUnit 5 实现多模块工程单元测试

在 Spring Boot 基于 JUnit 5 实现单元测试 文中已介绍在单个 Spring Boot 应用中如何使用 JUnit 5 完成单元测试，本文介绍当 Spring Boot 应用作为多模块工程的一个模块组件时，如何使用 JUnit 5 实现单元测试。

---

目录

• 工程模块说明
• 示例

---

工程模块说明

创建一个如下结构的工程：

spring-boot-junit5-multi-modules：工程根目录
|-- application：Spring Boot 应用，独立运行服务

---

示例

1. 创建 Maven 工程 spring-boot-junit5-multi-modules；

2. 在 spring-boot-junit5-multi-modules 工程下新建模块（Module），选中 Spring Initializr 创建 Spring Boot 应用 application，修改自动生成的 pom.xml 文件内容如下：

    
        spring-boot-junit5-multi-modules
        tutorial.spring.boot
        1.0-SNAPSHOT
    
    4.0.0

    application

    
        2.2.6.RELEASE
    

    
        
            
                org.springframework.boot
                spring-boot-dependencies
                ${spring.boot.version}
                pom
                import
            
        
    

    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
            
                
                    org.junit.vintage
                    junit-vintage-engine
                
            
        
    

    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.8.1
                
                    ${java.version}
                    ${java.version}
                    ${project.build.sourceEncoding}
                
            
            
                org.springframework.boot
                spring-boot-maven-plugin
                ${spring.boot.version}
                
                    
                        tutorial.spring.boot.Application
                    
                
                
                    
                        
                            repackage
                        
                    
                
            
        
    

3. 修改主工程 pom.xml 文件。

    4.0.0

    tutorial.spring.boot
    spring-boot-junit5-multi-modules
    pom
    1.0-SNAPSHOT
    
        application
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.8.1
                
                    ${java.version}
                    ${java.version}
                    ${project.build.sourceEncoding}
                
            
        
    

4. 在 application 中创建一个 Service 层接口。

package tutorial.spring.boot.service;

public interface DemoService {
}

5. 创建 Service 层接口实现。

package tutorial.spring.boot.service.impl;

import org.springframework.stereotype.Service;
import tutorial.spring.boot.service.DemoService;

@Service
public class DemoServiceImpl implements DemoService {
}

6. 创建 Service 层单元测试，测试 Service 层实例是否已生成。

package tutorial.spring.boot.service;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class DemoServiceTest {

    @Autowired
    private DemoService demoService;

    @Test
    public void testNotNull() {
        Assertions.assertThat(demoService).isNotNull();
    }
}

7. 在 IDE 中直接运行单元测试（Run 'DemoServiceTest'），测试通过（过程略）。

8. 在项目根目录下运行 mvn test，测试失败，日志如下：

[INFO] 
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ application ---
[INFO] Surefire report directory: D:\spring-boot-junit5-multi-modules\application\target\surefire-reports
-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running tutorial.spring.boot.service.DemoServiceTest
Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.246 sec <<< FAILURE!
tutorial.spring.boot.service.DemoServiceTest.testNotNull()  Time elapsed: 0.246 sec  <<< FAILURE!
java.lang.AssertionError: 
Expecting actual not to be null
    at tutorial.spring.boot.service.DemoServiceTest.testNotNull(DemoServiceTest.java:16)
Results :
(..)
Tests run: 1, Failures: 1, Errors: 0, Skipped: 0

从日志中可以看出，单元测试并未运行 Spring 上下文，导致找不到依赖 Spring IOC 注入的实例对象。

分析：
Maven 运行 JUnit 5 单元测试需要添加以下依赖：

• unit-jupiter-api
• junit-jupiter-engine
• maven-surefire-plugin

前两个是 JUnit 5 相关依赖，已通过 spring-boot-starter-test 引入。maven-surefire-plugin 必须使用 2.22.0 及以上版本。

9. 修改主工程 pom.xml 文件，添加 maven-surefire-plugin 依赖。

    4.0.0

    tutorial.spring.boot
    spring-boot-junit5-multi-modules
    pom
    1.0-SNAPSHOT
    
        application
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.8.1
                
                    ${java.version}
                    ${java.version}
                    ${project.build.sourceEncoding}
                
            
            
                org.apache.maven.plugins
                maven-surefire-plugin
                2.22.2
            
        
    

10. 在项目根目录下再次运行 mvn test，测试成功，从日志中可以看出已启动 Spring 上下文（测试日志略）。