RedisHash.php
13.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
<?php
namespace redis;
use think\Config;
use think\Db;
use think\Exception;
/**
* redis hash
* Class RedisHash
* 例子:
* key 不允许使用逗号
* 写入
* $data = ['a'=>'1', 'b'=>'c']
* RedisHash::instance()->setHashKey("api")->set($data);
* RedisHash::instance()->setTable("api")->setKey("urls")->set($data);
* 修改
* RedisHash::instance()->setTable("api")->setKey("urls")->set('a', 'abc');
* 读取
* RedisHash::instance()->setHashKey("api:urls")->get();
* RedisHash::instance()->setTable("api")->setKey("urls")->get();
* 读取
* RedisHash::instance()->setHashKey("api:urls")->get(['a','b']);
* RedisHash::instance()->setTable("api")->setKey("urls")->get(['a','b']);
* 读取
* RedisHash::instance()->setHashKey("api:urls")->get('a,b');
* RedisHash::instance()->setTable("api")->setKey("urls")->get('a,b');
* 读取(如果不存在返回 false)
* RedisHash::instance()->setHashKey("api:urls")->get('a');
* RedisHash::instance()->setTable("api")->setKey("urls")->get('a');
* 设置超时(秒或时间戳)
* RedisHash::instance()->setTable("api")->setKey("urls")->setExpire(5);
* 读取
* RedisHash::instance()->getByHashKey('api:urls');
* 读取
* RedisHash::instance()->getByHashKey('api:urls', 'a, b');
* 读取
* RedisHash::instance()->getByHashKey('api:urls', ['a','b']);
* 判断 key 是否存在,存在 true 不在 false
* RedisHash::instance()->exists('api:urls');
* 查找所有符合给定模式 pattern 的 key
* RedisHash::instance()->keys('api:*')
* 删除
* RedisHash::instance()->setHashKey('api:urls')->delete('api/index/index_submit/3');
* 删除
* RedisHash::instance()->deleteByKey('api:urls');
* 删除
* RedisHash::instance()->clear('api:*');
* 删除
* RedisHash::instance()->clearAll();
* @package redis
*/
class RedisHash
{
/**
* @var array 缓存的实例
*/
public static $instance = null;
protected $hashKey;
protected $handler = null;
protected $table;
protected $options = [
'host' => '127.0.0.1',
'port' => 6379,
'password' => '',
'select' => 7,
'timeout' => 0,
'expire' => 0,
'persistent' => false,
'prefix' => 'hr:'
];
/**
* 私有化构造方法
* Auth constructor.
* @throws \think\exception\DbException
*/
private function __construct($type)
{
if (!extension_loaded('redis')) {
throw new \BadFunctionCallException('not support: redis');
}
$options = [];
if ('complex' == Config::get('cache.type')) {
$options = Config::get('cache.' . $type);
$options = array_merge($this->options, $options);
}
$this->handler = new \Redis;
// 地址端口
$this->handler->connect($options['host'], $options['port']);
$this->handler->auth($options['password']);
$this->handler->select($options['select']);
}
/**
* 私有化克隆方法
*/
private function __clone()
{
}
/**
* @return RedisHash
*/
public static function instance($type = 'redis')
{
if (is_null(self::$instance)) {
self::$instance = new RedisHash($type);
}
return self::$instance;
}
/**
* 设置key值(table名称)
* @param $table
* @return $this
*/
public function setTable($table)
{
$this->handler->table = $table;
$this->handler->hashKey = null;
return $this;
}
/**
* 设置key值(PK值)
* @param $key
* @return $this
*/
public function setKey($key)
{
$this->handler->key = $key;
$this->handler->hashKey = null;
return $this;
}
/**
* 设置过期时间或指定过期的时间戳
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
* @param int $time 秒或时间戳
* @return bool
*/
public function setExpire($time = 0)
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
switch (true) {
case ($time == 0):
return $this->handler->expire($hash_key, 0);
case ($time > time()):
$this->handler->expireAt($hash_key, $time);
default:
return $this->handler->expire($hash_key, $time);
}
}
/**
* 通过 Hash 获取
* 示例:RedisHash::instance()->getByHashKey('hr:app:list_access_token', ['abc1','abc2'])
* @param $key
* 1、必须完整名称(可以带 "hr:" 也可不带 "hr:")
* 2、为空返回 false
* @param array $field
* 3、$field 可以是hash表的key数组,例如:['abc1','abc2']
* @return bool 错误返回 false
*/
public function getByHashKey($key, $field = [])
{
switch (true)
{
case (empty($key)):
return false;
case (is_string($key) && empty($field)):
$key = $this->getIntactByHashKey($key);
return $this->handler->hGetAll($key);
case (is_string($key) && !empty($field)):
$key = $this->getIntactByHashKey($key);
$field = is_string($field) ? explode(",", $field) : $field;
return $this->handler->hMget($key, $field);
default:
return false;
}
}
/**
* 检查给定 key 是否存在
* @param $key
* 1、必须完整名称(可以带 "hr:" 也可不带 "hr:")
* @return bool
*/
public function exists($key)
{
$key = $this->getIntactByHashKey($key);
switch (true) {
case (empty($key)):
return false;
case (is_string($key)):
return $this->handler->exists($key);
default:
return false;
}
}
/**
* 通用设置字段值
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param $field
* 3、如果是数组,则直接设置
* 4、如果是对象,则转换为数组
* 5、如果为字符串,则判断为修改
* @param string $value
* @return bool
*/
public function set($field, $value = "")
{
switch(true) {
case (is_array($field) && empty($value)):
return $this->setAll($field);
case (is_object($field) && empty($value)):
return $this->setAll($field->toArray());
case (is_string($field) && is_string($value)):
return $this->setField($field, $value);
default:
}
}
/**
* 设置指定字段值
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param $field
* @param $value
* @return bool
*/
protected function setField($field, $value)
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
if (is_string($field) || is_string($value)) {
return $this->handler->hSet($hash_key, $field, $value);
}
return false;
}
/**
* 批量设置字段
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param $data 数组
* @return bool
*/
protected function setAll($data)
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
if (is_array($data)) {
return $this->handler->hMset($hash_key, $data);
} else {
return false;
}
}
/**
* 获取字段值
*
* 1、如果为空则获取全部数据
* 2、支持单字段
* 3、逗号分割字符串
* 4、支持数组
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param array $field
* @return bool
*/
public function get($field = [])
{
switch(true) {
//判断为空
case empty($field):
return $this->getAll();
case is_string($field):
$field_list = explode(',', $field);
if (count($field_list) == 1) {
return $this->getByField($field_list[0]);
} else {
return $this->getByArray($field_list);
}
case is_numeric($field):
return $this->getByField($field);
case is_array($field):
return $this->getByArray($field);
case is_object($field):
return false;
default:
return $this->getByField($field);
}
}
/**
* 通过数组获取指定字段值
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param array $field_list
* @return bool
*/
protected function getByArray($field_list = [])
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
if (empty($field_list)) {
return false;
}
return $this->handler->hMget($hash_key, $field_list);
}
/**
* 获取指定字段值
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @param $field
* @return bool
*/
protected function getByField($field)
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
if (empty($field)) {
return false;
}
return $this->handler->hGet($hash_key, $field);
}
/**
* 获取全部字段值
*
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
*
* @return bool
*/
protected function getAll()
{
$hash_key = $this->getHashKey();
if (!$hash_key) {
return false;
}
return $this->handler->hGetAll($hash_key);
}
/**
* 直接设置HashKey值
* 1、直接设置 HashKey
* 2、可以带 "hr:" 也可不带 "hr:"
* @param $hash_key
* @return $this
*/
public function setHashKey($hash_key)
{
$this->handler->hashKey = $this->getIntactByHashKey($hash_key);
$this->handler->table = null;
$this->handler->key = null;
return $this;
}
/**
* 查找所有符合给定模式 pattern 的 key
*
* 一、使用 setTable
* 1、$pattern 必须为空
* 2、返回:setTable 和 ":*" 的组合(系统自动加入前缀)的查询结果
* 二、不使用 setTable
* 1、可以带 "hr:" 也可不带 "hr:"
* 2、可以使用 *
* 3、返回指定查询结果
* 三、不适用 setTable,$pattern 为空
* 1、返回全部 HashKey
*
* @param $pattern
* @return bool|string
*/
public function keys($pattern = "")
{
if (!empty($pattern)) {
$pattern = $this->getIntactByHashKey($pattern);
return $this->handler->keys($pattern);
}
elseif (empty($pattern) && isset($this->handler->table)) {
$key = $this->getIntactByHashKey($this->handler->table);
return $this->handler->keys($key . ":*");
}
else {
return $this->handler->keys("*");
}
return false;
}
/**
* 删除
*
* @param $pattern
* @return bool|string
*/
public function delete($hashKey1, $hashKey2 = null, $hashKeyN = null)
{
$key = $this->getHashKey();
return $this->handler->hDel($key, $hashKey1, $hashKey2, $hashKeyN);
}
/**
* 删除
* 1、必须完整名称(可以带 "hr:" 也可不带 "hr:")
* 2、也可以使用 setTable 和 setKey
* @param $pattern
* @return bool|string
*/
public function deleteByKey($key1 = null, $key2 = null, $key3 = null)
{
$key1 = empty($key1) ? $this->getHashKey() : $this->getIntactByHashKey($key1);
return $this->handler->delete($key1, $key2 , $key3);
}
/**
* 清除
*
* 一、使用 setTable
* 1、$pattern 必须为空
* 2、删除:setTable 和 ":*" 的组合(系统自动加入前缀)的查询结果
* 二、不使用 setTable
* 1、可以带 "hr:" 也可不带 "hr:"
* 2、可以使用 *
*/
public function clear($pattern = "")
{
if (!empty($pattern)) {
return $this->handler->delete($this->keys($pattern));
}
if (empty($pattern) && isset($this->handler->table)) {
return $this->handler->delete($this->keys($this->handler->table . ":*"));
}
return false;
}
/**
* 清除全部数据
*/
public function clearAll()
{
return $this->handler->flushDB();
}
/**
* 返回完整名称
* 查询字符串中是否包含前缀,如果没有则添加前缀
*/
protected function getIntactByHashKey($key)
{
if(substr($key, 0, strlen($this->options['prefix'])) != $this->options['prefix']) {
$key = $this->options['prefix'] . $key;
}
return $key;
}
/**
* 获取 HashKey 值
* 前置条件:
* 1、必须调用 setTable
* 2、必须调用 setKey
* @return bool|string
*/
protected function getHashKey()
{
try {
if (isset($this->handler->hashKey)){
return $this->handler->hashKey;
}
if (!isset($this->handler->table) || !isset($this->handler->key)) {
throw new Exception("数据表或者PK键未建立");
}
$this->handler->hashKey = $this->handler->table . ":" . $this->handler->key;
return $this->options['prefix'] . $this->handler->table . ":" . $this->handler->key;
} catch (Exception $e) {
return false;
}
}
/**
* 查看现在数据库有多少 key
*/
public function getDbLength()
{
return $this->handler->dbSize();
}
public function getDbInfo()
{
return $this->handler->info();
}
}