Cache

在webman默认使用 symfony/cache作为cache组件。

注意
Cache 组件在2024-09-15进行了升级，此文档需要 workerman/webman-framework版本 >= 1.5.24
通过composer info命令查看workerman/webman-framework版本，通过命令 composer require workerman/webman-framework ^1.5.24 升级。

安装

php 7.x

composer require -W symfony/cache ^5.2 psr/simple-cache

php 8.x

composer require -W symfony/cache psr/simple-cache

示例

<?php
namespace app\controller;

use support\Request;
use support\Cache;

class UserController
{
    public function db(Request $request)
    {
        $key = 'test_key';
        Cache::set($key, rand());
        return response(Cache::get($key));
    }
}

配置文件位置

配置文件在 config/cache.php。如果你的webman没有这个文件说明框架不是最新的，请手动创建config/cache.php，并在项目根目录执行 composer require workerman/webman-framework ^1.5.24 升级 workerman/webman-framework。

配置文件内容

<?php
return [
    'default' => 'file',
    'stores' => [
        'file' => [
            'driver' => 'file',
            'path' => runtime_path('cache')
        ],
        'redis' => [
            'driver' => 'redis',
            'connection' => 'default'
        ],
        'array' => [
            'driver' => 'array'
        ]
    ]
];

stores.driver支持3种驱动，file、redis、array。

file 文件驱动

此为默认驱动，可通过'default' => 'xxx'字段更改。

redis 驱动

Redis存储，如需使用请先安装Redis组件，命令如下

• php 7.x

  composer require -W illuminate/redis ^8.2.0

• php 8.x

  composer require -W illuminate/redis

  提示
  要想使用illuminate/redis请确保php-cli安装了Redis扩展，执行php -m 查看php-cli支持的扩展。

stores.redis.connection

stores.redis.connection 对应的是config/redis.php 里对应的key。建议在config/redis.php创建一个独立的key，例如cache类似如下

<?php
return [
    'default' => [
        'password' => 'abc123',
        'host' => '127.0.0.1',
        'port' => 6379,
        'database' => 0,
    ],
    'cache' => [ // <===
        'password' => 'abc123',
        'host' => '127.0.0.1',
        'port' => 6379,
        'database' => 1,
        'prefix' => 'webman_cache-',
    ]
];

然后将stores.redis.connection设置为cache，config/cache.php最终配置类似如下

<?php
return [
    'default' => 'redis', // <=== 
    'stores' => [
        'file' => [
            'driver' => 'file',
            'path' => runtime_path('cache')
        ],
        'redis' => [
            'driver' => 'redis',
            'connection' => 'cache' // <====
        ],
        'array' => [
            'driver' => 'array'
        ]
    ]
];

array 内存驱动

内存存储，性能最好，但是会占用内存，一般用于缓存数据量小的项目。

切换存储

可以通过如下代码手动切store，从而使用不同的存储驱动，例如

Cache::store('redis')->set('key', 'value');
Cache::store('array')->set('key', 'value');

提示
symfony/cache 的key不允许包含字符"{}()/\@:"

使用其它Cache组件

ThinkCache组件使用参考 其它数据库