springboot-verification

用途

Spring Boot 验证循环用于在提交 Pull Request 之前、重大重构或依赖升级之后、以及预部署（staging 或生产）验证时，对 Spring Boot 服务执行完整的构建 → lint → 测试 → 安全扫描流水线，并验证测试覆盖率达到阈值。

适用时机

为 Spring Boot 服务打开 Pull Request 前
重大重构或依赖升级后
staging 或生产的预部署验证
运行完整构建 → lint → 测试 → 安全扫描流水线
验证测试覆盖率满足阈值

阶段一：构建

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

需要报告：测试总数、通过/失败数、覆盖率百分比（行/分支）。

单元测试

使用 mock 依赖隔离测试服务层逻辑：

@ExtendWith(MockitoExtension.class)
class UserServiceTest {

  @Mock private UserRepository userRepository;
  @InjectMocks private UserService userService;

  @Test
  void createUser_validInput_returnsUser() {
    var dto = new CreateUserDto("Alice", "alice@example.com");
    var expected = new User(1L, "Alice", "alice@example.com");
    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", "existing@example.com");
    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", "alice@example.com"));

    var found = userRepository.findByEmail("alice@example.com");

    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", "alice@example.com");
    when(userService.create(any())).thenReturn(user);

    mockMvc.perform(post("/api/users")
            .contentType(MediaType.APPLICATION_JSON)
            .content("""
                {"name": "Alice", "email": "alice@example.com"}
                """))
        .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"

阶段五：Lint/格式化（可选门禁）

mvn spotless:apply   # 如使用 Spotless 插件
./gradlew spotlessApply

阶段六：Diff 审查

git diff --stat
git diff

检查清单：

未遗留调试日志（System.out、无保护的 log.debug）
错误信息与 HTTP 状态码有意义
需要处存在事务与校验
配置变更已记录

输出模板

VERIFICATION REPORT
===================
Build:     [PASS/FAIL]
Static:    [PASS/FAIL] (spotbugs/pmd/checkstyle)
Tests:     [PASS/FAIL] (X/Y passed, Z% coverage)
Security:  [PASS/FAIL] (CVE findings: N)
Diff:      [X files changed]

Overall:   [READY / NOT READY]

Issues to Fix:
1. ...
2. ...

持续模式

在重大变更时重新运行各阶段，或在长时间会话中每 30–60 分钟运行一次
保持短循环：mvn -T 4 test + spotbugs 以获得快速反馈

记住：快速反馈胜过迟来的意外。保持严格门禁——在生产系统中将警告视为缺陷。