萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 單例模式實作高效日誌處理類庫

前言

在現代應用程式開發中,日誌系統的重要性不言而喻。無論是記錄錯誤資訊、除錯細節、運行狀態還是效能指標,完善的日誌機制都是生產環境中排查問題、監控系統健康的關鍵基礎設施。本文介紹一個基於 PHP 單例模式設計的日誌處理類庫,具備自動分割大檔案、資源復用等實用特性。

核心設計理念

單例模式節省資源

採用單例模式確保全域僅存在一個日誌實例,避免重複開啟檔案控制代碼,減少系統開銷。私有建構子搭配靜態 get_instance() 方法,提供全域唯一存取點。

智慧型檔案分割機制

類別內建檔案大小監控邏輯:當日誌檔案超過預設閾值(LOG_MAX_LEN)時,自動按序號建立新檔案(如 log_0、log_1…),無需人工干預。掃描目錄下現有檔案後綴,找出最大編號並檢查大小,決定是否滾動建立新檔。

類別結構與關鍵方法

class Log {
    private static $instance = null;
    private static $handle = null;
    private $log_switch;
    private $log_file_path;
    private $log_max_len;
    private $log_file_pre = 'log_';

    protected function __construct() {
        $this->log_file_path = LOG_FILE_PATH;
        $this->log_switch    = LOG_SWITCH;
        $this->log_max_len   = LOG_MAX_LEN;
    }

    public static function get_instance() {
        if (!self::$instance instanceof self) {
            self::$instance = new self;
        }
        return self::$instance;
    }

    public function log($type, $desc, $time) { ... }

    private function get_max_log_file_suf() { ... }

    public function close() { fclose(self::$handle); }
}

日誌寫入邏輯

  • 類型區分:0 代表一般事件(THING LOG),1 代表錯誤(ERROR LOG),預設視為事件。
  • 延遲開啟檔案:首次寫入時才開啟檔案控制代碼,並透過 get_max_log_file_suf() 取得最新可用檔案名。
  • 自動換行:使用 chr(13) 作為行尾符號。

檔案後綴計算演算法

  1. 掃描日誌目錄,解析符合 log_數字 格式的檔名。
  2. 取得最大後綴編號 $log_file_suf。
  3. 若對應檔案大小 ≥ $this->log_max_len,則編號 +1 以建立新檔。
  4. 目錄不存在或無檔案時回傳 0。

使用範例

// 取得單例
$logger = Log::get_instance();

// 記錄錯誤日誌
$logger->log(1, '資料庫連線失敗', date('Y-n-j H:i:s'));

// 記錄一般事件
$logger->log(0, '使用者登入成功', date('Y-n-j H:i:s'));

// 關閉檔案控制代碼(通常於腳本結束前呼叫)
$logger->close();

配置常數說明

部署前請在配置檔中定義以下常數:

  • LOG_FILE_PATH:日誌檔案儲存目錄(需可寫入)
  • LOG_SWITCH:日誌開關(true/false)
  • LOG_MAX_LEN:單一檔案最大位元組數(如 1048576 代表 1MB)

已知限制與改進方向

  • 檔案數量無上限:長期運行會產生大量分割檔案,需定期清理或加入保留天數/數量機制。
  • 並發寫入安全:高併發場景下建議加入檔案鎖(flock)或改用專用日誌元件(如 Monolog)。
  • 日誌等級擴充:可引入 PSR-3 標準等級(debug, info, notice, warning, error, critical, alert, emergency)。

總結

這個日誌類別展示了單例模式在資源管理上的典型應用,配合自動分檔機制,適合中小型專案快速整合。對於大型分散式系統,建議採用集中式日誌解決方案(ELK Stack、Loki 等)以利查詢與分析。

copyright © 萬盛學電腦網 all rights reserved