Spring Boot 驗證循環 是做什麼的?
在 PR 前、重大變更後及部署前執行。
何時啟用
- 在為 Spring Boot 服務開啟拉取請求之前
- 在重大重構或依賴升級之後
- 預先部署驗證,適用於 staging 或 production 環境
- 執行完整的建構 → lint → 測試 → 安全掃描流程
- 驗證測試覆蓋率是否達到門檻
階段 1:建構
mvn -T 4 clean verify -DskipTests
# 或者
./gradlew clean assemble -x test
如果建構失敗,請停止並修復。
階段 2:靜態分析
Maven(常用外掛):
mvn -T 4 spotbugs:check pmd:check checkstyle:check
Gradle(若已設定):
./gradlew checkstyleMain pmdMain spotbugsMain
階段 3:測試 + 覆蓋率
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 context 測試 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());
}
}
階段 4:安全掃描
# 依賴 CVE
mvn org.owasp:dependency-check-maven:check
# 或者
./gradlew dependencyCheckAnalyze
# 原始碼中的秘密
find src/ -name "*.java" -o -name "*.yml" -o -name "*.properties" | xargs grep -rn "password\s*=\s*\""
find src/ -name "*.java" -o -name "*.yml" | xargs grep -rn "sk-\|api_key\|secret"
# 秘密(git 歷史)
git secrets --scan # 若已設定
常見安全發現
# 檢查 System.out.println(請改用 logger)
find src/main/ -name "*.java" | xargs grep -rn "System\.out\.print"
# 檢查回應中原始例外訊息
find src/main/ -name "*.java" | xargs grep -rn "e\.getMessage()"
# 檢查萬用字元 CORS
find src/main/ -name "*.java" | xargs grep -rn "allowedOrigins.*\*"
階段 5:程式碼格式檢查(選擇性門檻)
mvn spotless:apply # 如果使用 Spotless 外掛
./gradlew spotlessApply
階段 6:差異審查
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 以獲得快速回饋
請記住:快速回饋勝過事後驚喜。保持嚴格的門檻——將警告視為生產系統中的缺陷。