🍛ThinkPHP8中使用redis缓存

实现了使用redis缓存自增版本、指定缓存版本号

1. 在.env中添加以下配置#

1
# Redis
2
REDIS_HOST = 127.0.0.1
3
REDIS_PORT = 6379
4
REDIS_PASS = password
5
REDIS_CACHE_SELECT = 2

2. 修改缓存配置文件#

config/cache.php

1
<?php
2

3
// +----------------------------------------------------------------------
4
// | 缓存设置
5
// +----------------------------------------------------------------------
6

7
return [
8
    // 默认缓存驱动
9
    'default' => 'redis',
10

11
    // 缓存连接方式配置
12
    'stores'  => [
13
        'file' => [
14
            // 驱动方式
15
            'type'       => 'File',
16
            // 缓存保存目录
17
            'path'       => '',
18
            // 缓存前缀
19
            'prefix'     => '',
20
            // 缓存有效期 0表示永久缓存
21
            'expire'     => 0,
22
            // 缓存标签前缀
23
            'tag_prefix' => 'tag:',
24
            // 序列化机制 例如 ['serialize', 'unserialize']
25
            'serialize'  => [],
26
        ],
27
        // 更多的缓存连接
28
        'redis' => [
29
            'type' => 'redis',
30
            // Redis 主机
31
            'host' => env('REDIS_HOST', '127.0.0.1'),
32
            // Redis 端口
33
            'port' => env('REDIS_PORT', 6379),
34
            // Redis 密码
35
            'password' => env('REDIS_PASS', ''),
36
            // 库
37
            'select' => env('REDIS_CACHE_SELECT', 2),
38
            // 缓存前缀
39
            'prefix' => '',
40
            // 缓存有效期 0表示永久缓存
41
            'expire' => 0,
42
//            // 缓存标签前缀
43
//            'tag_prefix' => 'tag:',
44
//            // 是否使用连接池
45
//            'use_pool' => true,
46
//            // 连接池的连接标识
47
//            'pool' => 'default',
48
        ],
49
    ],
50
];

3.缓存相关常量配置#

1
<?php
2
declare (strict_types=1);
3

4
namespace app\common\enum;
5

6
class CacheEnum
7
{
8
    // 版本号前缀
9
    const CACHE_VERSION_PREFIX = 'cache_version_v1001';
10
    // 版本号初始值
11
    const DEFAULT_VERSION = 1001;
12
    // 缓存键前缀
13
    const CACHE_PREFIX = 'data_cache';
14

15
    /** 各种业务场景的缓存键 */
16
    // 生成链接缓存键
17
    const PRODUCT_DETAIL_GET_LINK_CACHE_KEY = 'product_detail_get_link';
18
    // 类目列表缓存键
19
    const PRODUCT_CATEGORY_LIST_CACHE_KEY = 'product_category_list';
20

21
    // 防止队列重复消费键
22
    const CHECK_QUEUE_REPEAT_CONSUMING_KEY = 'check_queue_repeat_consuming';
23
}

4.创建缓存帮助类#

提供了两种方法设置缓存 setCacheData与remember方法使用前都需先调用setCacheConfig方法

1
<?php
2
declare(strict_types=1);
3

4
namespace core\Library;
5

6
use app\common\enum\CacheEnum;
7
use think\facade\Cache;
8

9
/**
10
 * 缓存类
11
 * 注意事项 需先调用setCacheConfig方法
12
 * Class CacheHelper
13
 * @package core\Library
14
 */
