缓存 · thinkphp6文档

ThinkPHP采用`think\Cache`类（实际使用`think\facade\Cache`类即可）提供缓存功能支持。内置支持的缓存类型包括file、memcache、wincache、sqlite、redis。 > ThinkPHP的缓存类遵循`PSR-16`规范。 ## 设置全局的缓存配置直接修改配置目录下面的`cache.php`文件。新版的缓存支持多通道，你可以事先定义好所有的缓存类型及配置参数，然后在使用的时候可以随时切换。默认使用的是文件缓存类型，你可以添加`redis`缓存支持，例如： ~~~ return [ 'default' => 'file', 'stores' => [ // 文件缓存 'file' => [ // 驱动方式 'type' => 'file', // 设置不同的缓存保存目录 'path' => '../runtime/file/', ], // redis缓存 'redis' => [ // 驱动方式 'type' => 'redis', // 服务器地址 'host' => '127.0.0.1', ], ], ]; ~~~ 缓存参数根据不同的缓存方式会有所区别，通用的缓存参数如下： | 参数 | 描述 | | --- | --- | | type | 缓存类型 | | expire | 缓存有效期（默认为0 表示永久缓存） | | prefix | 缓存前缀（默认为空） | | serialize | 缓存序列化和反序列化方法 | > 如果是自定义驱动，`type`的值则为自定义驱动的类名（包含命名空间） ## 使用 ### 设置缓存设置缓存有效期 ~~~ // 缓存在3600秒之后过期 Cache::set('name', $value, 3600); ~~~ 可以使用`DateTime`对象设置过期时间 ~~~ Cache::set('name', $value, new DateTime('2019-10-01 12:00:00')); ~~~ 如果设置成功返回true，否则返回false。 ### 缓存自增针对数值类型的缓存数据，可以使用自增操作，例如： ~~~ Cache::set('name', 1); // name自增（步进值为1） Cache::inc('name'); // name自增（步进值为3） Cache::inc('name',3); ~~~ > 只能对数字或者浮点型数据进行自增和自减操作。 ### 缓存自减针对数值类型的缓存数据，可以使用自减操作，例如： ~~~ // name自减（步进值为1） Cache::dec('name'); // name自减（步进值为3） Cache::dec('name',3); ~~~ ### 获取缓存获取缓存数据可以使用： ~~~ Cache::get('name'); ~~~ 如果`name`值不存在，则默认返回`false`。支持指定默认值，例如： ~~~ Cache::get('name',''); ~~~ 表示如果`name`值不存在，则返回空字符串。 ### 追加一个缓存数据如果缓存数据是一个数组，可以通过`push`方法追加一个数据。 ~~~ Cache::set('name', [1,2,3]); Cache::push('name', 4); Cache::get('name'); // [1,2,3,4] ~~~ ### 删除缓存 ~~~ Cache::delete('name'); ~~~ ### 获取并删除缓存 ~~~ Cache::pull('name'); ~~~ 如果`name`值不存在，则返回`null`。 ### 清空缓存 ~~~ Cache::clear(); ~~~ ### 不存在则写入缓存数据后返回 ~~~ Cache::remember('start_time', time()); ~~~ 如果start\_time缓存数据不存在，则会设置缓存数据为当前时间。第二个参数可以使用闭包方法获取缓存数据，并支持依赖注入。 ~~~ Cache::remember('start_time', function(Request $request){ return $request->time(); }); ~~~ remember方法的第三个参数可以设置缓存的有效期。 ### 缓存标签支持给缓存数据打标签，例如： ~~~ Cache::tag('tag')->set('name1','value1'); Cache::tag('tag')->set('name2','value2'); // 清除tag标签的缓存数据 Cache::tag('tag')->clear(); ~~~ 并支持同时指定多个缓存标签操作 ~~~ Cache::tag(['tag1', 'tag2'])->set('name1', 'value1'); Cache::tag(['tag1', 'tag2'])->set('name2', 'value2'); // 清除多个标签的缓存数据 Cache::tag(['tag1','tag2'])->clear(); ~~~ 可以追加某个缓存到标签 ~~~ Cache::tag('tag')->append('name3'); ~~~ ### 获取缓存对象可以获取缓存对象，并且调用驱动类的高级方法，例如： ~~~ // 获取缓存对象句柄 $handler = Cache::handler(); ~~~ ### 助手函数系统对缓存操作提供了助手函数`cache`，用法如下： ~~~ // 设置缓存数据 cache('name', $value, 3600); // 获取缓存数据 var_dump(cache('name')); // 删除缓存数据 cache('name', NULL); // 返回缓存对象实例 $cache = cache(); ~~~ ## 跨应用缓存默认情况下，文件缓存数据是区分不同应用的，如果你希望缓存跨应用，可以设置一个统一的数据缓存`path`目录。 ## 切换缓存类型没有指定缓存类型的话，默认读取的是`default`缓存配置，可以动态切换 ~~~ // 使用文件缓存 Cache::set('name','value',3600); Cache::get('name'); // 使用Redis缓存 Cache::store('redis')->set('name','value',3600); Cache::store('redis')->get('name'); // 切换到文件缓存 Cache::store('default')->set('name','value',3600); Cache::store('default')->get('name'); ~~~ 如果要返回当前缓存类型对象的句柄，可以使用 ~~~ // 获取Redis对象进行额外方法调用 Cache::store('redis')->handler(); ~~~ ## 自定义驱动如果需要自定义缓存驱动，需要继承`think\cache\Driver`类，并且实现`think\contract\CacheHandlerInterface`接口。 ~~~ interface CacheHandlerInterface { /** * 判断缓存 * @access public * @param string $name 缓存变量名 * @return bool */ public function has($name): bool; /** * 读取缓存 * @access public * @param string $name 缓存变量名 * @param mixed $default 默认值 * @return mixed */ public function get($name, $default = false); /** * 写入缓存 * @access public * @param string $name 缓存变量名 * @param mixed $value 存储数据 * @param integer|\DateTime $expire 有效时间（秒） * @return bool */ public function set($name, $value, $expire = null): bool; /** * 自增缓存（针对数值缓存） * @access public * @param string $name 缓存变量名 * @param int $step 步长 * @return false|int */ public function inc(string $name, int $step = 1); /** * 自减缓存（针对数值缓存） * @access public * @param string $name 缓存变量名 * @param int $step 步长 * @return false|int */ public function dec(string $name, int $step = 1); /** * 删除缓存 * @access public * @param string $name 缓存变量名 * @return bool */ public function delete($name): bool; /** * 清除缓存 * @access public * @return bool */ public function clear(): bool; } ~~~ 使用自定义驱动后，只需要配置缓存`type`的值为该驱动类名（包含命名空间）即可。