hyperf/zh/cache.md

103 lines
2.7 KiB
Markdown
Raw Normal View History

2019-03-08 12:04:46 +08:00
# Cache
2019-04-05 10:01:15 +08:00
[hyperf/cache](https://github.com/hyperf-cloud/cache) 提供了基于 `Aspect` 实现的切面缓存,也提供了实现 `Psr\SimpleCache\CacheInterface` 的缓存类。
2019-03-08 12:04:46 +08:00
2019-03-21 13:42:28 +08:00
## 安装
```
composer require hyperf/cache
```
2019-03-08 12:04:46 +08:00
## 默认配置
2019-03-22 17:41:09 +08:00
| 配置 | 默认值 | 备注 |
|:------:|:----------------------------------------:|:---------------------:|
| driver | Hyperf\Cache\Driver\RedisDriver::class | 缓存驱动默认为Redis |
| packer | Hyperf\Cache\Packer\PhpSerializer::class | 打包器 |
| prefix | 'c:' | 缓存前缀 |
2019-03-19 14:52:21 +08:00
```php
2019-03-08 12:04:46 +08:00
<?php
return [
'default' => [
'driver' => Hyperf\Cache\Driver\RedisDriver::class,
'packer' => Hyperf\Cache\Packer\PhpSerializer::class,
2019-03-22 17:41:09 +08:00
'prefix' => 'c:',
2019-03-08 12:04:46 +08:00
],
];
2019-03-19 14:52:21 +08:00
```
2019-03-08 12:04:46 +08:00
## 使用
2019-03-22 17:41:09 +08:00
### 注解方式
2019-03-21 15:04:42 +08:00
组件提供 `Hyperf\Cache\Annotation\Cacheable` 注解,作用于类方法,可以配置对应的缓存前缀、失效时间、监听器和缓存组。
例如UserService 提供一个 user 方法可以查询对应id的用户信息。当加上 `Hyperf\Cache\Annotation\Cacheable` 注解后会自动生成对应的Redis缓存key值为`user:id`,超时时间为 9000 秒。首次查询时,会从数据库中查,后面查询时,会从缓存中查。
2019-03-08 12:04:46 +08:00
2019-03-19 14:52:21 +08:00
```php
2019-03-08 12:04:46 +08:00
<?php
namespace App\Services;
use App\Models\User;
use Hyperf\Cache\Annotation\Cacheable;
class UserService
{
/**
* @Cacheable(key="user", ttl=9000, listener="user-update")
*/
public function user($id)
{
2019-04-05 10:01:15 +08:00
$user = User::query()->where('id',$id)->first();
2019-03-08 12:04:46 +08:00
if($user){
return $user->toArray();
}
return null;
}
}
2019-03-19 14:52:21 +08:00
```
2019-03-08 12:04:46 +08:00
2019-03-22 17:41:09 +08:00
### 清理注解缓存
2019-03-08 12:04:46 +08:00
2019-03-21 15:04:42 +08:00
当然,如果我们数据库中的数据改变了,如果删除缓存呢?这里就需要用到后面的监听器。下面新建一个 Service 提供一方法,来帮我们处理缓存。
2019-03-08 12:04:46 +08:00
2019-03-19 14:52:21 +08:00
```php
2019-03-08 12:04:46 +08:00
<?php
declare(strict_types=1);
namespace App\Service;
use Hyperf\Di\Annotation\Inject;
use Hyperf\Cache\Listener\DeleteListenerEvent;
use Psr\EventDispatcher\EventDispatcherInterface;
class SystemService
{
/**
* @Inject
* @var EventDispatcherInterface
*/
protected $dispatcher;
public function flushCache($userId)
{
$this->dispatcher->dispatch(new DeleteListenerEvent('user-update', [$userId]));
return true;
}
}
2019-03-22 17:41:09 +08:00
```
### SimpleCache方式
如果您只想使用实现 `Psr\SimpleCache\CacheInterface` 缓存类,比如重写 `EasyWeChat` 缓存模块,可以很方便的从 `Container` 中获取相应对象。
```php
$cache = $container->get(Psr\SimpleCache\CacheInterface::class);
2019-03-19 14:52:21 +08:00
```