Java 集成测试详解及示例

模拟和存根

模拟和存根可帮助您隔离依赖项或模拟尚未实现的依赖项。在下面给出的示例中，我们正在为 UserRepository 类创建一个模拟。

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.*;public class UserServiceTest {@Testpublic void testCreateUser() {UserRepository userRepository = mock(UserRepository.class);UserService userService = new UserService(userRepository);User user = new User("John Doe", "john.doe@example.com");when(userRepository.save(user)).thenReturn(true);boolean result = userService.createUser(user);verify(userRepository, times(1)).save(user);assertEquals(true, result);}
}

设置H2数据库

H2 是一个内存数据库，由于其速度快且轻量，因此经常用于测试。要配置 H2 进行集成测试，您可以使用 Spring Boot 提供的 @DataJpaTest 注释。此注释设置了一个内存数据库，您可以使用 JPA 存储库与其交互。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import static org.junit.jupiter.api.Assertions.assertEquals;@DataJpaTest
public class UserRepositoryIntegrationTest {@Autowiredprivate UserRepository userRepository;@Testpublic void testSaveUser() {User user = new User("John", "johndoe@example.com");userRepository.save(user);User savedUser = userRepository.findByEmail("johndoe@example.com");assertEquals(user.getName(), savedUser.getName());assertEquals(user.getEmail(), savedUser.getEmail());}
}

需要注意的一点是，您的应用程序可能没有使用 H2 作为主数据库。在这种情况下，您没有模仿生产环境。如果您想在测试环境中使用数据库 PostgreSQL 或 MongoDB，则应该使用容器（稍后讨论）。

记录和报告

记录测试最简单的方法之一是通过日志记录。日志可以帮助您快速识别或复制应用程序中任何缺陷的根本原因。

这是使用 Logback 和 SLF4J 的简单日志设置。Logback 帮助我们自定义记录的消息。我们可以提供日期、时间、线程、日志级别、跟踪等详细信息。首先创建一个 logback.xml 文件并添加如下所示的配置。

<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %level - %msg%n</pattern> </encoder> </appender> <root level="debug"> <appender-ref ref="STDOUT" /> </root> 
</configuration>

这里，%d{HH:mm:ss.SSS} 打印时间（H 表示小时，m 表示分钟，s 表示秒，S 表示毫秒）。%thread、%level、%msg 和 %n 分别打印线程名称、日志级别、消息和换行符。上面创建的附加程序在标准输出中显示信息。但您可以执行诸如将日志存储在文件中之类的操作。

现在我们可以在我们的 Java 代码中使用来自 SLF4J 的 Logger 外观。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class ExampleTest {private static final Logger logger= LoggerFactory.getLogger(ExampleTest.class);public static void main(String[] args) {logger.info("Hello from {}", ExampleTest.class.getSimpleName());}
}

如果你运行它，输出将会是这样的：

14:45:01.260 [main] INFO - Hello from ExampleTest

运行容器化测试

Docker 容器是模拟生产环境的最佳方式之一，因为在许多情况下，您的应用程序本身就运行在某些远程容器中。为了进行这些演示，我们将编写一个简单的测试，然后在 docker 容器中运行它。

// SampleController.java
@RestController
public class SampleController {@GetMapping("/hello")public String sayHello() {return "Hello world";}
}// SampleApplication.java
@SpringBootApplication
public class SampleApplication {public static void main(String[] args) {SpringApplication.run(SampleApplication.class, args);}
}

