PHP日志系统构建与优化：Monolog、性能考量及实践指南

<?php

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Formatter\LineFormatter;

/**
 * customLogger 类：封装Monolog，提供统一的日志接口
 */
class CustomLogger
{
    public Logger $log;

    public function __construct(string $name = 'CUSTOMLOGGER', bool $ignoreStdout = false)
    {
        // 假设日志文件路径在项目根目录下的 custom/log/dest/mylog.log
        $loggerLocation = __DIR__ . "/custom/log/dest/mylog.log";
        // 定义日志格式：不使用日期格式，不使用微秒，开启行结束符，开启空白行
        $formatter = new LineFormatter(null, null, true, true);

        $this->log = new Logger($name);

        // 添加文件处理器
        $fileHandler = new StreamHandler($loggerLocation, Logger::INFO);
        $fileHandler->setFormatter($formatter);
        $this->log->pushHandler($fileHandler);

        // 根据配置决定是否添加标准输出处理器
        if (!$ignoreStdout) {
            $stdoutHandler = new StreamHandler("php://stdout", Logger::INFO);
            $stdoutHandler->setFormatter($formatter);
            $this->log->pushHandler($stdoutHandler);
        }
    }

    /**
     * 获取Monolog Logger实例
     *
     * @return Logger
     */
    public function getLogger(): Logger
    {
        return $this->log;
    }
}

/**
 * someOtherClass 类：演示Monolog日志的使用
 */
class SomeOtherClass
{
    protected static ?Logger $log = null;

    /**
     * 初始化或获取日志器实例。
     * 注意：在实际生产环境中，应避免在每次方法调用时重复初始化日志器，
     * 推荐使用单例模式、依赖注入或在应用启动时统一配置。
     * 当前示例为演示目的，模拟了原始代码的重复初始化行为。
     *
     * @return Logger
     */
    protected static function setupLogger(): Logger
    {
        // 每次调用都会创建新的 CustomLogger 实例，这会带来性能开销
        $loggerInstance = new CustomLogger();
        self::$log = $loggerInstance->getLogger();
        return self::$log;
    }

    public function runImport(): void
    {
        self::setupLogger(); // 每次执行runImport都重新设置logger
        self::$log->info('import: Begin...');

        // 执行一些业务逻辑
        // ...

        self::$log->info('import: Finished...');
    }
}

// 示例使用
// $importer = new SomeOtherClass();
// $importer->runImport();

<?php

/**
 * LogClass 类：提供简单的文件日志写入功能
 */
class LogClass
{
    public static function logSomething(string $logContent): void
    {
        // 假设日志文件路径在项目根目录下的 custom/log/dest/mylog.log
        $filename = __DIR__ . '/custom/log/dest/mylog.log';
        file_put_contents($filename, $logContent . PHP_EOL, FILE_APPEND);
    }
}

/**
 * SomeOtherClassWithSimpleLog 类：演示简单文件日志的使用
 */
class SomeOtherClassWithSimpleLog
{
    public function runImport(): void
    {
        LogClass::logSomething('import: Begin...');
        // 执行一些业务逻辑
        // ...
        LogClass::logSomething('import: Finished...');
    }
}

// 示例使用
// $importerSimple = new SomeOtherClassWithSimpleLog();
// $importerSimple->runImport();

<?php

// 引入Monolog和自定义Logger类
require_once 'vendor/autoload.php'; // 假设Monolog通过Composer安装
// 引入上述 CustomLogger 和 SomeOtherClass
// 引入上述 LogClass 和 SomeOtherClassWithSimpleLog

// --- 准备测试数据 ---
$logMessage = 'This is a test log message for performance comparison.';
$iterations = 10000; // 增加迭代次数以获得更稳定的结果

echo "--- 开始性能测试 ---\n\n";

// --- 测试 Monolog 方案 ---
echo "测试 Monolog 方案 ({$iterations} 次写入):\n";
$monologStartTime = microtime(true);
for ($i = 0; $i < $iterations; $i++) {
    // 每次迭代都重新初始化Logger，模拟原始代码的低效用法
    $loggerInstance = new CustomLogger('PERF_TEST_MONOLOG', true); // 忽略stdout
    $loggerInstance->getLogger()->info($logMessage . " [Monolog iteration: {$i}]");
}
$monologEndTime = microtime(true);
$monologExecutionTime = ($monologEndTime - $monologStartTime);
echo "Monolog 方案总耗时: " . sprintf('%.4f', $monologExecutionTime) . " 秒\n";
echo "Monolog 方案平均每次写入耗时: " . sprintf('%.6f', $monologExecutionTime / $iterations) . " 秒\n\n";

// --- 测试 Monolog 方案（优化：Logger只初始化一次） ---
echo "测试 Monolog 方案 (优化后，Logger只初始化一次，{$iterations} 次写入):\n";
$optimizedMonologStartTime = microtime(true);
$optimizedLoggerInstance = new CustomLogger('PERF_TEST_MONOLOG_OPTIMIZED', true); // 忽略stdout
$optimizedLogger = $optimizedLoggerInstance->getLogger();
for ($i = 0; $i < $iterations; $i++) {
    $optimizedLogger->info($logMessage . " [Optimized Monolog iteration: {$i}]");
}
$optimizedMonologEndTime = microtime(true);
$optimizedMonologExecutionTime = ($optimizedMonologEndTime - $optimizedMonologStartTime);
echo "优化后 Monolog 方案总耗时: " . sprintf('%.4f', $optimizedMonologExecutionTime) . " 秒\n";
echo "优化后 Monolog 方案平均每次写入耗时: " . sprintf('%.6f', $optimizedMonologExecutionTime / $iterations) . " 秒\n\n";


// --- 测试 简单文件直写方案 ---
echo "测试 简单文件直写方案 ({$iterations} 次写入):\n";
$simpleLogStartTime = microtime(true);
for ($i = 0; $i < $iterations; $i++) {
    LogClass::logSomething($logMessage . " [Simple iteration: {$i}]");
}
$simpleLogEndTime = microtime(true);
$simpleLogExecutionTime = ($simpleLogEndTime - $simpleLogStartTime);
echo "简单文件直写方案总耗时: " . sprintf('%.4f', $simpleLogExecutionTime) . " 秒\n";
echo "简单文件直写方案平均每次写入耗时: " . sprintf('%.6f', $simpleLogExecutionTime / $iterations) . " 秒\n\n";

echo "--- 性能测试结束 ---\n";

// 清理测试日志文件 (可选)
// unlink(__DIR__ . "/custom/log/dest/mylog.log");