模型缓存

在高频场景下,我们会频繁的查询数据库,虽然有主键加持,但也会影响到数据库性能。这种kv查询方式,我们可以很方便的使用 模型缓存 来减缓数据库压力。本模块实现了自动缓存,删除和修改模型时,自动删除缓存。累加、减操作时,直接操作缓存进行对应累加、减。

模型缓存暂支持 Redis存储,其他存储引擎会慢慢补充。

安装

  1. composer require hyperf/model-cache

配置

模型缓存的配置在 databases 中。示例如下

配置 类型 默认值 备注
handler string Hyperf\DbConnection\Cache\Handler\RedisHandler::class
cache_key string mc:%s:m:%s:%s:%s mc:缓存前缀:m:表名:主键KEY:主键值
prefix string db connection name 缓存前缀
ttl int 3600 超时时间
empty_model_ttl int 60 查询不到数据时的超时时间
load_script bool true Redis引擎下 是否使用evalSha代替eval
  1. <?php
  2. return [
  3. 'default' => [
  4. 'driver' => env('DB_DRIVER', 'mysql'),
  5. 'host' => env('DB_HOST', 'localhost'),
  6. 'database' => env('DB_DATABASE', 'hyperf'),
  7. 'username' => env('DB_USERNAME', 'root'),
  8. 'password' => env('DB_PASSWORD', ''),
  9. 'charset' => env('DB_CHARSET', 'utf8'),
  10. 'collation' => env('DB_COLLATION', 'utf8_unicode_ci'),
  11. 'prefix' => env('DB_PREFIX', ''),
  12. 'pool' => [
  13. 'min_connections' => 1,
  14. 'max_connections' => 10,
  15. 'connect_timeout' => 10.0,
  16. 'wait_timeout' => 3.0,
  17. 'heartbeat' => -1,
  18. 'max_idle_time' => (float)env('DB_MAX_IDLE_TIME', 60),
  19. ],
  20. 'cache' => [
  21. 'handler' => \Hyperf\DbConnection\Cache\Handler\RedisHandler::class,
  22. 'cache_key' => 'mc:%s:m:%s:%s:%s',
  23. 'prefix' => 'default',
  24. 'ttl' => 3600 * 24,
  25. 'empty_model_ttl' => 3600,
  26. 'load_script' => true,
  27. ]
  28. ],
  29. ];

使用

模型缓存的使用十分简单,只需要在对应Model中实现 Hyperf\ModelCache\CacheableInterface 接口,当然,框架已经提供了对应实现,只需要引入 Hyperf\ModelCache\Cacheable Trait 即可。

  1. <?php
  2. declare(strict_types=1);
  3. namespace App\Models;
  4. use Hyperf\DbConnection\Model\Model;
  5. use Hyperf\ModelCache\Cacheable;
  6. use Hyperf\ModelCache\CacheableInterface;
  7. /**
  8. * @property $id
  9. * @property $name
  10. * @property $gender
  11. * @property $created_at
  12. * @property $updated_at
  13. */
  14. class User extends Model implements CacheableInterface
  15. {
  16. use Cacheable;
  17. /**
  18. * The table associated with the model.
  19. *
  20. * @var string
  21. */
  22. protected $table = 'user';
  23. /**
  24. * The attributes that are mass assignable.
  25. *
  26. * @var array
  27. */
  28. protected $fillable = ['id', 'name', 'gender', 'created_at', 'updated_at'];
  29. protected $casts = ['id' => 'integer', 'gender' => 'integer'];
  30. }
  31. // 查询单个缓存
  32. $model = User::findFromCache($id);
  33. // 批量查询缓存,返回 Hyperf\Database\Model\Collection
  34. $models = User::findManyFromCache($ids);

对应Redis数据如下,其中 HF-DATA:DEFAULT 作为占位符存在于 HASH 中,所以用户不要使用 HF-DATA 作为数据库字段

127.0.0.1:6379> hgetall "mc:default:m:user:id:1"
 1) "id"
 2) "1"
 3) "name"
 4) "Hyperf"
 5) "gender"
 6) "1"
 7) "created_at"
 8) "2018-01-01 00:00:00"
 9) "updated_at"
10) "2018-01-01 00:00:00"
11) "HF-DATA"
12) "DEFAULT"

另外一点就是,缓存更新机制,框架内实现了对应的 Hyperf\ModelCache\Listener\DeleteCacheListener 监听器,每当数据修改,会主动删除缓存。如果用户不想由框架来删除缓存,可以主动覆写 deleteCache 方法,然后由自己实现对应监听即可。