模型缓存

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

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

安装

  1. composer require hyperf/model-cache

配置

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

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

使用

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

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

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

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

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