PHP文件清理策略：使用str_ends_with实现基于文件后缀的条件删除

本教程探讨了在PHP中根据文件名的特定后缀实现精细化文件清理的策略。针对缓存目录中带有数字后缀（如-100.json）的文件，我们将介绍如何利用PHP 8+的str_ends_with()函数高效判断文件后缀，并据此应用不同的删除周期（例如，常规文件2小时，特定文件7天），同时提供PHP 7的兼容方案，以优化文件管理效率和代码可读性。

问题背景：缓存文件与差异化清理需求

在许多web应用中，缓存目录（如cache/）通常会存储大量临时文件，这些文件可能以特定的命名模式存在，例如sifriugh-80.json、dlifjbhvzique-76.json等，通常包含一个基础名称和动态生成的数字后缀。为了有效管理这些缓存文件，我们经常需要定期清理过期文件。

然而，实际需求往往更为复杂。例如，我们可能需要对某些特定后缀的文件（如以-100.json结尾的文件）采取不同的清理策略，例如将其保留更长时间（如7天），而其他常规文件则在较短时间（如2小时）后删除。传统的清理脚本可能只简单地根据文件创建时间进行统一删除，无法满足这种精细化的管理需求。如果尝试使用正则表达式来判断文件名后缀，可能会导致代码复杂且不易阅读，尤其对于简单的后缀匹配而言。

核心解决方案：PHP 8+ str_ends_with() 函数

从PHP 8.0版本开始，PHP引入了一个非常实用的字符串函数str_ends_with()，用于判断一个字符串是否以另一个字符串结尾。这个函数简洁、高效且易于理解，是解决上述文件后缀判断问题的理想选择。

函数签名：

str_ends_with(string $haystack, string $needle): bool

其中：

立即学习“PHP免费学习笔记（深入）”；

• $haystack 是要检查的完整字符串（例如文件名）。
• $needle 是要查找的后缀字符串。
• 如果 $haystack 以 $needle 结尾，则返回 true，否则返回 false。

示例代码：基本用法

以下是如何在文件清理逻辑中利用str_ends_with()进行条件判断的示例：

<?php
$filename1 = 'sifriugh-80.json';
$filename2 = 'dfhgzeiuy-100.json';
if (str_ends_with($filename1, '-100.json')) {
echo "{$filename1} 以 '-100.json' 结尾，执行特殊清理逻辑。\n";
} else {
echo "{$filename1} 不以 '-100.json' 结尾，执行常规清理逻辑。\n";
}
// 输出: sifriugh-80.json 不以 '-100.json' 结尾，执行常规清理逻辑。
if (str_ends_with($filename2, '-100.json')) {
echo "{$filename2} 以 '-100.json' 结尾，执行特殊清理逻辑。\n";
} else {
echo "{$filename2} 不以 '-100.json' 结尾，执行常规清理逻辑。\n";
}
// 输出: dfhgzeiuy-100.json 以 '-100.json' 结尾，执行特殊清理逻辑。
?>

PHP 7 及更早版本的兼容方案

如果您的项目运行在PHP 7或更早版本，str_ends_with()函数将不可用。不过，我们可以通过自定义函数来模拟其功能。一种常见且高效的方法是使用substr()函数结合字符串长度判断：

<?php
// 为 PHP 7 及更早版本模拟 str_ends_with() 函数
if (!function_exists('str_ends_with')) {
function str_ends_with(string $haystack, string $needle): bool
{
if ($needle === '') {
return true; // 空字符串被认为是任何字符串的结尾
}
$len = strlen($needle);
return substr($haystack, -$len) === $needle;
}
}
// 现在可以在 PHP 7 环境中使用 str_ends_with() 函数
$filename = 'example-100.json';
if (str_ends_with($filename, '-100.json')) {
echo "文件 {$filename} 满足条件。\n";
} else {
echo "文件 {$filename} 不满足条件。\n";
}
?>

这个模拟函数首先检查 $needle 是否为空字符串，因为空字符串在逻辑上被认为是任何字符串的结尾。然后，它通过获取 $needle 的长度，并使用 substr($haystack, -$len) 从 $haystack 的末尾提取相同长度的子字符串进行比较。

整合清理逻辑：构建完整的缓存清理脚本

现在，我们将上述的文件后缀判断逻辑整合到一个完整的缓存清理脚本中，以实现差异化的文件删除策略。

