Spring Boot 验证循环
在提交PR前、重大变更后以及预部署时运行。
何时激活
- 在打开Spring Boot服务的拉取请求之前
- 重大重构或依赖升级之后
- 预部署验证(针对预发布或生产环境)
- 运行完整的构建 → 代码检查 → 测试 → 安全扫描流水线
- 验证测试覆盖率是否达到阈值
阶段一:构建
mvn -T 4 clean verify -DskipTests
# 或者
./gradlew clean assemble -x test
如果构建失败,停止并修复。
阶段二:静态分析
Maven(常用插件):
mvn -T 4 spotbugs:check pmd:check checkstyle:check
Gradle(如已配置):
./gradlew checkstyleMain pmdMain spotbugsMain
阶段三:测试 + 覆盖率
mvn -T 4 test
mvn jacoco:report # 验证 80% 以上的覆盖率
# 或者
./gradlew test jacocoTestReport
报告:
- 总测试数、通过/失败
- 覆盖率%(行/分支)
单元测试
在隔离环境中测试服务逻辑,使用模拟依赖:
@ExtendWith(MockitoExtension.class)
class UserServiceTest {
@Mock private UserRepository userRepository;
@InjectMocks private UserService userService;
@Test
void createUser_validInput_returnsUser() {
var dto = new CreateUserDto("Alice", "[email protected]");
var expected = new User(1L, "Alice", "[email protected]");
when(userRepository.save(any(User.class))).thenReturn(expected);
var result = userService.create(dto);
assertThat(result.name()).isEqualTo("Alice");
verify(userRepository).save(any(User.class));
}
@Test
void createUser_duplicateEmail_throwsException() {
var dto = new CreateUserDto("Alice", "[email protected]");
when(userRepository.existsByEmail(dto.email())).thenReturn(true);
assertThatThrownBy(() -> userService.create(dto))
.isInstanceOf(DuplicateEmailException.class);
}
}
使用 Testcontainers 进行集成测试
对真实数据库进行测试,而非 H2:
@SpringBootTest
@Testcontainers
class UserRepositoryIntegrationTest {
@Container
static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine")
.withDatabaseName("testdb");
@DynamicPropertySource
static void configureProperties(DynamicPropertyRegistry registry) {
registry.add("spring.datasource.url", postgres::getJdbcUrl);
registry.add("spring.datasource.username", postgres::getUsername);
registry.add("spring.datasource.password", postgres::getPassword);
}
@Autowired private UserRepository userRepository;
@Test
void findByEmail_existingUser_returnsUser() {
userRepository.save(new User("Alice", "[email protected]"));
var found = userRepository.findByEmail("[email protected]");
assertThat(found).isPresent();
assertThat(found.get().getName()).isEqualTo("Alice");
}
}
使用 MockMvc 进行 API 测试
在完整的 Spring 上下文中测试控制器层:
@WebMvcTest(UserController.class)
class UserControllerTest {
@Autowired private MockMvc mockMvc;
@MockBean private UserService userService;
@Test
void createUser_validInput_returns201() throws Exception {
var user = new UserDto(1L, "Alice", "[email protected]");
when(userService.create(any())).thenReturn(user);
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content("""
{"name": "Alice", "email": "[email protected]"}
"""))
.andExpect(status().isCreated())
.andExpect(jsonPath("$.name").value("Alice"));
}
@Test
void createUser_invalidEmail_returns400() throws Exception {
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content("""
{"name": "Alice", "email": "not-an-email"}
"""))
.andExpect(status().isBadRequest());
}
}
阶段四:安全扫描
# 依赖项 CVE
mvn org.owasp:dependency-check-maven:check
# 或者
./gradlew dependencyCheckAnalyze
# 源码中的密钥
grep -rn "password\s*=\s*\"" src/ --include="*.java" --include="*.yml" --include="*.properties"
grep -rn "sk-\|api_key\|secret" src/ --include="*.java" --include="*.yml"
# 密钥(git 历史)
git secrets --scan # 如已配置
常见安全问题
# 检查 System.out.println(请用 logger 代替)
grep -rn "System\.out\.print" src/main/ --include="*.java"
# 检查响应中原始异常消息
grep -rn "e\.getMessage()" src/main/ --include="*.java"
# 检查通配符 CORS
grep -rn "allowedOrigins.*\*" src/main/ --include="*.java"
阶段五:代码格式化(可选门禁)
mvn spotless:apply # 如果使用 Spotless 插件
./gradlew spotlessApply
阶段六:差异审查
git diff --stat
git diff
检查清单:
- 未遗留调试日志(
System.out、无保护的log.debug) - 有意义的错误信息和 HTTP 状态码
- 必要的事务和验证逻辑
- 配置变更已记录
输出模板
验证报告
============
构建: [通过/失败]
静态分析: [通过/失败] (spotbugs/pmd/checkstyle)
测试: [通过/失败] (X/Y 通过, Z% 覆盖率)
安全扫描: [通过/失败] (CVE 发现数: N)
差异: [X 个文件已变更]
总体结果: [就绪 / 未就绪]
待修复问题:
1. ...
2. ...
持续模式
- 在有重大变更时重新运行各阶段,或在长时间会话中每30-60分钟运行一次
- 保持短循环:
mvn -T 4 test+ spotbugs 用于快速反馈
记住:快速反馈胜过迟来的意外。保持门禁严格——在生产环境中将警告视为缺陷。