文件名后缀检查的需求与挑战
在日常的系统维护中，我们经常需要处理大量具有特定命名模式的文件。例如，一个缓存目录可能包含形如 filename-number.json 的文件，如 sifriugh-80.json、dlifjbhvzique-76.json 等。当需要对这些文件进行清理时，往往会遇到更复杂的业务逻辑，例如：
- 大部分文件需要定期（如每2小时）清理。
- 某些特定后缀的文件（如以 -100.json 结尾的文件）需要更长的保留时间（如每7天清理）。
这种需求的核心在于如何高效且准确地判断一个文件名是否以特定的字符串结尾。
PHP 8+ 的解决方案：str_ends_with()
从PHP 8.0版本开始，PHP引入了内置函数 str_ends_with()，它提供了一种简洁、高效且易读的方式来检查字符串是否以另一个字符串结尾。
str_ends_with() 函数详解
str_ends_with(string $haystack, string $needle): bool
- $haystack: 要检查的原始字符串（例如，文件名）。
- $needle: 要查找的后缀字符串。
- 返回值：如果 $haystack 以 $needle 结尾，则返回 true；否则返回 false。
应用示例：条件文件清理
结合文件系统迭代器，我们可以轻松实现上述的条件清理逻辑。以下是一个完整的示例代码：
立即学习“PHP免费学习笔记（深入）”；
<?php
// 假设缓存目录名为 'cache'
$cacheDir = 'cache';
// 确保缓存目录存在
if (!is_dir($cacheDir)) {
mkdir($cacheDir, 0777, true);
}
// 模拟创建一些文件用于测试
// file_put_contents($cacheDir . '/sifriugh-80.json', 'content');
// file_put_contents($cacheDir . '/dlifjbhvzique-76.json', 'content');
// file_put_contents($cacheDir . '/dfhgzeiuy-12.json', 'content');
// file_put_contents($cacheDir . '/special-file-100.json', 'content');
// file_put_contents($cacheDir . '/another-100.json', 'content');
// file_put_contents($cacheDir . '/normal-file.json', 'content');
$fileSystemIterator = new FilesystemIterator($cacheDir);
$now = time();
echo "开始清理操作...\n";
foreach ($fileSystemIterator as $file) {
// 获取文件名和创建时间
$filename = $file->getFilename();
$creationTime = $file->getCTime(); // 获取文件的inode修改时间，通常接近创建时间
// 计算文件存在时长
$fileAgeSeconds = $now - $creationTime;
// 定义清理周期（秒）
$regularCleanupThreshold = 3 * 3600; // 3小时 (原需求为2小时，但示例代码为3小时，这里保持一致)
$specialCleanupThreshold = 7 * 24 * 3600; // 7天
echo "处理文件: " . $filename . " (创建于: " . date('Y-m-d H:i:s', $creationTime) . ", 已存在: " . round($fileAgeSeconds / 3600) . "小时)\n";
// 检查文件名是否以 '-100.json' 结尾
if (str_ends_with($filename, '-100.json')) {
// 对于以 '-100.json' 结尾的文件，每7天清理一次
if ($fileAgeSeconds >= $specialCleanupThreshold) {
unlink($file->getPathname());
echo " [已删除] 文件 '" . $filename . "'，因为它已超过7天。\n";
} else {
echo " [保留] 文件 '" . $filename . "'，因为它未超过7天。\n";
}
} else {
// 对于其他文件，每3小时清理一次
if ($fileAgeSeconds >= $regularCleanupThreshold) {
unlink($file->getPathname());
echo " [已删除] 文件 '" . $filename . "'，因为它已超过3小时。\n";
} else {
echo " [保留] 文件 '" . $filename . "'，因为它未超过3小时。\n";
}
}
}
echo "清理操作完成。\n";
?>注意事项：
- str_ends_with() 是大小写敏感的。如果需要进行不区分大小写的匹配，可以先将文件名转换为小写（strtolower()）。
- getCTime() 在某些文件系统上可能不代表文件创建时间，而是inode修改时间。如果需要精确的创建时间，可能需要依赖其他机制或文件本身的元数据。对于大多数缓存清理场景，getCTime() 或 getMTime() (修改时间) 已足够。
PHP 7 及更早版本的替代方案
如果您的项目运行在PHP 7或更早的版本上，str_ends_with() 函数将不可用。不过，我们可以通过几种方式来模拟其功能。
1. 使用 substr() 和 strlen()
这是最常见的模拟方式，通过截取字符串的末尾部分并与目标后缀进行比较。
function endsWith(string $haystack, string $needle): bool
{
$length = strlen($needle);
if ($length === 0) {
return true; // 空字符串总是任何字符串的结尾
}
return (substr($haystack, -$length) === $needle);
}
// 使用示例
// if (endsWith($filename, '-100.json')) { ... }优点： 简单、直接，性能良好。 缺点： 不支持多字节字符串（如UTF-8编码的中文文件名），如果文件名包含多字节字符，strlen() 和 substr() 可能会导致错误的结果。
2. 使用 mb_substr() 和 mb_strlen() (针对多字节字符串)
如果文件名可能包含多字节字符，应使用多字节字符串函数。
function mbEndsWith(string $haystack, string $needle, string $encoding = 'UTF-8'): bool
{
$length = mb_strlen($needle, $encoding);
if ($length === 0) {
return true;
}
return (mb_substr($haystack, -$length, null, $encoding) === $needle);
}
// 使用示例
// if (mbEndsWith($filename, '-100.json')) { ... }优点： 支持多字节字符串。 缺点： 相比 str_ends_with() 或 substr()，性能略有下降。
3. 使用 preg_match() (正则表达式)
正则表达式虽然功能强大，但对于简单的字符串结尾检查，通常不是最高效或最易读的选择。
function regexEndsWith(string $haystack, string $needle): bool
{
// 将 needle 转换为正则表达式模式，并转义特殊字符
$pattern = '/'. preg_quote($needle, '/') . '$/';
return (bool) preg_match($pattern, $haystack);
}
// 使用示例
// if (regexEndsWith($filename, '-100.json')) { ... }优点： 灵活，可以处理更复杂的模式匹配。 缺点： 对于简单后缀检查，性能通常低于 str_ends_with() 或 substr()，且代码可读性略差。
总结与最佳实践
- PHP 8+ 环境： 强烈推荐使用原生的 str_ends_with() 函数。它在性能、可读性和简洁性方面都表现最佳。
-
PHP 7 及更早环境：
- 如果确定文件名只包含ASCII字符，使用 substr() 和 strlen() 组合是高效且简单的选择。
- 如果文件名可能包含多字节字符，优先使用 mb_substr() 和 mb_strlen()。
- preg_match() 适用于更复杂的模式匹配需求，但在仅检查后缀时，应谨慎考虑其性能开销。
- 文件系统操作： 在进行文件清理时，务必小心。在 unlink() 之前，可以增加日志记录或 dry-run 模式，以防止误删重要文件。
- 错误处理： 实际生产环境中，应考虑 unlink() 失败的情况，并进行相应的错误处理。
- 效率： FilesystemIterator 比 scandir() 更高效，因为它以迭代器的方式逐个处理文件，而不是一次性加载所有文件到内存中。
通过选择适合您PHP版本的字符串处理函数，您可以有效地实现基于文件后缀的复杂文件管理和清理策略，从而提高系统的健壮性和可维护性。