<?php
// 为 PHP 7 及更早版本模拟 str_ends_with() 函数
if (!function_exists('str_ends_with')) {
function str_ends_with(string $haystack, string $needle): bool
{
if ($needle === '') {
return true;
}
$len = strlen($needle);
return substr($haystack, -$len) === $needle;
}
}
$cacheDir = 'cache'; // 缓存目录路径
// 确保缓存目录存在且可读写
if (!is_dir($cacheDir) || !is_readable($cacheDir)) {
die("错误：缓存目录 '{$cacheDir}' 不存在或不可读。\n");
}
$fileSystemIterator = new FilesystemIterator($cacheDir);
$now = time();
// 定义清理周期（秒）
$regularDeletionThreshold = 2 * 3600;      // 2小时
$specialDeletionThreshold = 7 * 24 * 3600; // 7天
echo "开始清理缓存目录 '{$cacheDir}'...\n";
foreach ($fileSystemIterator as $file) {
// 检查文件是否为实际文件，排除目录等
if (!$file->isFile()) {
continue;
}
$filename = $file->getFilename();
$filePath = $file->getPathname(); // 获取文件的完整路径
$fileCreationTime = $file->getCTime(); // 获取文件创建时间 (Change Time)
// 计算文件已存在的时间（秒）
$age = $now - $fileCreationTime;
// 判断文件是否为特殊文件（以 '-100.json' 结尾）
$isSpecialFile = str_ends_with($filename, '-100.json');
if ($isSpecialFile) {
// 对于以 '-100.json' 结尾的特殊文件，如果超过7天则删除
if ($age >= $specialDeletionThreshold) {
echo "  [删除] 特殊文件: {$filename} (创建于 " . date('Y-m-d H:i:s', $fileCreationTime) . ", 已存在 {$age}s)\n";
if (!unlink($filePath)) {
error_log("无法删除文件: {$filePath}");
echo "    -> 警告：删除失败！\n";
}
} else {
echo "  [保留] 特殊文件: {$filename} (创建于 " . date('Y-m-d H:i:s', $fileCreationTime) . ", 已存在 {$age}s, 未达7天删除阈值)\n";
}
} else {
// 对于其他常规文件，如果超过2小时则删除
if ($age >= $regularDeletionThreshold) {
echo "  [删除] 常规文件: {$filename} (创建于 " . date('Y-m-d H:i:s', $fileCreationTime) . ", 已存在 {$age}s)\n";
if (!unlink($filePath)) {
error_log("无法删除文件: {$filePath}");
echo "    -> 警告：删除失败！\n";
}
} else {
echo "  [保留] 常规文件: {$filename} (创建于 " . date('Y-m-d H:i:s', $fileCreationTime) . ", 已存在 {$age}s, 未达2小时删除阈值)\n";
}
}
}
echo "缓存清理完成。\n";
?>

如何运行此脚本：

1. 创建一个名为 cache 的目录。
2. 在 cache 目录中创建一些测试文件，例如：
   • file-1.json (创建时间较早，模拟过期)
   • file-2.json (创建时间较近，模拟未过期)
   • special-file-100.json (创建时间较早，模拟过期)
   • another-100.json (创建时间较近，模拟未过期)
3. 将上述PHP代码保存为 clean_cache.php。
4. 在命令行中执行 php clean_cache.php。
   脚本将输出清理过程和结果。

注意事项与最佳实践

1. 错误处理： 文件操作（如 unlink()）可能会失败，例如文件权限不足或文件已被删除。在生产环境中，务必添加健壮的错误处理机制，例如使用 try-catch 块或检查 unlink() 的返回值，并通过 error_log() 记录错误信息。
2. 文件时间：
   • $file->getCTime() 返回的是文件的 inode 改变时间（Change Time），在某些操作系统上，这可能不是文件的创建时间，而是文件元数据（如权限、所有者）发生改变的时间。
   • $file->getMTime() 返回的是文件的修改时间（Modification Time），即文件内容最后一次被修改的时间。
   • $file->getATime() 返回的是文件的访问时间（Access Time），即文件最后一次被读取的时间。
   • 根据您的具体需求，选择最合适的“时间戳”来判断文件是否过期。在大多数缓存清理场景中，getMTime() 可能更符合预期。
3. 性能考量： 对于包含数万甚至数十万个文件的超大型缓存目录，FilesystemIterator 的迭代过程本身可能需要一定时间。如果性能成为瓶颈，可以考虑分批处理或使用更高级的缓存管理系统。
4. 路径安全： 确保脚本操作的 $cacheDir 路径是受控且安全的，避免意外删除重要文件。
5. 替代方案： 尽管 str_ends_with() 对于简单的后缀匹配非常有效，但如果您的文件名匹配逻辑更为复杂，例如需要匹配多个不连续的模式，或者需要从文件名中提取特定信息，那么正则表达式（preg_match()）仍然是更强大和灵活的工具。但在简单后缀判断的场景下，str_ends_with() 具有更好的可读性和可能更高的效率。
6. 日志记录： 在实际应用中，建议将清理操作的详细信息记录到日志文件中，以便追踪和审计。

总结

通过利用PHP 8+的str_ends_with()函数（或其PHP 7兼容模拟），我们可以轻松地在文件清理脚本中实现基于文件名后缀的差异化处理逻辑。这种方法不仅提高了代码的可读性和维护性，而且相比复杂的正则表达式，对于简单的后缀判断更为高效。结合文件系统迭代和时间判断，您可以构建出功能强大且灵活的缓存文件管理系统，以满足各种复杂的清理需求。