萬盛學電腦網

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

PHP 滚动日志类库实现:按大小/数量自动轮转、单例模式、多级别记录

滚动日志机制

固定文件名 app.log 作为当前写入文件,达到大小阈值时轮转:

app.log      → app_1.log
app_1.log    → app_2.log
...
app_N.log    → 删除 (超过最大文件数)

保证日志文件数量可控、单文件不超大、最新日志始终在 app.log。

完整类库代码

<?php
final class RollingLogger {
    // 日志级别常量
    public const DEBUG = 0;
    public const INFO  = 1;
    public const WARN  = 2;
    public const ERROR = 3;

    private int $level;
    private int $maxFiles;
    private int $maxSize;      // 字节
    private string $logDir;
    private string $prefix;    // 文件前缀,如 'app'

    private static ?self $instance = null;

    private function __construct() {}

    public static function getInstance(): self {
        if (self::$instance === null) {
            self::$instance = new self();
        }
        return self::$instance;
    }

    /**
     * 初始化配置
     * @param int $level     记录级别:DEBUG/INFO/WARN/ERROR
     * @param int $maxFiles  最大保留文件数(含当前)
     * @param int $maxSize   单文件最大字节
     * @param string $logDir 日志目录绝对路径
     * @param string $prefix 文件前缀
     * @return bool
     */
    public function init(int $level, int $maxFiles, int $maxSize, string $logDir, string $prefix): bool {
        if (!in_array($level, [self::DEBUG, self::INFO, self::WARN, self::ERROR], true)) return false;
        if ($maxFiles <= 0 || $maxSize <= 0) return false;
        if (!is_dir($logDir) && !mkdir($logDir, 0755, true)) return false;

        $this->level     = $level;
        $this->maxFiles  = $maxFiles;
        $this->maxSize   = $maxSize;
        $this->logDir    = rtrim($logDir, '/\\');
        $this->prefix    = $prefix;
        return true;
    }

    /** 格式化时间戳含毫秒 */
    private function formatTime(): string {
        [$usec, $sec] = explode(' ', microtime());
        return '[' . date('Y-m-d H:i:s', (int)$sec) . '.' . (int)($usec * 1000) . ']';
    }

    /** 核心写入+轮转逻辑 */
    public function log(string $message): bool {
        $currentFile = "{$this->logDir}/{$this->prefix}.log";

        // 轮转检查
        if (is_file($currentFile) && filesize($currentFile) >= $this->maxSize) {
            $this->rotate();
        }

        // 追加写入
        $line = $this->formatTime() . " {$message}\n";
        return (bool)file_put_contents($currentFile, $line, FILE_APPEND | LOCK_EX);
    }

    /** 执行轮转:重命名现有文件 */
    private function rotate(): void {
        // 找到当前最大编号
        $maxIdx = 0;
        for ($i = 1; $i < $this->maxFiles; $i++) {
            if (is_file("{$this->logDir}/{$this->prefix}_{$i}.log")) {
                $maxIdx = $i;
            } else {
                break;
            }
        }

        // 已达上限,删除最旧
        if ($maxIdx >= $this->maxFiles - 1) {
            @unlink("{$this->logDir}/{$this->prefix}_{$maxIdx}.log");
            $maxIdx = $this->maxFiles - 2;
        }

        // 依次后移
        for ($i = $maxIdx; $i >= 1; $i--) {
            @rename(
                "{$this->logDir}/{$this->prefix}_{$i}.log",
                "{$this->logDir}/{$this->prefix}_{$i+1}.log"
            );
        }

        // 当前文件 → _1.log
        @rename($currentFile, "{$this->logDir}/{$this->prefix}_1.log");
    }

    /** 便捷方法 */
    public function debug(string $msg, string $file = '', int $line = 0): void {
        if ($this->level <= self::DEBUG) $this->log("[DEBUG] {$msg} [{$file}:{$line}]");
    }
    public function info(string $msg, string $file = '', int $line = 0): void {
        if ($this->level <= self::INFO) $this->log("[INFO] {$msg} [{$file}:{$line}]");
    }
    public function warn(string $msg, string $file = '', int $line = 0): void {
        if ($this->level <= self::WARN) $this->log("[WARN] {$msg} [{$file}:{$line}]");
    }
    public function error(string $msg, string $file = '', int $line = 0): void {
        if ($this->level <= self::ERROR) $this->log("[ERROR] {$msg} [{$file}:{$line}]");
    }
}

// ========== 使用示例 ==========
// 入口文件 bootstrap.php
$logger = RollingLogger::getInstance();
$logger->init(
    level: RollingLogger::DEBUG,
    maxFiles: 10,
    maxSize: 10 * 1024 * 1024, // 10MB
    logDir: __DIR__ . '/logs',
    prefix: 'app'
);

// 业务代码中
$logger->info('用户登录', __FILE__, __LINE__);
$logger->error('数据库连接失败', __FILE__, __LINE__);

关键设计点

  • 单例模式:全局唯一实例,避免重复打开文件句柄
  • LOCK_EX:file_put_contents(..., FILE_APPEND | LOCK_EX) 原子追加,多进程安全
  • 毫秒时间戳:microtime() 便于精确排查
  • 级别过滤:生产环境设 INFO 或 WARN,调试时改 DEBUG
  • 文件名含日期:如需按天分目录,可在 init() 中动态拼接 date('Y-m-d')

对比主流日志库

方案优点缺点
本类库零依赖、单文件、极简、可直接嵌入旧项目无结构化日志、无远程传输、无日志分析生态
MonologPSR-3 标准、Handler 丰富、格式化器、处理器链依赖 Composer、体积大、学习曲线
SeasLog (PECL)C 扩展高性能、自动分片、TCP/UDP 发送需编译安装、配置复杂

生产部署建议

  1. 日志目录挂载独立磁盘,避免磁盘满影响主业务
  2. 配置 logrotate 系统级轮转作为双重保障
  3. 接入 ELK / Loki / ClickHouse 做集中分析
  4. 错误级别日志配合告警系统(钉钉/企微/邮件)

此类库约 100 行,零依赖,适合中小项目、遗留系统快速接入规范日志记录。

copyright © 萬盛學電腦網 all rights reserved