上面的代码创建了一个返回“Hello world”的简单 REST api。我们可以使用 Spring Boot Test 来测试这个 api。在这里，我们只是检查 api 是否返回响应，并且响应主体必须包含“Hello world”。

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class SampleApplicationTests {@LocalServerPortprivate int port;@Autowiredprivate TestRestTemplate restTemplate;@Testpublic void testHelloEndpoint() {ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:" + port + "/hello", String.class);assertEquals(HttpStatus.OK, response.getStatusCode());assertEquals("Hello, World!", response.getBody());}
}

现在，您可以创建一个 Dockerfile 并添加以下配置。Dockerfile 包含有关如何构建应用程序的说明。

FROM openjdk:17-jre-slim
WORKDIR /app
COPY target/sample-application.jar .
CMD ["java", "-jar", "sample-application.jar"]

运行以下命令来构建并启动您的docker容器。

docker build -t sample-application .
docker run -d -p 8080:8080 sample-application

您可以使用 docker-compose 来编排多个容器。docker compose 的一个挑战是当您运行集成测试时；您无法在运行时更改配置。此外，即使测试失败，您的容器仍将继续运行。相反，我们将使用一个名为 testcontainers 的库来动态启动和停止容器。

测试容器

Testcontainers 是一个 Java 库，可简化运行隔离的一次性容器以进行集成测试的过程。它为流行的数据库（例如 PostgreSQL、MySQL、Oracle、MongoDB）、消息代理（例如 Kafka、RabbitMQ）、Web 服务器（例如 Tomcat、Jetty）等提供轻量级、预配置的容器。

使用 Testcontainers，您可以在 Java 集成测试中定义和管理容器，这样您就可以针对依赖项的真实实例进行测试，而无需外部基础架构。Testcontainers 负责容器生命周期管理、自动配置以及与 JUnit 或 TestNG 等测试框架的集成。

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import static org.junit.Assert.*;@Testcontainers
public class PostgreSQLIntegrationTest {@Containerprivate static final PostgreSQLContainer<?> postgresContainer = new PostgreSQLContainer<>("postgres:latest").withDatabaseName("db_name").withUsername("johndoe").withPassword("random_password");@Testpublic void testPostgreSQLContainer() {assertTrue(postgresContainer.isRunning())}
}

编写集成测试的最佳实践

尽早开始编写单元测试和集成测试

在传统的瀑布式方法中，任务是按顺序执行的。测试通常在开发周期的后期进行。由于您的应用程序稍后进行测试，因此错误被忽视并进入生产环境的可能性相当高。

相比之下，采用敏捷方法，您可以尽早开始编写测试。这可以确保每次对代码库进行小幅更改时，您都会立即收到反馈，了解更改是否对现有代码库产生影响。如果单元测试失败并且您意识到存在问题，您可以立即解决它，以免它在后期变成大问题。这是敏捷方法的主要优势，尽早编写测试可以提供持续的反馈，从而更难在任何阶段引入错误。

确定测试优先级

集成测试可能很慢，在需要大量时间和资源的情况下，重复运行它们变得不切实际。在这种情况下，对测试进行优先级排序可以节省大量宝贵的时间。您可以根据与故障相关的风险级别、所测试功能的复杂性以及对最终用户或整个系统的潜在影响等因素对测试进行优先级排序。

在 Junit5 中，使用测试类，您可以为测试添加标签并设置优先级。以下是示例。

// SampleTests.java
public class SampleTests {@Test@Tag("HIGH")public void testCriticalFunctionality() {}@Test@Tag("LOW")public void testLessCriticalFunctionality() {}
}// HighPriorityTestSuite.java
// only testing the high priority integrations
import org.junit.platform.suite.api.IncludeTags;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.Suite;@Suite
@IncludeTags("HIGH")
public class HighPriorityTestSuite {}

尽可能模拟生产环境

创建尽可能与生产环境相似的测试环境。这包括设置类似的配置、数据库、网络条件和任何外部依赖项。

为所有场景设计测试用例

设计测试用例并确定适合所有场景的正确测试方法。创建涵盖各种场景和边缘情况的测试用例和测试方法，以确保最大覆盖范围。测试正面场景并进行负面集成测试，以验证系统在不同情况下的行为。

记录并报告您的测试

当集成测试失败时，尤其是在大型软件项目中，找出原因可能非常耗时。集成测试失败后，记录测试运行情况会很有帮助，这样您就可以轻松找出根本原因或重现问题。

结论

在本文中，我们探讨了 Java 集成测试的概念、优势和各种 Java 集成测试框架。我们还介绍了如何使用 JUnit5、Spring Boot Test、TestContainers 和 Logback 等框架编写有效的集成测试。集成测试至关重要，因此集成测试在确保Java 应用程序的性能、质量和功能方面起着至关重要的作用。它还允许我们验证不同组件和层之间的交互和依赖关系。