PHP 记录错误日志最佳实践（附代码示例）

在PHP的日常开发里，记录错误日志的使用频率相当高。但很多人对它的理解仅限于皮毛，一旦遇到复杂场景就容易出问题。本文带你深入一点。

从一个真实场景说起：记录错误日志

在正式开始之前，先问一个问题：你真的了解记录错误日志吗？不是「听说过」那种了解，而是「能讲清楚、能写对」那种。如果答案不确定，这篇文章值得一读。

记录错误日志的核心要点

1. 记录错误日志的版本差异要留意，老代码里的一些写法在新版本中可能已不推荐。
2. 学习记录错误日志时建议画出它的执行流程图，一图胜千言。
3. 记录错误日志的文档注释写清楚参数含义和返回值，降低别人（和未来的自己）的理解成本。

接下来用代码实际演示一下记录错误日志。

记录错误日志代码实战

这里以记录错误日志到文件作为演示：

<?php
function log_error($msg, $file = 'logs/error.log') {
    $line = date('Y-m-d H:i:s') . ' ' . $msg . PHP_EOL;
    file_put_contents($file, $line, FILE_APPEND | LOCK_EX);
}

try {
    // 业务代码
    throw new Exception('数据库连接失败');
} catch (Exception $e) {
    log_error($e->getMessage() . ' in ' . $e->getFile() . ':' . $e->getLine());
}

几个需要留意的细节

• 缓存是个双刃剑，改了代码不生效时，先想想是不是有缓存没清。
• 不要忽视 warning，它往往是 error 的前奏。
• 权限不足导致的报错往往信息不明确，排查时别忘了检查文件和目录权限。
• 学会用二分法排查：注释掉一半代码，问题范围立刻减半。

写在最后

看完不等于学会，动手跑一遍示例代码，把记录错误日志变成自己的肌肉记忆，这才是本文的正确打开方式。

---

遇见问题加 QQ23979811 协助处理