付款代碼審查 是做什麼的?
在付款程式碼中找出會造成實際金錢損失的錯誤,並針對每個錯誤以金錢角度解釋:誰會被重複收費、哪筆記帳遺失、誰可以核准自己的轉帳。
工作流程
-
界定範圍。 找出建立、移動、核准、記帳或對帳金錢的程式碼:控制器、服務、監聽器、實體、遷移腳本。記錄使用的技術堆疊(Spring Boot、Kafka、JPA、Kotlin)。
-
執行掃描器,從此技能的資料夾中對專案或修改過的檔案執行:
python scripts/scan.py <path-to-code> # Markdown 表格 python scripts/scan.py <path-to-code> --format json # 供後續處理使用需要 Python 3.10+,無其他依賴。除非傳入
--include-tests,否則會跳過測試原始碼。它會使用啟發式規則讀取原始碼文字,因此輸出是一個線索列表。 -
透過閱讀程式碼驗證每個發現。 對於每個線索,開啟對應檔案並確認:
- 一個名為
amount的double如果實際上是一個百分比或比率,則不屬於 PAY001。 - 如果重複或四眼檢查存在於掃描器無法追蹤的更深層(超過三個呼叫),則消費者或核准方法是正常的。請跟隨呼叫鏈並指出位置。
- 排除誤報,並用一句話說明原因,以便讀者信任其餘結果。
- 一個名為
-
逐步執行手動檢查清單,位於 references/checklist.md。它會用錯誤和正確的範例說明每個掃描器規則,並列出掃描器無法偵測的項目:餘額競爭條件、冪等金鑰的範圍、重試與逾時語意、狀態機、對帳、在途資金、稽核軌跡與資料保護。僅根據受審查的程式碼需求深入檢查。
-
撰寫報告,使用以下格式。將金錢影響最高的項目放在最前面。
報告格式
## 付款審查:<服務或 PR>
**裁決:** <一句話:可安全合併 / 合併前需修正 / 需要重新設計>
| # | 嚴重程度 | 位置 | 問題 | 金錢影響 |
|---|---|---|---|---|
| 1 | 高 | `TransferController.java:24` | POST /transfers 缺少冪等金鑰 | 客戶端在逾時後重試會建立第二筆轉帳 |
### 1. <標題>
**為什麼重要:** <具體說明會出什麼問題,並舉例金額>
**修正方式:** <最小且安全的變更,附上簡短程式碼片段>
### 已檢查且正常
- <已確認正確的項目及其位置;保持審查誠實>
### 未涵蓋的項目
- <你無法檢查的內容,例如不在此儲存庫中的資料庫約束>
審查規則
- 嚴重程度與金錢相關。 高 = 金錢可能遺失、重複或被錯誤的人移動。中 = 在失敗或負載情況下可能發生。低 = 程式碼衛生問題。
- 引用程式碼行,包含
file:line,針對每個發現。絕不報告你未確認的掃描器線索。 - 偏好最小且安全的修正方式,例如一個唯一約束加上一個
Idempotency-Key標頭,而不是重寫。當正確的修正方式是結構性的(如交易性發件箱)時,應直接說明。 - 不要聲稱合規。 此審查並非 PCI DSS 或 SOX 稽核;如果有人詢問,請明確說明。
- 也檢查資料庫。 許多此類保證應屬於約束(
UNIQUE、CHECK、觸發器)。查看遷移腳本(Flyway、Liquibase),如果它們在儲存庫中的話。