萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 資料庫 >> Oracle 教學

Oracle PL/SQL 編碼規範四大黃金法則:命名慣例、SQL 極小化、模組化、同儕審查

前言

寫了 20 年 PL/SQL,早期代碼多為「義大利麵條式」——單一巨大程序、硬編碼 SQL、命名隨意。近年遵循四條簡單規則,代碼品質質變。這四條規則無需主管批准、無需團隊共識,個人即可立即執行。

法則一:嚴格命名慣例——如生命般依賴

前綴規範(兩字母縮寫)

物件類型前綴範例
Package (Spec/Body)PKG_PKG_EMP_MGMT
ProcedurePRC_PRC_HIRE_EMP
FunctionFNC_FNC_CALC_BONUS
TriggerTRG_TRG_EMP_AUDIT
ViewVW_VW_EMP_DEPT
SequenceSEQ_SEQ_EMP_ID
CursorCUR_CUR_EMP_LIST
Record TypeRECT_RECT_EMP
Collection TypeTAB_ / COL_TAB_EMP_IDS
Variable (Package Level)G_G_MAX_SALARY
Variable (Local)L_L_EMP_COUNT
Parameter (IN)P_P_EMP_ID
Parameter (OUT/IN OUT)P_ / PO_PO_NEW_ID
ConstantC_C_MAX_RETRY
ExceptionEXC_EXC_DUP_VAL_ON_INDEX

命名慣例帶來的自動化紅利

因命名可預測,可編寫 SQL 生成安裝腳本:


-- 自動生成所有 PKG_* 安裝順序腳本
SELECT '@' || object_name || '.sql'
FROM   user_objects
WHERE  object_type = 'PACKAGE'
AND    object_name LIKE 'PKG_%'
ORDER BY object_name;

新增表 → 產生對應 PKG → 執行腳本 → 安裝腳本自動更新,零手工維護。

法則二:戒除 SQL 嗜好——能不寫 SQL 就不寫

  • PL/SQL 非 SQL 容器,業務邏輯用 PL/SQL,資料存取用 SQL
  • 單一 SQL 解決的事,絕不拆成迴圈 + 逐筆 DML
  • 善用 BULK COLLECT / FORALL 批次處理,減少 Context Switch
  • 動態 SQL 僅在「物件名稱動態」時使用,否則靜態 SQL 享有編譯期檢查、共用遊標、依賴追蹤優勢

反模式 vs 最佳實踐


-- ❌ 反模式:逐筆處理
FOR r IN (SELECT emp_id FROM employees WHERE dept_id = 10) LOOP
    UPDATE employees SET salary = salary * 1.1 WHERE emp_id = r.emp_id;
END LOOP;

-- ✅ 最佳:單一 SQL
UPDATE employees SET salary = salary * 1.1 WHERE dept_id = 10;

-- ✅ 複雜邏輯需迴圈時:BULK COLLECT + FORALL
DECLARE
    TYPE t_ids IS TABLE OF employees.emp_id%TYPE;
    l_ids t_ids;
BEGIN
    SELECT emp_id BULK COLLECT INTO l_ids FROM employees WHERE dept_id = 10;
    FORALL i IN INDICES OF l_ids
        UPDATE employees SET salary = salary * 1.1 WHERE emp_id = l_ids(i);
END;

法則三:執行部短小精悍——告別義大利麵條

  • 單一 Procedure/Function **不超過 50 行**(含註解)
  • 每個邏輯單元抽離為私有子程序
  • Package Body 結構:
    -- Public API
    PROCEDURE hire_emp ...
    -- Private Helpers
    PROCEDURE validate_dept ...
    FUNCTION calc_salary ...
  • 主流程讀起來像「業務敘事」,細節隱藏在私有程序

重構前後對比


-- ❌ 200 行單一 Procedure
PROCEDURE process_order(p_order_id NUMBER) IS
    -- 200 行混雜:驗證、計價、扣庫存、寫帳、發通知、錯誤處理...
BEGIN ... END;

-- ✅ 模組化
PROCEDURE process_order(p_order_id NUMBER) IS
BEGIN
    validate_order(p_order_id);
    reserve_inventory(p_order_id);
    calculate_pricing(p_order_id);
    create_accounting_entries(p_order_id);
    send_notifications(p_order_id);
EXCEPTION
    WHEN OTHERS THEN handle_order_error(p_order_id, SQLCODE, SQLERRM); RAISE;
END;

-- 每個私有程序 < 30 行,可獨立單元測試

法則四:找夥伴——同儕審查制度

  • **強制**:所有上線代碼經過至少一位同儕審查
  • **清單式**:命名、SQL 效能、例外處理、邊界條件、安全性、測試覆蓋
  • **輕量**:Git Pull Request + Checklist,非正式會議
  • **雙贏**:審查者學習新寫法,作者發現盲點

附錄:個人代碼品質檢查清單

  1. [] 所有物件遵循命名慣例
  2. [] 無隱性轉換,所有 SQL 明確列欄位
  3. [] 無 SELECT *,無硬編碼常數
  4. [] 迴圈內無 DML,已改用 BULK/集合操作
  5. [] 每個程序 ≤ 50 行,單一職責
  6. [] 所有例外皆有處理或 RAISE,無 WHEN OTHERS THEN NULL
  7. [] 所有公共 API 有文檔註解(目的、參數、回傳、例外、範例)
  8. [] 經過同儕審查簽核

結語

這四條規則不需工具、不需預算、不需權限,**今天就能開始**。堅持三個月,你會驚訝地發現:原來我能寫出這麼優雅、可維護、高效能的 PL/SQL。

copyright © 萬盛學電腦網 all rights reserved