FastCache

EasySwoole 提供了一个快速缓存，是基础UnixSock通讯和自定义进程存储数据实现的，提供基本的缓存服务，本缓存为解决小型应用中，需要动不动就部署Redis服务而出现。

安装

  1. composer require easyswoole/fast-cache

服务注册

我们在EasySwoole全局的事件中进行注册

  1. use EasySwoole\FastCache\Cache;
  2. Cache::getInstance()->setTempDir(EASYSWOOLE_TEMP_DIR)->attachToServer(ServerManager::getInstance()->getSwooleServer());

::: warning FastCache只能在服务启动之后使用,需要有创建unix sock权限(建议使用vm,docker或者linux系统开发),虚拟机共享目录文件夹是无法创建unix sock监听的 :::

客户端调用

服务启动后，可以在任意位置调用

  1. use EasySwoole\FastCache\Cache;
  2. Cache::getInstance()->set('get','a');
  3. var_dump(Cache::getInstance()->get('get'));

支持方法列表

  • public function setTempDir(string $tempDir): Cache

    设置临时目录

  • public function setProcessNum(int $num): Cache

    设置缓存进程数

  • public function setServerName(string $serverName): Cache

    设置缓存进程所在服务名

  • public function setOnTick($onTick): Cache

    设置定时回调，可用于数据定时落地

  • public function setTickInterval($tickInterval): Cache

    设置定时回调间隔

  • public function setOnStart($onStart): Cache

    设置进程启动回调，可以用于数据落地恢复

  • public function setOnShutdown(callable $onShutdown): Cache

    设置进程关闭回调，可以用于数据落地

  • public function set($key, $value, ?int $ttl = null, float $timeout = 1.0)

  • public function get($key, float $timeout = 1.0)
  • public function unset($key, float $timeout = 1.0)
  • public function keys($key = null, float $timeout = 1.0): ?array
  • public function flush(float $timeout = 1.0)
  • public function enQueue($key, $value, $timeout = 1.0)
  • public function deQueue($key, $timeout = 1.0)
  • public function queueSize($key, $timeout = 1.0)
  • public function unsetQueue($key, $timeout = 1.0)
  • public function queueList($timeout = 1.0): ?array
  • public function flushQueue(float $timeout = 1.0): bool
  • public function expire($key, int $ttl, $timeout = 1.0)

  • public function persist($key, $timeout = 1.0)

    移除一个key的过期时间

  • public function ttl($key, $timeout = 1.0)

  • function hSet($key, $field, $value, float $timeout = 1.0)

  • function hGet($key, $field = null, float $timeout = 1.0)

  • function hDel($key, $field = null, float $timeout = 1.0)

  • function hFlush(float $timeout = 1.0)

  • function hKeys($key, float $timeout = 1.0)

  • function hScan($key, $cursor = 0, $limit = 10, float $timeout = 1.0)

  • function hSetnx($key, $field, $value, float $timeout = 1.0)

  • function hExists($key, $field, float $timeout = 1.0)

  • function hLen($key, float $timeout = 1.0)

  • function hIncrby($key, $field, $value, float $timeout = 1.0)

  • function hMset($key, $fieldValues, float $timeout = 1.0)

  • function hMget($key, $fields, float $timeout = 1.0)

  • function hVals($key, float $timeout = 1.0)

  • function hGetAll($key, float $timeout = 1.0)

落地重启恢复数据方案

FastCache提供了3个方法,用于数据落地以及重启恢复,在EasySwooleEvent.php中的mainServerCreate回调事件中设置以下方法:

::: warning 设置回调要在注册cache服务之前，注册服务之后不能更改回调事件。 :::

  1. <?php
  3. use EasySwoole\FastCache\Cache;
  4. use EasySwoole\FastCache\CacheProcessConfig;
  5. use EasySwoole\FastCache\SyncData;
  6. use EasySwoole\Utility\File;
  8. // 每隔5秒将数据存回文件
  9. Cache::getInstance()->setTickInterval(5 * 1000);//设置定时频率
  10. Cache::getInstance()->setOnTick(function (SyncData $SyncData, CacheProcessConfig $cacheProcessConfig) {
  11.     $data = [
  12.         'data'  => $SyncData->getArray(),
  13.         'queue' => $SyncData->getQueueArray(),
  14.         'ttl'   => $SyncData->getTtlKeys(),
  15.      // queue支持
  16.         'jobIds'     => $SyncData->getJobIds(),
  17.         'readyJob'   => $SyncData->getReadyJob(),
  18.         'reserveJob' => $SyncData->getReserveJob(),
  19.         'delayJob'   => $SyncData->getDelayJob(),
  20.         'buryJob'    => $SyncData->getBuryJob(),
  21.     ];
  22.     $path = EASYSWOOLE_TEMP_DIR . '/FastCacheData/' . $cacheProcessConfig->getProcessName();
  23.     File::createFile($path,serialize($data));
  24. });
  26. // 启动时将存回的文件重新写入
  27. Cache::getInstance()->setOnStart(function (CacheProcessConfig $cacheProcessConfig) {
  28.     $path = EASYSWOOLE_TEMP_DIR . '/FastCacheData/' . $cacheProcessConfig->getProcessName();
  29.     if(is_file($path)){
  30.         $data = unserialize(file_get_contents($path));
  31.         $syncData = new SyncData();
  32.         $syncData->setArray($data['data']);
  33.         $syncData->setQueueArray($data['queue']);
  34.         $syncData->setTtlKeys(($data['ttl']));
  35.         // queue支持
  36.         $syncData->setJobIds($data['jobIds']);
  37.         $syncData->setReadyJob($data['readyJob']);
  38.         $syncData->setReserveJob($data['reserveJob']);
  39.         $syncData->setDelayJob($data['delayJob']);
  40.         $syncData->setBuryJob($data['buryJob']);
  41.         return $syncData;
  42.     }
  43. });
  45. // 在守护进程时,php easyswoole stop 时会调用,落地数据
  46. Cache::getInstance()->setOnShutdown(function (SyncData $SyncData, CacheProcessConfig $cacheProcessConfig) {
  47.     $data = [
  48.         'data'  => $SyncData->getArray(),
  49.         'queue' => $SyncData->getQueueArray(),
  50.         'ttl'   => $SyncData->getTtlKeys(),
  51.          // queue支持
  52.         'jobIds'     => $SyncData->getJobIds(),
  53.         'readyJob'   => $SyncData->getReadyJob(),
  54.         'reserveJob' => $SyncData->getReserveJob(),
  55.         'delayJob'   => $SyncData->getDelayJob(),
  56.         'buryJob'    => $SyncData->getBuryJob(),
  57.     ];
  58.     $path = EASYSWOOLE_TEMP_DIR . '/FastCacheData/' . $cacheProcessConfig->getProcessName();
  59.     File::createFile($path,serialize($data));
  60. });
  62. Cache::getInstance()->setTempDir(EASYSWOOLE_TEMP_DIR)->attachToServer(ServerManager::getInstance()->getSwooleServer());

消息队列支持