mirror of
https://github.com/sweetwisdom/everything-claude-code-zh.git
synced 2026-03-22 14:40:14 +00:00
158 lines
4.0 KiB
Markdown
158 lines
4.0 KiB
Markdown
---
|
||
name: springboot-tdd
|
||
description: 使用 JUnit 5、Mockito、MockMvc、Testcontainers 和 JaCoCo 进行 Spring Boot 的测试驱动开发（TDD）。在添加功能、修复 Bug 或进行重构时使用。
|
||
---
|
||
|
||
# Spring Boot 测试驱动开发（TDD）工作流
|
||
|
||
针对 Spring Boot 服务的 TDD 指南，要求 80% 以上的覆盖率（单元测试 + 集成测试）。
|
||
|
||
## 适用场景
|
||
|
||
- 开发新功能或端点（Endpoints）
|
||
- 修复 Bug 或进行代码重构
|
||
- 添加数据访问逻辑或安全规则
|
||
|
||
## 工作流
|
||
|
||
1) 先写测试（测试应当失败）
|
||
2) 实现最少量的代码以使测试通过
|
||
3) 在测试通过（Green）的前提下进行重构
|
||
4) 强制执行覆盖率检查（JaCoCo）
|
||
|
||
## 单元测试（JUnit 5 + Mockito）
|
||
|
||
```java
|
||
@ExtendWith(MockitoExtension.class)
|
||
class MarketServiceTest {
|
||
@Mock MarketRepository repo;
|
||
@InjectMocks MarketService service;
|
||
|
||
@Test
|
||
void createsMarket() {
|
||
CreateMarketRequest req = new CreateMarketRequest("name", "desc", Instant.now(), List.of("cat"));
|
||
when(repo.save(any())).thenAnswer(inv -> inv.getArgument(0));
|
||
|
||
Market result = service.create(req);
|
||
|
||
assertThat(result.name()).isEqualTo("name");
|
||
verify(repo).save(any());
|
||
}
|
||
}
|
||
```
|
||
|
||
模式：
|
||
- Arrange-Act-Assert（准备-执行-断言）
|
||
- 避免部分打桩（Partial Mocks）；优先使用显式桩函数（Stubbing）
|
||
- 使用 `@ParameterizedTest` 处理多种变体场景
|
||
|
||
## Web 层测试（MockMvc）
|
||
|
||
```java
|
||
@WebMvcTest(MarketController.class)
|
||
class MarketControllerTest {
|
||
@Autowired MockMvc mockMvc;
|
||
@MockBean MarketService marketService;
|
||
|
||
@Test
|
||
void returnsMarkets() throws Exception {
|
||
when(marketService.list(any())).thenReturn(Page.empty());
|
||
|
||
mockMvc.perform(get("/api/markets"))
|
||
.andExpect(status().isOk())
|
||
.andExpect(jsonPath("$.content").isArray());
|
||
}
|
||
}
|
||
```
|
||
|
||
## 集成测试（SpringBootTest）
|
||
|
||
```java
|
||
@SpringBootTest
|
||
@AutoConfigureMockMvc
|
||
@ActiveProfiles("test")
|
||
class MarketIntegrationTest {
|
||
@Autowired MockMvc mockMvc;
|
||
|
||
@Test
|
||
void createsMarket() throws Exception {
|
||
mockMvc.perform(post("/api/markets")
|
||
.contentType(MediaType.APPLICATION_JSON)
|
||
.content("""
|
||
{"name":"Test","description":"Desc","endDate":"2030-01-01T00:00:00Z","categories":["general"]}
|
||
"""))
|
||
.andExpect(status().isCreated());
|
||
}
|
||
}
|
||
```
|
||
|
||
## 持久层测试（DataJpaTest）
|
||
|
||
```java
|
||
@DataJpaTest
|
||
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
|
||
@Import(TestContainersConfig.class)
|
||
class MarketRepositoryTest {
|
||
@Autowired MarketRepository repo;
|
||
|
||
@Test
|
||
void savesAndFinds() {
|
||
MarketEntity entity = new MarketEntity();
|
||
entity.setName("Test");
|
||
repo.save(entity);
|
||
|
||
Optional<MarketEntity> found = repo.findByName("Test");
|
||
assertThat(found).isPresent();
|
||
}
|
||
}
|
||
```
|
||
|
||
## Testcontainers
|
||
|
||
- 使用可重用的容器（如 Postgres/Redis）来模拟生产环境
|
||
- 通过 `@DynamicPropertySource` 进行连接，将 JDBC URL 注入到 Spring 上下文中
|
||
|
||
## 覆盖率（JaCoCo）
|
||
|
||
Maven 配置片段：
|
||
```xml
|
||
<plugin>
|
||
<groupId>org.jacoco</groupId>
|
||
<artifactId>jacoco-maven-plugin</artifactId>
|
||
<version>0.8.14</version>
|
||
<executions>
|
||
<execution>
|
||
<goals><goal>prepare-agent</goal></goals>
|
||
</execution>
|
||
<execution>
|
||
<id>report</id>
|
||
<phase>verify</phase>
|
||
<goals><goal>report</goal></goals>
|
||
</execution>
|
||
</executions>
|
||
</plugin>
|
||
```
|
||
|
||
## 断言（Assertions）
|
||
|
||
- 为了提高可读性，优先选择 AssertJ (`assertThat`)
|
||
- 对于 JSON 响应，使用 `jsonPath`
|
||
- 对于异常测试：`assertThatThrownBy(...)`
|
||
|
||
## 测试数据构建器（Test Data Builders）
|
||
|
||
```java
|
||
class MarketBuilder {
|
||
private String name = "Test";
|
||
MarketBuilder withName(String name) { this.name = name; return this; }
|
||
Market build() { return new Market(null, name, MarketStatus.ACTIVE); }
|
||
}
|
||
```
|
||
|
||
## CI 命令
|
||
|
||
- Maven：`mvn -T 4 test` 或 `mvn verify`
|
||
- Gradle：`./gradlew test jacocoTestReport`
|
||
|
||
**记住**：保持测试快速、隔离且具有确定性。测试的是行为，而非实现细节。
|