萬盛學電腦網

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

PHP 簡單高效的日誌寫入函數最佳實踐

核心需求

生產環境需要輕量、線程安全、跨平台的日誌寫入。核心要點:原子追加、換行符跨平台、時間戳格式化、錯誤處理。

推薦實現

<?php
/**
 * 寫入日誌(線程安全、跨平台)
 * @param string $message 日誌內容
 * @param string $file    日誌文件路徑(預設:同目錄 logfile.log)
 * @param string $format  時間格式(預設:Y-m-d H:i:s)
 * @return bool 成功返回 true
 */
function writeLog(string $message, string $file = 'logfile.log', string $format = 'Y-m-d H:i:s'): bool {
    $line = date($format) . ' ' . $message . PHP_EOL;
    // FILE_APPEND 追寫 | LOCK_EX 獨佔鎖(防止併發交錯)
    $bytes = @file_put_contents($file, $line, FILE_APPEND | LOCK_EX);
    return $bytes !== false;
}

// 使用示例
writeLog('用戶登入: user_id=123, ip=192.168.1.1');
writeLog('SQL 錯誤: ' . $pdo->errorInfo()[2], 'error.log');
writeLog('API 請求: ' . json_encode($_POST), 'api.log', 'Y-m-d\TH:i:s.uP'); // ISO8601 帶毫秒

關鍵點解析

  1. PHP_EOL:跨平台換行符(Windows \r\n,Linux/Mac \n)。
  2. LOCK_EX:獲取獨佔鎖,確保多進程併發寫入不串行、不截斷。
  3. @ 抑制警告:失敗返回 false 而非拋出警告,由調用方決定錯誤處理。
  4. 返回字節數:file_put_contents 返回寫入字節數,可用於驗證完整性。

進階:日誌分級與輪轉

<?php
class SimpleLogger {
    private $basePath;
    private $maxSize; // 字節,如 10MB

    public function __construct(string $basePath, int $maxSize = 10 * 1024 * 1024) {
        $this->basePath = rtrim($basePath, '/');
        $this->maxSize  = $maxSize;
    }

    public function log(string $level, string $message, array $context = []): void {
        $file = "{$this->basePath}/{$level}.log";
        
        // 簡單輪轉:超過大小重命名備份
        if (file_exists($file) && filesize($file) > $this->maxSize) {
            $backup = $file . '.' . date('YmdHis');
            @rename($file, $backup);
        }

        $contextStr = $context ? ' ' . json_encode($context, JSON_UNESCAPED_UNICODE) : '';
        $line = sprintf('[%s] %s%s%s', date('c'), strtoupper($level), $contextStr, PHP_EOL);
        
        @file_put_contents($file, $line, FILE_APPEND | LOCK_EX);
    }

    public function info(string $msg, array $ctx = [])  { $this->log('info', $msg, $ctx); }
    public function warning(string $msg, array $ctx = []) { $this->log('warning', $msg, $ctx); }
    public function error(string $msg, array $ctx = [])  { $this->log('error', $msg, $ctx); }
}

// 使用
$logger = new SimpleLogger(__DIR__ . '/logs');
$logger->info('訂單創建', ['order_id' => 1001, 'amount' => 99.9]);
$logger->error('支付失敗', ['order_id' => 1001, 'code' => 'PAY_TIMEOUT']);
?>

對比:Monolog 等成熟庫

特性簡易函數SimpleLoggerMonolog
依賴無無Composer 包
日誌級別無支援完整 PSR-3
輪轉策略無按大小按大小/日期/手動
處理器文件文件文件、Socket、Slack、DB、Elasticsearch…
格式化器固定簡單LineFormatter, JsonFormatter…

總結

小項目、腳本、快速原型直接用 writeLog() 單函數足夠。中型項目可引入 SimpleLogger 類獲得分級與輪轉。大型項目、微服務、需集中化日誌分析(ELK)請直接使用 Monolog,符合 PSR-3 標準,生態豐富,避免重複造輪子。

copyright © 萬盛學電腦網 all rights reserved