问题背景
在使用ThinkPHP5.1框架进行开发的过程中，我遇到了一个与日志管理相关的问题。当系统设置了日志文件大小限制和最大文件数量限制时，日志文件的备份和清理机制出现了问题，导致重要的日志记录丢失。
问题描述
ThinkPHP5.1的日志管理功能允许设置单个日志文件的大小上限(file_size)以及最大保存的文件数量(max_files)。当单个日志文件达到设定的大小限制时，系统会通过checkLogSize方法创建一个备份文件，并以时间戳作为前缀(如1659063483-20220729_api.log)。
然而，当日志文件数量达到设定的上限时，系统会调用glob($this->config['path'] . '*.log')获取所有日志文件，然后按照文件名排序并删除最早的文件。由于备份日志文件的命名方式是以时间戳为前缀，这导致时间戳前缀的备份文件总是按照字母顺序排在前面，因此会被优先删除，即使它们可能包含较新的日志记录。
问题的核心在于：系统根据文件名而不是文件的实际创建时间来决定删除哪些日志文件，导致可能丢失当天的重要日志记录，只保留了每天最后生成的日志文件。
问题代码分析
问题主要出在File类的两个方法中：
checkLogSize方法 - 生成备份文件时使用时间戳作为前缀：
protected function checkLogSize($destination)
{
if (is_file($destination) && floor($this->config['file_size']) <= filesize($destination)) {
try {
rename($destination, dirname($destination) . DIRECTORY_SEPARATOR . time() . '-' . basename($destination));
} catch (\Exception $e) {
}
}
}getMasterLogFile方法 - 删除旧文件时简单按文件名排序：
protected function getMasterLogFile()
{
if ($this->config['max_files']) {
$files = glob($this->config['path'] . '*.log');
try {
if (count($files) > $this->config['max_files']) {
unlink($files[0]);
}
} catch (\Exception $e) {
}
}
// 其余代码...
}解决方案
为了解决这个问题，我对这两个方法进行了修改：
- 修改
checkLogSize方法，使备份文件的命名格式更符合时间顺序：
protected function checkLogSize($destination)
{
if (is_file($destination) && floor($this->config['file_size']) <= filesize($destination)) {
try {
// 使用更符合排序的时间格式
$backupName = dirname($destination) . DIRECTORY_SEPARATOR .
date('YmdHis') . '-' . basename($destination);
rename($destination, $backupName);
} catch (\Exception $e) {
}
}
}- 修改
getMasterLogFile方法，按文件的修改时间而不是文件名来排序：
protected function getMasterLogFile()
{
if ($this->config['max_files']) {
// 获取所有日志文件
$files = glob($this->config['path'] . '*.log');
if (count($files) > $this->config['max_files']) {
try {
// 按文件修改时间排序
$fileData = [];
foreach ($files as $file) {
$fileData[$file] = filemtime($file);
}
asort($fileData); // 按时间从旧到新排序
// 计算需要删除的文件数
$deleteCount = count($files) - $this->config['max_files'];
$i = 0;
// 删除最旧的文件
foreach ($fileData as $file => $mtime) {
if ($i < $deleteCount) {
unlink($file);
$i++;
} else {
break;
}
}
} catch (\Exception $e) {
}
}
}
// 其余代码保持不变...
}改进效果
这两处修改解决了原有日志管理机制的问题：
- 新的备份文件命名格式(
YmdHis前缀)确保了文件名排序与时间顺序一致 - 基于文件修改时间的排序和删除逻辑，确保了系统总是保留最新的日志文件，而不是简单地基于文件名删除
这样一来，即使日志文件数量达到上限，系统也会正确地删除最早的日志文件，而不是可能仍然包含重要信息的近期备份文件。
总结
ThinkPHP作为一个流行的PHP框架，提供了很多实用的功能，但有时也会有一些细节问题需要我们去发现和解决。在日志管理这个看似简单的功能中，文件的命名和删除逻辑却可能导致意外的数据丢失。通过理解框架的工作原理并进行适当的修改，我们可以让系统的行为更符合预期，确保重要的日志信息不会丢失。
对于正在使用ThinkPHP5.1进行开发的朋友，如果你也设置了日志文件大小限制和最大文件数量限制，建议检查一下你的日志管理机制是否存在类似问题，并参考上述方案进行修改。