15
class CacheHelper
16
{
17
    // 初始版本号
18
    protected int $version = CacheEnum::DEFAULT_VERSION;
19

20
    // 是否自定义缓存键
21
    protected bool $is_set_version = false;
22

23
    // 缓存时间
24
    protected int|null $ttl = null;
25

26
    // 缓存键
27
    protected string $cache_key = 'default';
28

29
    // 未拼接前的缓存键
30
    protected string $cache_key_ori = 'default';
31

32

33
    // 版本号键
34
    protected string $version_key = 'default';
35

36
    /**
37
     * 使用闭包缓存
38
     * @param \Closure $callback
39
     * @return mixed
40
     */
41
    public function remember(\Closure $callback): mixed
42
    {
43
        // 获取缓存数据
44
        $cache_data = $this->getCacheData();
45
        if ($cache_data !== null) {
46
            return $cache_data;
47
        }
48

49
        // 缓存不存在，调用闭包生成数据
50
        $data = $callback();
51
        // 设置缓存与版本号
52
        $this->setCacheData($data);
53

54
        return $data;
55
    }
56

57

58
    /**
59
     * 设置缓存数据
60
     * @param mixed $data
61
     * @return bool
62
     */
63
    public function setCacheData(mixed $data): bool
64
    {
65
        $data_res = Cache::set($this->getCacheKey(), $data, $this->getTtl());
66
        $version_res = Cache::set($this->getVersionKey(), $this->getVersion());
67
        if ($data_res && $version_res) {
68
            return true;
69
        }
70
        return false;
71
    }
72

73
    /**
74
     * 获取缓存数据
75
     * @return mixed
76
     */
77
    public function getCacheData(): mixed
78
    {
79
        if (Cache::has($this->getCacheKey())) {
80
            return Cache::get($this->getCacheKey());
81
        }
82
        return null;
83
    }
84

85

86
    /**
87
     * 获取当前缓存版本号
88
     * @return int
89
     */
90
    public function getVersion(): int
91
    {
92
        if (!$this->is_set_version && Cache::has($this->version_key)) {
93
            // 未手动设置过缓存 缓存存在，直接返回
94
            $this->version = intval(Cache::get($this->version_key));
95
        }
96
        return $this->version;
97
    }
98

99

100
    /**
101
     * 设置缓存配置
102
     * @param string $cache_key 缓存键名
103
     * @param int|null $ttl 缓存有效期 null为永久有效
104
     * @param bool $inc_version 是否递增版本号
105
     * @param int $version 是否自定义版本号 不建议与递增版本号同时使用 若同时使用 则会在自定义版本号基础上加1
106
     * @return $this
107
     */
108
    public function setCacheConfig(string $cache_key, int|null $ttl = null, bool $inc_version = false, int $version = 0): self
109
    {
110
        $this->cache_key_ori = $cache_key;
111
        $this->setVersionKey();
112

113
        // 若指定版本号则设置
114
        !empty($version) && $this->setVersion($version);
115

116
        // 获取当前版本号 +1
117
        $version = $this->getVersion();
118
        $inc_version && $this->setVersion($version + 1);
119

120
        // 设置缓存时间
121
        !is_null($ttl) && $this->ttl = $ttl;
122

123
        $this->cache_key = $this->generateCacheKey($this->getVersion());
124
        return $this;
125
    }
126

127
    /**
128
     * 生成缓存键名
129
     * @param int $version
130
     * @return string
131
     */
132
    protected function generateCacheKey(int $version): string
133
    {
134
        return CacheEnum::CACHE_PREFIX . ':' . $this->getEnv() . ':' . $this->cache_key_ori . ':' . $version;
135
    }
136

137
    public function getEnv(): string
138
    {
139
        return app('env')->get('app_env') ?? 'dev';
140
    }
141

142
    /**
143
     * 获取有效期
144
     * @return int|null
145
     */
146
    public function getTtl(): int|null
147
    {
148
        return $this->ttl;
149
    }
150

151
    /**
152
     * 获取缓存键名
153
     * @return string
154
     */
155
    public function getCacheKey(): string
156
    {
157
        return $this->cache_key;
158
    }
159

160
    /**
161
     * 删除缓存
162
     * @param array $version_list 版本号列表
163
     * @return bool
164
     */
165
    public function delete(array $version_list): bool
166
    {
167
        if (!$version_list) {
168
            return true;
169
        }
170
        foreach ($version_list as $version) {
171
            $cache_key = $this->generateCacheKey($version);
172
            Cache::delete($cache_key);
173
        }
174
        return true;
175
    }
176

177
    /**
178
     * 获取历史版本缓存 不包含当前版本
179
     * @return array
180
     */
181
    public function getHistoryVersion(): array
182
    {
183
        $version_list = [];
184
        for ($i = CacheEnum::DEFAULT_VERSION; $i < $this->getVersion(); $i++) {
185
            $cache_key = $this->generateCacheKey($i);
186
            if (Cache::has($cache_key)) {
187
                $version_list[] = $i;
188
            }
189
        }
190
        return $version_list;
191
    }
192

193
    /**
194
     * 手动设置缓存版本号
195
     * @param int $version
196
     * @return $this
197
     */
198
    protected function setVersion(int $version): self
199
    {
200
        $this->version = $version;
201
        $this->is_set_version = true;
202
        return $this;
203
    }
204

205

206
    /**
207
     * 获取版本号键名
208
     * @return string
209
     */
210
    protected function getVersionKey(): string
211
    {
212
        return $this->version_key;
213
    }
214

215

216
    /**
217
     * 设置缓存版本键名
218
     * @return $this
219
     */
220
    protected function setVersionKey(): self
221
    {
222
        $this->version_key = CacheEnum::CACHE_VERSION_PREFIX . ':' . $this->getEnv() . ':' . $this->cache_key_ori;
223
        return $this;
224
    }
225
}

5. 使用方法#

首先注入帮助类

1
#[Inject]
2
protected CacheHelper $cacheHelper;

使用闭包方式设置缓存若缓存不存在执行闭包返回结果（适合返回结果处理比较简单的情况这样简洁一些）

1
$level = 1;
2
$cache_key = CacheEnum::PRODUCT_CATEGORY_LIST_CACHE_KEY . "_{$level}";
3
return $this->cacheHelper->setCacheConfig($cache_key, 3600 * 24 * 4)->remember(function () use ($params) {
4
    return $this->getListByLevel($params);
5
});

手动判断缓存是否为空处理业务（适合逻辑比较复杂的情况）

1
$cache_key = CacheEnum::PRODUCT_DETAIL_GET_LINK_CACHE_KEY . "_{$type}";
2
$cache = $this->cacheHelper->setCacheConfig($cache_key, 3600 * 24);
3

4
if (!empty($cache_data = $cache->getCacheData())) {
5
    return $cache_data;
6
}
7

8
// todo 处理业务 获取结果
9
$return_data = ['aaa'];
10

11
// 设置缓存
12
!empty($return_data) && $cache->setCacheData($return_data);
13

14
// 返回结果
15
return $return_data;

6. 扩展用法#

自增缓存版本号

1
$cache = $this->cacheHelper->setCacheConfig($cache_key, 3600 * 24, true);

指定版本号缓存（如果指定版本号缓存第三个参数传false，如果传true 以下示例的版本号会变成1010）

1
$cache = $this->cacheHelper->setCacheConfig($cache_key, 3600 * 24, false, 1009);

获取当前版本之前的历史版本号（初始版本号为1001 以下示例为获取 1001～1008版本的缓存）

1
$cache = $this->cacheHelper->setCacheConfig($cache_key, 3600 * 24, false, 1009);
2
$history_version_list = $cache->getHistoryVersion();

删除指定版本号列表的缓存

1
$this->cacheHelper->setCacheConfig($cache_key)->delete([1001,1002]);