Spring Boot 驗證迴圈 是做什麼的?
在 PR 之前、重大變更之後以及部署之前執行。
何時啟用
- 在為 Spring Boot 服務開啟 Pull Request 之前
- 在重大重構或相依套件升級之後
- 預備部署至暫存或正式環境的驗證
- 執行完整的建構 → 語法檢查 → 測試 → 安全掃描流程
- 驗證測試涵蓋率符合門檻
第一階段:建構
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 環境中測試 Controller 層:
@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(請改用日誌)
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)
差異: [變更檔案數]
整體: [就緒 / 未就緒]
待解決問題:
1. ...
2. ...
持續模式
- 遇到重大變更時,或長時間作業階段中每 30–60 分鐘重新執行各階段
- 保持簡短迴圈:
mvn -T 4 test+ spotbugs 以獲得快速反饋
記住:快速反饋勝過事後驚喜。嚴格把關——在正式系統中將警告視為缺陷。