應用SQL審核
更新時間 2025-10-15 15:16:06
最近更新時間: 2025-10-15 15:16:06
分享文章
SQL審核功能夠對提交的SQL語句進行規范審查,并提供針對性的優化建議。這一功能有助于防止使用未建立索引或格式不規范的SQL語句,從而有效減少SQL注入的安全風險。
前提條件
- 組織版本為企業版。
- 目前僅支持MySQL、PostgreSQL、DRDS數據庫。
功能介紹
在項目開發階段,業務邏輯和數據顯示依賴于數據庫的SQL操作。上線前,必須對所有SQL進行嚴格審核,以防不規范語句影響生產環境。為避免人工審核的低效和資源浪費,DMS提供了SQL審核功能,依據自定義安全規則提出優化建議,如設定表需有主鍵、主鍵類型限制等,以提高研發效率和保障數據庫規范。SQL相關規則詳細配置請參考SQL規范。
操作步驟
創建SQL審核工單
- 登錄DMS控制臺。
- 在左側導航欄,選擇SQL治理 > SQL審核 ,進入SQL審核管理頁面。
- 單擊SQL審核按鈕,彈出SQL審核工單填寫界面,工單需要輸入的內容說明見下表1。
- 填寫完SQL審核工單后,單擊提交按鈕,即完成工單的提交,進入SQL規范檢查。
- SQL審核工單檢查通過之后,會自動進入審批流程。管理員將再次確認SQL,審批完成則工單流程結束。
表1 SQL審核工單輸入內容說明
輸入內容 說明 目標實例? ? ?
必填項,選擇執行SQL語句的目標實例,目前支持MySQL,PostgreSQL,DRDS數據源。
目標數據庫
選填項,選擇執行SQL語句的目標數據庫。如果未選中目標數據庫,則會只檢查“離線規則”,“在線規則”和“離線規則”詳見?SQL規范。 關聯人? ? ? ? ?
選填項,選擇需要看到此工單的用戶名,關聯人可在工單列表頁面查看到此工單。 審核內容 必填項,上傳或編輯審核內容。
注意
支持單個SQL文件、MyBatis框架XML文件或多文件打包成ZIP。單SQL/XML文件最大2M。ZIP不可超過20M,路徑深度最大5層,最多包含200個文件。
如果上傳文件為單文件,上傳的文件內容將自動解析至輸入框中,覆蓋輸入框內原有內容;如果上傳文件為ZIP,上傳的文件目錄、文件名將自動展示到頁面。
工單說明? 描述工單備注內容。
說明
檢查結果中如果有強制改進項,用戶需要改進該項命中的SQL并重新檢查通過之后,才能進入審批流程。
如果有建議改進項,不會阻斷任務流程,但會出現改進建議。
強制改進和建議改進的定義,詳見SQL規范。
查看SQL審核工單列表
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 系統顯示SQL審核工單列表。
查看SQL審核工單詳情
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 點擊要查看的工單操作列詳情按鈕,系統顯示SQL審核工單詳情頁面。
- 點擊 導出審核詳情,可將該工單的所有SQL內容及審核結果以html形式導出下載。
復制創建SQL審核工單
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 點擊要查看的工單操作列詳情按鈕,系統顯示SQL審核工單詳情頁面。
- 點擊頂部復制創建按鈕,進入到工單編輯界面。
- 填寫和修改工單信息,點擊提交完成SQL審核工單的復制創建。
撤回SQL審核工單
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 點擊要查看的工單操作列詳情按鈕,系統顯示SQL審核工單詳情頁面。
- 點擊底部撤回按鈕,系統顯示SQL審核工單撤回彈窗。
- 點擊確定按鈕,完成SQL審核工單的撤回。
注意當SQL審核工單任務狀態為檢查中、審批中時,才能進行撤回操作。
編輯SQL審核工單
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 點擊要編輯的工單操作列編輯按鈕,系統顯示SQL審核工單編輯頁面。
- SQL審核工單狀態如果展示為檢查不通過,可通過SQL審核工單列表或詳情頁點擊編輯按鈕,進入工單內容編輯頁面。
- SQL審核工單的編輯頁,可通過審核內容一欄調整全部SQL內容,也可通過點擊檢查結果下的調整SQL按鈕,修改需要改進的單條SQL。
- 修改完畢,點擊彈窗下方的立即檢查或確定按鈕,對SQL內容重新審核。
- 如需下載當前提交的全部SQL語句,請點擊檢查結果下方的下載按鈕。
注意只有當SQL審核工單任務狀態為檢查不通過時,才能進行編輯操作。
重試SQL審核工單
- 用戶登錄DMS系統。
- 在左側菜單欄依次選擇 SQL治理 > SQL審核 。
- 點擊要查看的工單操作列詳情按鈕,系統顯示SQL審核工單詳情頁面。
- 點擊底部重試工單按鈕,系統顯示SQL審核工單重試彈窗。
- 點擊確定按鈕,完成SQL審核工單的重試。
注意只有當SQL審核工單任務狀態為檢查不通過時,才能進行重試操作。