CakePHP 印出 SQL 語句的實用技巧

前言

在使用 CakePHP 框架開發應用程式時，除錯資料庫查詢是常見需求。掌握如何印出執行的 SQL 語句，能幫助開發者快速定位效能瓶頸、驗證查詢邏輯，並優化資料庫操作。本文將介紹一種簡單有效的方法，讓你在程式碼中輕鬆獲取所有已執行的 SQL 語句。

核心實作程式碼

將以下程式碼片段放入你需要除錯的位置（例如 Controller 的動作方法中、View 檔案，或是元件的回呼函式），即可印出該時間點之前所有資料庫連線所執行的 SQL 語句：

$sources = ConnectionManager::sourceList();
if (!isset($logs)) {
    $logs = array();
    foreach ($sources as $source) {
        $db =& ConnectionManager::getDataSource($source);
        if (!$db->isInterfaceSupported('getLog')) {
            continue;
        }
        $logs[$source] = $db->getLog();
    }
}
// 印出或記錄 $logs 內容
debug($logs);

程式碼解析

• ConnectionManager::sourceList()：取得目前應用程式中所有已設定的資料庫連線名稱（如 'default', 'legacy' 等）。
• ConnectionManager::getDataSource()：根據連線名稱取得對應的資料來源物件。
• isInterfaceSupported('getLog')：檢查該資料來源是否支援日誌記錄介面（並非所有資料庫驅動都支援）。
• getLog()：回傳該連線自啟動以來執行的所有 SQL 查詢陣列，包含查詢語句、耗時、影響列數等資訊。

進階應用建議

為避免汙染正式環境日誌，建議搭配環境判斷使用：

if (Configure::read('debug') > 0) {
    // 僅在除錯模式下執行上述程式碼
    $sources = ConnectionManager::sourceList();
    // ... 其餘邏輯
    // 可寫入自訂日誌檔或直接 debug()
    CakeLog::write('sql_debug', print_r($logs, true));
}

注意事項

• 此方法適用於 CakePHP 2.x 版本。CakePHP 3.x/4.x 架構不同，請改用 ConnectionManager::get() 並呼叫 getLog()。
• 大量 SQL 輸出可能影響頁面載入速度，建議僅在開發階段或特定除錯路由啟用。
• 搭配 DebugKit 外掛使用可獲得更豐富的視覺化查詢分析介面。

掌握這項技巧，能讓你在 CakePHP 專案開發中更從容地應對資料庫相關問題，提升除錯效率。