PHP如何实现一个简单的缓存系统_PHP文件缓存系统实现方法

<?php

class FileCache
{
    private $cacheDir;
    private $defaultTtl; // Default Time To Live in seconds

    public function __construct(string $cacheDir, int $defaultTtl = 3600)
    {
        $this->cacheDir = rtrim($cacheDir, '/') . '/';
        $this->defaultTtl = $defaultTtl;

        if (!is_dir($this->cacheDir)) {
            if (!mkdir($this->cacheDir, 0777, true)) {
                throw new \RuntimeException("无法创建缓存目录: {$this->cacheDir}");
            }
        }
        if (!is_writable($this->cacheDir)) {
            throw new \RuntimeException("缓存目录不可写: {$this->cacheDir}");
        }
    }

    private function getCacheFilePath(string $key): string
    {
        // 使用md5避免文件名过长或包含非法字符
        return $this->cacheDir . md5($key) . '.cache';
    }

    /**
     * 设置缓存数据
     * @param string $key 缓存键名
     * @param mixed $data 要缓存的数据
     * @param int|null $ttl 缓存有效期（秒），如果为null则使用默认值
     * @return bool
     */
    public function set(string $key, $data, ?int $ttl = null): bool
    {
        $filePath = $this->getCacheFilePath($key);
        $expiresAt = time() + ($ttl ?? $this->defaultTtl);

        // 将过期时间与数据一起序列化存储
        $cacheData = [
            'expires_at' => $expiresAt,
            'data' => $data,
        ];

        // 使用file_put_contents和LOCK_EX确保写入原子性
        return file_put_contents($filePath, serialize($cacheData), LOCK_EX) !== false;
    }

    /**
     * 获取缓存数据
     * @param string $key 缓存键名
     * @return mixed|null 如果缓存有效则返回数据，否则返回null
     */
    public function get(string $key)
    {
        $filePath = $this->getCacheFilePath($key);

        if (!file_exists($filePath)) {
            return null;
        }

        // 尝试读取并反序列化数据
        $content = file_get_contents($filePath);
        if ($content === false) {
            // 文件可能被删除或权限问题
            return null;
        }

        $cacheData = @unserialize($content);

        // 检查反序列化是否成功以及数据结构是否符合预期
        if ($cacheData === false || !isset($cacheData['expires_at'], $cacheData['data'])) {
            // 缓存文件损坏，删除它
            $this->delete($key);
            return null;
        }

        // 检查缓存是否过期
        if (time() > $cacheData['expires_at']) {
            $this->delete($key); // 过期则删除
            return null;
        }

        return $cacheData['data'];
    }

    /**
     * 删除指定键的缓存
     * @param string $key 缓存键名
     * @return bool
     */
    public function delete(string $key): bool
    {
        $filePath = $this->getCacheFilePath($key);
        if (file_exists($filePath)) {
            return unlink($filePath);
        }
        return true; // 文件不存在也算删除成功
    }

    /**
     * 清空所有缓存
     * @return bool
     */
    public function clear(): bool
    {
        $success = true;
        foreach (glob($this->cacheDir . '*.cache') as $file) {
            if (is_file($file) && !unlink($file)) {
                $success = false;
            }
        }
        return $success;
    }

    /**
     * 手动清理过期缓存文件，而不是等待被访问时删除
     * 通常通过cron job调用
     */
    public function gc(): void
    {
        foreach (glob($this->cacheDir . '*.cache') as $filePath) {
            if (!is_file($filePath)) {
                continue;
            }

            $content = file_get_contents($filePath);
            if ($content === false) {
                // 无法读取，可能文件损坏或权限问题，尝试删除
                @unlink($filePath);
                continue;
            }

            $cacheData = @unserialize($content);
            if ($cacheData === false || !isset($cacheData['expires_at'])) {
                // 文件损坏，删除它
                @unlink($filePath);
                continue;
            }

            if (time() > $cacheData['expires_at']) {
                @unlink($filePath); // 过期则删除
            }
        }
    }
}

// 使用示例：
// $cache = new FileCache(__DIR__ . '/cache_data', 600); // 缓存目录，默认TTL 10分钟

// // 设置缓存
// $dataToCache = ['name' => 'John Doe', 'age' => 30];
// $cache->set('user_profile_123', $dataToCache, 300); // 缓存5分钟

// // 获取缓存
// $cachedData = $cache->get('user_profile_123');
// if ($cachedData) {
//     echo "从缓存获取: " . json_encode($cachedData) . "\n";
// } else {
//     echo "缓存未命中或已过期\n";
//     // 假设这里是从数据库或API获取数据
//     $freshData = ['name' => 'Jane Doe', 'age' => 25, 'timestamp' => time()];
//     $cache->set('user_profile_123', $freshData, 300);
//     echo "数据已重新缓存\n";
// }

// // 删除特定缓存
// // $cache->delete('user_profile_123');

// // 清空所有缓存
// // $cache->clear();

// // 运行垃圾回收（例如通过cron job每小时运行一次）
// // $cache->gc();
?>

FileCache

set

get

delete

clear

gc