在PHP项目开发中，文件替换操作常常涉及重要资源的更新，为了避免后续出现问题时无法追溯操作源头，在替换文件的同时记录完整的操作日志是非常有必要的。操作日志需要包含操作时间、操作人、原文件路径、新文件路径、替换结果等核心信息，方便后续审计和问题排查。
操作日志的核心内容规划
在记录文件替换日志之前，首先需要明确日志需要包含哪些关键信息，确保日志具备可追溯性。通常需要记录的内容如下：
- 操作时间：记录文件替换操作发生的具体时间戳
- 操作人标识：如果是登录系统操作，记录操作用户的唯一ID或用户名
- 原文件路径：被替换的文件完整绝对路径
- 新文件路径：用来替换的新文件的完整绝对路径
- 操作结果：记录替换操作是成功还是失败，失败的话记录具体错误信息
- 备份路径：如果替换前做了原文件备份，记录备份文件的存放路径
基础日志记录实现
我们可以使用PHP的文件写入函数，将日志内容按固定格式写入到指定的日志文件中。以下是一个简单的实现示例，包含文件替换和日志记录两个核心步骤。
<?php
/**
* 替换文件并记录操作日志
* @param string $oldFile 原文件路径
* @param string $newFile 新文件路径
* @param string $operator 操作人标识
* @param string $logFile 日志文件路径
* @return bool 替换是否成功
*/
function replaceFileWithLog($oldFile, $newFile, $operator, $logFile) {
// 记录操作开始时间
$operateTime = date('Y-m-d H:i:s');
$logContent = "操作时间：{$operateTime}" . PHP_EOL;
$logContent .= "操作人：{$operator}" . PHP_EOL;
$logContent .= "原文件：{$oldFile}" . PHP_EOL;
$logContent .= "新文件：{$newFile}" . PHP_EOL;
// 检查原文件是否存在
if (!file_exists($oldFile)) {
$logContent .= "操作结果：失败，原文件不存在" . PHP_EOL;
// 写入日志
file_put_contents($logFile, $logContent, FILE_APPEND);
return false;
}
// 检查新文件是否存在
if (!file_exists($newFile)) {
$logContent .= "操作结果：失败，新文件不存在" . PHP_EOL;
file_put_contents($logFile, $logContent, FILE_APPEND);
return false;
}
// 备份原文件
$backupDir = dirname($logFile) . '/backup/';
if (!is_dir($backupDir)) {
mkdir($backupDir, 0755, true);
}
$backupFile = $backupDir . basename($oldFile) . '_' . time();
if (!copy($oldFile, $backupFile)) {
$logContent .= "操作结果：失败，原文件备份失败" . PHP_EOL;
file_put_contents($logFile, $logContent, FILE_APPEND);
return false;
}
$logContent .= "备份文件：{$backupFile}" . PHP_EOL;
// 执行文件替换
if (copy($newFile, $oldFile)) {
$logContent .= "操作结果：成功" . PHP_EOL;
file_put_contents($logFile, $logContent, FILE_APPEND);
return true;
} else {
$logContent .= "操作结果：失败，文件替换失败" . PHP_EOL;
file_put_contents($logFile, $logContent, FILE_APPEND);
return false;
}
}
// 调用示例
$oldFile = '/www/project/data/config.ini';
$newFile = '/www/project/upload/new_config.ini';
$operator = 'admin_001';
$logFile = '/www/project/logs/file_replace.log';
replaceFileWithLog($oldFile, $newFile, $operator, $logFile);
?>
优化日志记录方案
使用JSON格式存储日志
如果后续需要对日志进行解析或者导入到数据库，使用JSON格式存储日志会更方便。只需要调整日志内容的拼接逻辑即可。
<?php
function replaceFileWithJsonLog($oldFile, $newFile, $operator, $logFile) {
$logData = [
'operate_time' => date('Y-m-d H:i:s'),
'operator' => $operator,
'old_file' => $oldFile,
'new_file' => $newFile,
'result' => '',
'backup_file' => '',
'error_msg' => ''
];
if (!file_exists($oldFile)) {
$logData['result'] = 'fail';
$logData['error_msg'] = '原文件不存在';
file_put_contents($logFile, json_encode($logData, JSON_UNESCAPED_UNICODE) . PHP_EOL, FILE_APPEND);
return false;
}
if (!file_exists($newFile)) {
$logData['result'] = 'fail';
$logData['error_msg'] = '新文件不存在';
file_put_contents($logFile, json_encode($logData, JSON_UNESCAPED_UNICODE) . PHP_EOL, FILE_APPEND);
return false;
}
$backupDir = dirname($logFile) . '/backup/';
if (!is_dir($backupDir)) {
mkdir($backupDir, 0755, true);
}
$backupFile = $backupDir . basename($oldFile) . '_' . time();
if (!copy($oldFile, $backupFile)) {
$logData['result'] = 'fail';
$logData['error_msg'] = '原文件备份失败';
file_put_contents($logFile, json_encode($logData, JSON_UNESCAPED_UNICODE) . PHP_EOL, FILE_APPEND);
return false;
}
$logData['backup_file'] = $backupFile;
if (copy($newFile, $oldFile)) {
$logData['result'] = 'success';
file_put_contents($logFile, json_encode($logData, JSON_UNESCAPED_UNICODE) . PHP_EOL, FILE_APPEND);
return true;
} else {
$logData['result'] = 'fail';
$logData['error_msg'] = '文件替换失败';
file_put_contents($logFile, json_encode($logData, JSON_UNESCAPED_UNICODE) . PHP_EOL, FILE_APPEND);
return false;
}
}
?>
日志文件的分隔管理
如果文件替换操作比较频繁，单个日志文件会变得很大，不利于管理和查看。可以按照日期对日志文件进行分隔，每天的日志存储到对应日期的文件中。
<?php
function getDailyLogFile($baseLogDir) {
if (!is_dir($baseLogDir)) {
mkdir($baseLogDir, 0755, true);
}
$logFile = $baseLogDir . '/file_replace_' . date('Ymd') . '.log';
return $logFile;
}
// 调用示例，日志文件按天存储
$baseLogDir = '/www/project/logs';
$logFile = getDailyLogFile($baseLogDir);
$oldFile = '/www/project/data/config.ini';
$newFile = '/www/project/upload/new_config.ini';
$operator = 'admin_001';
replaceFileWithLog($oldFile, $newFile, $operator, $logFile);
?>
注意事项
在实现文件替换日志记录时，需要注意以下几点：
- 日志文件的目录需要提前设置好写入权限，避免写入日志时出现权限不足的错误
- 如果操作人信息来自用户登录态，需要确保操作人标识的准确性，避免记录错误的操作人
- 备份文件需要定期清理，避免长期积累占用过多的服务器磁盘空间
- 如果替换的是核心配置文件，建议在替换前先校验新文件的内容格式，避免替换后导致系统异常
如果项目使用了框架，也可以结合框架自带的日志组件来实现文件替换日志记录，比如Laravel的Log门面、ThinkPHP的日志类等，能够更方便地实现日志的分级、存储驱动切换等功能。