PHP文件缓存实现

安哥网络

PHP文件缓存实现
        有些时候，我们不希望使用redis等第三方缓存，使得系统依赖于IT论坛服务。这时候，文件缓存会是一个不错的选择。
        我们需要文件缓存实现哪些共更能：
        功能实现：get、set、has、increment、decrement、delete、flush
        能够在较短的时间内返回数据
        支持key过期

        原理：
        为了避免一个文件内的数据过大，造成读取文件的时候延迟较高，我们采用一个key-value一个文件的方式实现存储结构。
        为了支持key过期，我们需要把expire数据写入到文件中，所以需要对写入的数据进行序列化处理
        为了能够快速的定位到文件路径，我们采用hash算法一次计算出文件位置
        实现：

1. <?php
   
2. 
   
3. /**
   
4. * Created by PhpStorm.
   
5. * User: Jenner
   
6. * Date: 2015/5/15
   
7. * Time: 15:40
   
8. */
   
9. class LeoFileCache implements LeoCacheInterface
   
10. {
    
11. 
    
12.     /**
    
13.      * 缓存目录
    
14.      * @var
    
15.      */
    
16.     private $cache_dir;
    
17. 
    
18.     /**
    
19.      * @param $cache_dir
    
20.      * @throws Exception
    
21.      */
    
22.     public function __construct($cache_dir)
    
23.     {
    
24.         $this->cache_dir = $cache_dir;
    
25.         if (!is_dir($cache_dir)) {
    
26.             $make_dir_result = mkdir($cache_dir, 0755, true);
    
27.             if ($make_dir_result === false) throw new Exception('Cannot create the cache directory');
    
28.         }
    
29.     }
    
30. 
    
31. 
    
32.     /**
    
33.      * 根据key获取值，会判断是否过期
    
34.      * @param $key
    
35.      * @return mixed
    
36.      */
    
37.     public function get($key)
    
38.     {
    
39.         $cache_data = $this->getItem($key);
    
40.         if ($cache_data === false || !is_array($cache_data)) return false;
    
41. 
    
42.         return $cache_data['data'];
    
43.     }
    
44. 
    
45.     /**
    
46.      * 添加或覆盖一个key
    
47.      * @param $key
    
48.      * @param $value
    
49.      * @param $expire
    
50.      * @return mixed
    
51.      */
    
52.     public function set($key, $value, $expire = 0)
    
53.     {
    
54.         return $this->setItem($key, $value, time(), $expire);
    
55.     }
    
56. 
    
57.     /**
    
58.      * 设置包含元数据的信息
    
59.      * @param $key
    
60.      * @param $value
    
61.      * @param $time
    
62.      * @param $expire
    
63.      * @return bool
    
64.      */
    
65.     private function setItem($key, $value, $time, $expire)
    
66.     {
    
67.         $cache_file = $this->createCacheFile($key);
    
68.         if ($cache_file === false) return false;
    
69. 
    
70.         $cache_data = array('data' => $value, 'time' => $time, 'expire' => $expire);
    
71.         $cache_data = json_encode($cache_data);
    
72. 
    
73.         $put_result = file_put_contents($cache_file, $cache_data);
    
74.         if ($put_result === false) return false;
    
75. 
    
76.         return true;
    
77.     }
    
78. 
    
79.     /**
    
80.      * 创建缓存文件
    
81.      * @param $key
    
82.      * @return bool|string
    
83.      */
    
84.     private function createCacheFile($key)
    
85.     {
    
86.         $cache_file = $this->path($key);
    
87.         if (!file_exists($cache_file)) {
    
88.             $directory = dirname($cache_file);
    
89.             if (!is_dir($directory)) {
    
90.                 $make_dir_result = mkdir($directory, 0755, true);
    
91.                 if ($make_dir_result === false) return false;
    
92.             }
    
93.             $create_result = touch($cache_file);
    
94.             if ($create_result === false) return false;
    
95.         }
    
96. 
    
97.         return $cache_file;
    
98.     }
    
99. 
    
100.     /**
     
101.      * 判断Key是否存在
     
102.      * @param $key
     
103.      * @return mixed
     
104.      */
     
105.     public function has($key)
     
106.     {
     
107.         $value = $this->get($key);
     
108.         if ($value === false) return false;
     
109. 
     
110.         return true;
     
111.     }
     
112. 
     
113.     /**
     
114.      * 加法递增
     
115.      * @param $key
     
116.      * @param int $value
     
117.      * @return mixed
     
118.      */
     
119.     public function increment($key, $value = 1)
     
120.     {
     
121.         $item = $this->getItem($key);
     
122.         if ($item === false) {
     
123.             $set_result = $this->set($key, $value);
     
124.             if ($set_result === false) return false;
     
125.             return $value;
     
126.         }
     
127. 
     
128.         $check_expire = $this->checkExpire($item);
     
129.         if ($check_expire === false) return false;
     
130. 
     
131.         $item['data'] += $value;
     
132. 
     
133.         $result = $this->setItem($key, $item['data'], $item['time'], $item['expire']);
     
134.         if ($result === false) return false;
     
135. 
     
136.         return $item['data'];
     
137.     }
     
138. 
     
139.     /**
     
140.      * 减法递增
     
141.      * @param $key
     
142.      * @param int $value
     
143.      * @return mixed
     
144.      */
     
145.     public function decrement($key, $value = 1)
     
146.     {
     
147.         $item = $this->getItem($key);
     
148.         if ($item === false) {
     
149.             $value = 0 - $value;
     
150.             $set_result = $this->set($key, $value);
     
151.             if ($set_result === false) return false;
     
152.             return $value;
     
153.         }
     
154. 
     
155.         $check_expire = $this->checkExpire($item);
     
156.         if ($check_expire === false) return false;
     
157. 
     
158.         $item['data'] -= $value;
     
159. 
     
160.         $result = $this->setItem($key, $item['data'], $item['time'], $item['expire']);
     
161.         if ($result === false) return false;
     
162. 
     
163.         return $item['data'];
     
164.     }
     
165. 
     
166.     /**
     
167.      * 删除一个key，同事会删除缓存文件
     
168.      * @param $key
     
169.      * @return mixed
     
170.      */
     
171.     public function delete($key)
     
172.     {
     
173.         $cache_file = $this->path($key);
     
174.         if (file_exists($cache_file)) {
     
175.             $unlink_result = unlink($cache_file);
     
176.             if ($unlink_result === false) return false;
     
177.         }
     
178. 
     
179.         return true;
     
180.     }
     
181. 
     
182.     /**
     
183.      * 清楚所有缓存
     
184.      * @return mixed
     
185.      */
     
186.     public function flush()
     
187.     {
     
188.         return $this->delTree($this->cache_dir);
     
189.     }
     
190. 
     
191.     /**
     
192.      * 递归删除目录
     
193.      * @param $dir
     
194.      * @return bool
     
195.      */
     
196.     function delTree($dir)
     
197.     {
     
198.         $files = array_diff(scandir($dir), array('.', '..'));
     
199.         foreach ($files as $file) {
     
200.             (is_dir("$dir/$file")) ? $this->delTree("$dir/$file") : unlink("$dir/$file");
     
201.         }
     
202.         return rmdir($dir);
     
203.     }
     
204. 
     
205.     /**
     
206.      * 根据key获取缓存文件路径
     
207.      *
     
208.      * @param  string $key
     
209.      * @return string
     
210.      */
     
211.     protected function path($key)
     
212.     {
     
213.         $parts = array_slice(str_split($hash = md5($key), 2), 0, 2);
     
214.         return $this->cache_dir . '/' . implode('/', $parts) . '/' . $hash;
     
215.     }
     
216. 
     
217.     /**
     
218.      * 获取含有元数据的信息
     
219.      * @param $key
     
220.      * @return bool|mixed|string
     
221.      */
     
222.     protected function getItem($key)
     
223.     {
     
224.         $cache_file = $this->path($key);
     
225.         if (!file_exists($cache_file) || !is_readable($cache_file)) {
     
226.             return false;
     
227.         }
     
228. 
     
229.         $cache_data = file_get_contents($cache_file);
     
230.         if (empty($cache_data)) return false;
     
231.         $cache_data = json_decode($cache_data, true);
     
232.         if ($cache_data) {
     
233.             $check_expire = $this->checkExpire($cache_data);
     
234.             if ($check_expire === false) {
     
235.                 $this->delete($key);
     
236.                 return false;
     
237.             }
     
238.         }
     
239. 
     
240.         return $cache_data;
     
241.     }
     
242. 
     
243.     /**
     
244.      * 检查key是否过期
     
245.      * @param $cache_data
     
246.      * @return bool
     
247.      */
     
248.     protected function checkExpire($cache_data)
     
249.     {
     
250.         $time = time();
     
251.         $is_expire = intval($cache_data['expire']) !== 0 && (intval($cache_data['time']) + intval($cache_data['expire']) < $time);
     
252.         if ($is_expire) return false;
     
253. 
     
254.         return true;
     
255.     }
     
256. }

复制代码

http://www.huyanping.cn/php%E6%96%87%E4%BB%B6%E7%BC%93%E5%AD%98%E5%AE%9E%E7%8E%B0/


PHP文件缓存实现