测试Spring Boot应用的主类

1. 概述

测试Spring Boot应用的主类至关重要，它能确保应用正确启动。 虽然单元测试通常关注单个组件，但验证应用上下文能否正常加载可以防止生产环境中的运行时错误。

本文将探讨几种有效测试Spring Boot应用主类的策略。

2. 项目准备

首先我们搭建一个简单的Spring Boot应用。可以使用Spring Initializr生成基础项目结构。

2.1 Maven依赖

项目需要以下核心依赖：

**Spring Boot Starter**：构建Spring Boot应用的核心依赖
**Spring Boot Starter Test**：提供JUnit、AssertJ等测试库
**Mockito Core**：用于创建和验证模拟对象的Mock框架

在pom.xml中添加如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>4.0.0</version>
    <scope>test</scope>
</dependency>

2.2 主应用类

主应用类是Spring Boot应用的核心，它既是应用入口点，也是主配置类。典型结构如下：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

关键元素解析：

@SpringBootApplication注解：组合了三个核心注解
- @Configuration：标记为Bean定义源
- @EnableAutoConfiguration：基于classpath自动配置
- @ComponentScan：扫描并注册Spring组件
main()方法：
- 应用入口点
- 调用SpringApplication.run()启动应用
- 接收命令行参数（如--spring.profiles.active=dev）
**SpringApplication.run()**：
- 创建并加载应用上下文
- 启动嵌入式Web服务器（如Tomcat）
- 应用运行时配置

2.3 主类定制与测试

虽然推荐在application.properties中集中管理配置，但也可以直接在主类中定制：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(Application.class);
        app.setAdditionalProfiles("dev");
        app.run(args);
    }
}

3. 测试策略

我们将从基础上下文加载测试到模拟和命令行参数处理，逐步探索多种测试方法。

3.1 基础上下文加载测试

最简单的测试方式是使用@SpringBootTest：

@SpringBootTest
public class ApplicationContextTest {
    @Test
    void contextLoads() {
    }
}

✅ 优点：加载完整应用上下文，能检测Bean配置问题
⚠️ 注意：大型应用中可考虑只加载特定Bean以提升速度

3.2 直接测试`main()`方法

为满足SonarQube等工具的覆盖率要求，可直接测试main()方法：

public class ApplicationMainTest {
    @Test
    public void testMain() {
        Application.main(new String[]{});
    }
}

❌ 缺点：不加载完整上下文，仅验证方法不抛异常
✅ 适用场景：快速验证方法基本可用性

3.3 模拟`SpringApplication.run()`

当main()方法包含额外逻辑时（如参数处理/日志记录），可通过Mockito模拟启动过程：

步骤1：重构主类提取可测试方法

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        initializeApplication(args);
    }

    static ConfigurableApplicationContext initializeApplication(String[] args) {
        return SpringApplication.run(Application.class, args);
    }
}

步骤2：编写模拟测试

public class ApplicationMockTest {
    @Test
    public void testMainWithMock() {
        try (MockedStatic<SpringApplication> springApplicationMock = mockStatic(SpringApplication.class)) {
            ConfigurableApplicationContext mockContext = mock(ConfigurableApplicationContext.class);
            springApplicationMock.when(() -> SpringApplication.run(Application.class, new String[] {}))
              .thenReturn(mockContext);

            Application.main(new String[] {});

            springApplicationMock.verify(() -> SpringApplication.run(Application.class, new String[] {}));
        }
    }
}

✅ 优势：

避免完整上下文启动，提升测试速度
可验证main()方法中的额外逻辑
支持参数验证

3.4 使用`@SpringBootTest`的`useMainMethod`属性

Spring Boot 2.2+支持通过主方法启动上下文：

@SpringBootTest(useMainMethod = SpringBootTest.UseMainMethod.ALWAYS)
public class ApplicationUseMainTest {
    @Test
    public void contextLoads() {
    }
}

✅ 适用场景：

主方法包含关键初始化逻辑
需要同时验证上下文加载和主方法执行
追求更高代码覆盖率

3.5 排除主类覆盖率

当主类不包含关键业务逻辑时，可将其排除在覆盖率统计之外：

方案1：使用@Generated注解

@SpringBootApplication
public class Application {
    @Generated(value = "Spring Boot")
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

方案2：使用@SuppressWarnings

@SpringBootApplication
public class Application {
    @SuppressWarnings("unused")
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

方案3：工具配置排除

JaCoCo配置（pom.xml）：

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.7</version>
    <configuration>
        <excludes>
            <exclude>com/example/demo/Application*</exclude>
        </excludes>
    </configuration>
</plugin>

SonarQube配置（sonar-project.properties）：

sonar.exclusions=src/main/java/com/example/demo/Application.java

⚠️ 建议：优先使用@Generated注解，工具兼容性更好

3.6 处理命令行参数

测试带参数的启动场景：

public class ApplicationArgumentsTest {
    @Test
    public void testMainWithArguments() {
        String[] args = { "--spring.profiles.active=test" };
        Application.main(args);
    }
}

✅ 验证点：

指定Profile是否生效
自定义参数是否正确解析
参数异常处理逻辑

4. 总结

测试Spring Boot主类能确保应用正确启动并提升代码覆盖率。我们探讨了多种策略：

测试方式	适用场景	执行速度	覆盖范围
基础上下文加载	验证整体配置	慢	高
直接调用main()	满足覆盖率要求	最快	低
模拟SpringApplication	包含额外逻辑时	快	中
useMainMode	需要完整启动流程	慢	最高

最佳实践建议：

优先使用@SpringBootTest进行集成测试
对包含复杂逻辑的主方法采用模拟测试
简单主类可直接排除覆盖率
关键参数场景需单独测试

通过合理组合这些策略，既能保障启动流程的可靠性，又能平衡测试执行效率，在开发早期发现潜在问题。

完整示例代码请参考GitHub仓库

Persistence

REST

Security