redis在PHP中的基本使用案例

  1 //利用Redis类进行操作
  2 
  3 //实例化Redis类
  4 $redis = new Redis();
  5 //选择指定的redis数据库连接，默认端口号为6379
  6 $redis->connect('127.0.0.1', 6379);
  7 
  8 //普通set/get操作
  9 $redis->set(‘library’, ‘predis’);
 10 $retval = $redis->get(‘library’);
 11 echo $retval; //显示 ‘predis’
 12 
 13 //setex set一个存储时效
 14 $redis->setex(‘str’, 10, ‘bar’); //表示存储有效期为10秒
 15 
 16 //setnx/msetnx相当于add操作,不会覆盖已有值
 17 $redis->setnx(‘foo’,12); //true
 18 $redis->setnx(‘foo’,34); //false
 19 
 20 //getset操作,set的变种,结果返回替换前的值
 21 $redis->getset(‘foo’,56);//返回34
 22 
 23 // incrby/incr/decrby/decr 对值的递增和递减
 24 $redis->incr(‘foo’); //foo为57
 25 $redis->incrby(‘foo’,2); //foo为59
 26 
 27 //exists检测是否存在某值
 28 $redis->exists(‘foo’);//true
 29 
 30 //del 删除
 31 $redis->del(‘foo’);//true
 32 
 33 //type 类型检测,字符串返回string,列表返回 list,set表返回set/zset,hash表返回hash
 34 $redis->type(‘foo’);//不存在,返回none
 35 $redis->set(‘str’,'test’);
 36 $redis->type(‘str’); //字符串，返回string
 37 
 38 //append 连接到已存在字符串
 39 $redis->append(‘str’,'_123′); //返回累加后的字符串长度8,此进str为 ‘test_123′
 40 
 41 //setrange 部分替换操作
 42 $redis->setrange(‘str’,0,’abc’); //返回3,参数2为0时等同于set操作
 43 $redis->setrange(‘str’,2,’cd’);//返回4,表示从第2个字符后替换,这时’str’为’abcd’
 44 
 45 //substr 部分获取操作
 46 $redis->substr(‘str’,0,2);//表示从第0个起，取到第2个字符，共3个，返回’abc’
 47 
 48 //strlen 获取字符串长度
 49 $redis->strlen(‘str’); //返回4
 50 
 51 //setbit/getbit 位存储和获取
 52 $redis->setbit(‘binary’,31,1);  //表示在第31位存入1,这边可能会有大小端问题?不过没关系,getbit 应该不会有问题
 53 $redis->getbit(‘binary’,31);    //返回1
 54 
 55 //keys 模糊查找功能,支持*号以及?号(匹配一个字符)
 56 $redis->set(‘foo1′,123);
 57 $redis->set(‘foo2′,456);
 58 $redis->keys(‘foo*’); //返回foo1和foo2的array
 59 $redis->keys(‘f?o?’);  //同上
 60 
 61 //randomkey 随机返回一个key
 62 $redis->randomkey(); //可能是返回 ‘foo1′或者是’foo2′及其它任何一存在redis的key
 63 
 64 //rename/renamenx 对key进行改名,所不同的是renamenx不允许改成已存在的key
 65 $redis->rename(‘str’,'str2′); //把原先命名为’str’的key改成了’str2′
 66 
 67 //expire 设置key-value的时效性,ttl 获取剩余有效期,persist 重新设置为永久存储
 68 $redis->expire(‘foo’, 1); //设置有效期为1秒
 69 $redis->ttl(‘foo’); //返回有效期值1s
 70 $redis->expire(‘foo’); //取消expire行为
 71 
 72 //dbsize 返回redis当前数据库的记录总数
 73 $redis->dbsize();
 74 
 75 /*
 76 队列操作
 77 */
 78 
 79 //rpush/rpushx 有序列表操作,从队列后插入元素
 80 //lpush/lpushx 和rpush/rpushx的区别是插入到队列的头部,同上,’x'含义是只对已存在的key进行操作
 81 $redis->rpush(‘fooList’, ‘bar1′); //返回一个列表的长度1
 82 $redis->lpush(‘fooList’, ‘bar0′); //返回一个列表的长度2
 83 $redis->rpushx(‘fooList’, ‘bar2′); //返回3,rpushx只对已存在的队列做添加,否则返回0
 84 //llen返回当前列表长度
 85 $redis->llen(‘fooList’);//3
 86 
 87 //lrange 返回队列中一个区间的元素
 88 $redis->lrange(‘fooList’,0,1); //返回数组包含第0个至第1个共2个元素
 89 $redis->lrange(‘fooList’,0,-1);//返回第0个至倒数第一个,相当于返回所有元素,注意redis中很多时候会用到负数,下同
 90 
 91 //lindex 返回指定顺序位置的list元素
 92 $redis->lindex(‘fooList’,1); //返回’bar1′
 93 
 94 //lset 修改队列中指定位置的value
 95 $redis->lset(‘fooList’,1,’123′);//修改位置1的元素,返回true
 96 
 97 //lrem 删除队列中左起指定数量的字符
 98 $redis->lrem(‘fooList’,1,’_'); //删除队列中左起(右起使用-1)1个字符’_'(若有)
 99 
100 //lpop/rpop 类似栈结构地弹出(并删除)最左或最右的一个元素
101 $redis->lpop(‘fooList’); //’bar0′
102 $redis->rpop(‘fooList’); //’bar2′
103 
104 //ltrim 队列修改，保留左边起若干元素，其余删除
105 $redis->ltrim(‘fooList’, 0,1); //保留左边起第0个至第1个元素
106 
107 //rpoplpush 从一个队列中pop出元素并push到另一个队列
108 $redis->rpush(‘list1′,’ab0′);
109 $redis->rpush(‘list1′,’ab1′);
110 $redis->rpush(‘list2′,’ab2′);
111 $redis->rpush(‘list2′,’ab3′);
112 $redis->rpoplpush(‘list1′,’list2′);//结果list1 =>array(‘ab0′),list2 =>array(‘ab1′,’ab2′,’ab3′)
113 $redis->rpoplpush(‘list2′,’list2′);//也适用于同一个队列,把最后一个元素移到头部list2 =>array(‘ab3′,’ab1′,’ab2′)
114 
115 //linsert 在队列的中间指定元素前或后插入元素
116 $redis->linsert(‘list2′, ‘before’,'ab1′,’123′); //表示在元素’ab1′之前插入’123′
117 $redis->linsert(‘list2′, ‘after’,'ab1′,’456′);   //表示在元素’ab1′之后插入’456′
118 
119 //blpop/brpop 阻塞并等待一个列队不为空时，再pop出最左或最右的一个元素（这个功能在php以外可以说非常好用）
120 //brpoplpush 同样是阻塞并等待操作，结果同rpoplpush一样
121 $redis->blpop(‘list3′,10); //如果list3为空则一直等待,直到不为空时将第一元素弹出,10秒后超时
122 
123 /**
124 set表操作
125 */
126 
127 //sadd 增加元素,返回true,重复返回false
128 $redis->sadd(‘set1′,’ab’);
129 $redis->sadd(‘set1′,’cd’);
130 $redis->sadd(‘set1′,’ef’);
131 
132 //srem 移除指定元素
133 $redis->srem(‘set1′,’cd’); //删除’cd’元素
134 
135 //spop 弹出首元素
136 $redis->spop(‘set1′);
137 
138 //smove 移动当前set表的指定元素到另一个set表
139 $redis->sadd(‘set2′,’123′);
140 $redis->smove(‘set1′,’set2′,’ab’);//移动’set1′中的’ab’到’set2′,返回true or false
141 
142 //scard 返回当前set表元素个数
143 $redis->scard(‘set2′);//2
144 
145 //sismember 判断元素是否属于当前表
146 $redis->sismember(‘set2′,’123′); //true or false
147 
148 //smembers 返回当前表的所有元素
149 $redis->smembers(‘set2′); //array(’123′,’ab’);
150 
151 //sinter/sunion/sdiff  返回两个表中元素的交集/并集/补集
152 $redis->sadd(‘set1′,’ab’);
153 $redis->sinter(‘set2′,’set1′); //返回array(‘ab’)
154 
155 //sinterstore/sunionstore/sdiffstore 将两个表交集/并集/补集元素copy到第三个表中
156 $redis->set(‘foo’,0);
157 $redis->sinterstore(‘foo’,'set1′); //这边等同于将’set1′的内容copy到’foo’中，并将’foo’转为set表
158 $redis->sinterstore(‘foo’,array(‘set1′,’set2′)); //将’set1′和’set2′中相同的元素copy到’foo’表中,覆盖’foo’原有内容
159 
160 //srandmember 返回表中一个随机元素
161 $redis->srandmember(‘set1′);
162 
163 /**
164 有序set表操作
165 */
166 
167 //sadd 增加元素,并设置序号,返回true,重复返回false
168 $redis->zadd(‘zset1′,1,’ab’);
169 $redis->zadd(‘zset1′,2,’cd’);
170 $redis->zadd(‘zset1′,3,’ef’);
171 
172 //zincrby 对指定元素索引值的增减,改变元素排列次序
173 $redis->zincrby(‘zset1′,10,’ab’);//返回11
174 
175 //zrem 移除指定元素
176 $redis->zrem(‘zset1′,’ef’); //true or false
177 
178 //zrange 按位置次序返回表中指定区间的元素
179 $redis->zrange(‘zset1′,0,1); //返回位置0和1之间(两个)的元素
180 $redis->zrange(‘zset1′,0,-1);//返回位置0和倒数第一个元素之间的元素(相当于所有元素)
181 
182 //zrevrange 同上,返回表中指定区间的元素,按次序倒排
183 $redis->zrevrange(‘zset1′,0,-1); //元素顺序和zrange相反
184 
185 //zrangebyscore/zrevrangebyscore 按顺序/降序返回表中指定索引区间的元素
186 $redis->zadd(‘zset1′,3,’ef’);
187 $redis->zadd(‘zset1′,5,’gh’);
188 $redis->zrangebyscore(‘zset1′,2,9); //返回索引值2-9之间的元素 array(‘ef’,'gh’)
189 //参数形式
190 $redis->zrangebyscore(‘zset1′,2,9,’withscores’); //返回索引值2-9之间的元素并包含索引值 array(array(‘ef’,3),array(‘gh’,5))
191 $redis->zrangebyscore(‘zset1′,2,9,array(‘withscores’ =>true,’limit’=>array(1, 2))); //返回索引值2-9之间的元素,’withscores’ =>true表示包含索引值; ‘limit’=>array(1, 2),表示最多返回2条,结果为array(array(‘ef’,3),array(‘gh’,5))
192 
193 //zunionstore/zinterstore 将多个表的并集/交集存入另一个表中
194 $redis->zunionstore(‘zset3′,array(‘zset1′,’zset2′,’zset0′)); //将’zset1′,’zset2′,’zset0′的并集存入’zset3′
195 //其它参数
196 $redis->zunionstore(‘zset3′,array(‘zset1′,’zset2′),array(‘weights’ => array(5,0)));//weights参数表示权重，其中表示并集后值大于5的元素排在前，大于0的排在后
197 $redis->zunionstore(‘zset3′,array(‘zset1′,’zset2′),array(‘aggregate’ => ‘max’));//’aggregate’ => ‘max’或’min’表示并集后相同的元素是取大值或是取小值
198 
199 //zcount 统计一个索引区间的元素个数
200 $redis->zcount(‘zset1′,3,5);//2
201 $redis->zcount(‘zset1′,’(3′,5)); //’(3′表示索引值在3-5之间但不含3,同理也可以使用’(5′表示上限为5但不含5
202 
203 //zcard 统计元素个数
204 $redis->zcard(‘zset1′);//4
205 
206 //zscore 查询元素的索引
207 $redis->zscore(‘zset1′,’ef’);//3
208 
209 //zremrangebyscore 删除一个索引区间的元素
210 $redis->zremrangebyscore(‘zset1′,0,2); //删除索引在0-2之间的元素(‘ab’,'cd’),返回删除元素个数2
211 
212 //zrank/zrevrank 返回元素所在表顺序/降序的位置(不是索引)
213 $redis->zrank(‘zset1′,’ef’);//返回0,因为它是第一个元素;zrevrank则返回1(最后一个)
214 
215 //zremrangebyrank 删除表中指定位置区间的元素
216 $redis->zremrangebyrank(‘zset1′,0,10); //删除位置为0-10的元素,返回删除的元素个数2
217 
218 /**
219 hash表操作
220 */
221 
222 //hset/hget 存取hash表的数据
223 $redis->hset(‘hash1′,’key1′,’v1′); //将key为’key1′ value为’v1′的元素存入hash1表
224 $redis->hset(‘hash1′,’key2′,’v2′);
225 $redis->hget(‘hash1′,’key1′);  //取出表’hash1′中的key ‘key1′的值,返回’v1′
226 
227 //hexists 返回hash表中的指定key是否存在
228 $redis->hexists (‘hash1′,’key1′); //true or false
229 
230 //hdel 删除hash表中指定key的元素
231 $redis->hdel(‘hash1′,’key2′); //true or false
232 
233 //hlen 返回hash表元素个数
234 $redis->hlen(‘hash1′); //1
235 
236 //hsetnx 增加一个元素,但不能重复
237 $redis->hsetnx(‘hash1′,’key1′,’v2′); //false
238 $redis->hsetnx(‘hash1′,’key2′,’v2′); //true
239 
240 //hmset/hmget 存取多个元素到hash表
241 $redis->hmset(‘hash1′,array(‘key3′=>’v3′,’key4′=>’v4′));
242 $redis->hmget(‘hash1′,array(‘key3′,’key4′)); //返回相应的值 array(‘v3′,’v4′)
243 
244 //hincrby 对指定key进行累加
245 $redis->hincrby(‘hash1′,’key5′,3); //返回3
246 $redis->hincrby(‘hash1′,’key5′,10); //返回13
247 
248 //hkeys 返回hash表中的所有key
249 $redis->hkeys(‘hash1′); //返回array(‘key1′,’key2′,’key3′,’key4′,’key5′)
250 
251 //hvals 返回hash表中的所有value
252 $redis->hvals(‘hash1′); //返回array(‘v1′,’v2′,’v3′,’v4′,13)
253 
254 //hgetall 返回整个hash表元素
255 $redis->hgetall(‘hash1′); //返回array(‘key1′=>’v1′,’key2′=>’v2′,’key3′=>’v3′,’key4′=>’v4′,’key5′=>13)
256 
257 /**
258 排序操作
259 */
260 
261 //sort 排序
262 $redis->rpush(‘tab’,3);
263 $redis->rpush(‘tab’,2);
264 $redis->rpush(‘tab’,17);
265 $redis->sort(‘tab’);  //返回array(2,3,17)
266 //使用参数,可组合使用 array(‘sort’ => ‘desc’,'limit’ => array(1, 2))
267 $redis->sort(‘tab’,array(‘sort’ => ‘desc’));  //降序排列,返回array(17,3,2)
268 $redis->sort(‘tab’,array(‘limit’ => array(1, 2)));  //返回顺序位置中1的元素2个(这里的2是指个数,而不是位置),返回array(3,17)
269 $redis->sort(‘tab’,array(‘limit’ => array(‘alpha’ => true))); //按首字符排序返回array(17,2,3),因为17的首字符是’1′所以排首位置
270 $redis->sort(‘tab’,array(‘limit’ => array(‘store’ => ‘ordered’))); //表示永久性排序,返回元素个数
271 $redis->sort(‘tab’,array(‘limit’ => array(‘get’ => ‘pre_*’))); //使用了通配符’*'过滤元素,表示只返回以’pre_’开头的元素
272 
273 /**
274 redis管理操作
275 */
276 
277 //select 指定要操作的数据库
278 $redis->select(‘mydb’); //指定为mydb,不存在则创建
279 
280 //flushdb 清空当前库
281 $redis->flushdb();
282 
283 //move 移动当库的元素到其它库
284 $redis->set(‘foo’, ‘bar’);
285 $redis->move(‘foo’, ‘mydb2′); //若’mydb2′库存在
286 
287 //info 显示服务当状态信息
288 $redis->info();
289 
290 //slaveof 配置从服务器
291 $redis->slaveof(’127.0.0.1′,80); //配置127.0.0.1端口80的服务器为从服务器
292 $redis->slaveof(); //清除从服务器
293 
294 //同步保存服务器数据到磁盘
295 $redis->save();
296 //异步保存服务器数据到磁盘
297 $redis->bgsave();
298 //??
299 $redis->bgrewriteaof();
300 //返回最后更新磁盘的时间
301 $redis->lastsave();
302 
303 //set/get多个key-value
304 $mkv = array(
305 ‘usr:0001′ => ‘First user’,
306 ‘usr:0002′ => ‘Second user’,
307 ‘usr:0003′ => ‘Third user’
308 );
309 $redis->mset($mkv); //存储多个key对应的value
310 $retval = $redis->mget(array_keys($mkv)); //获取多个key对应的value
311 print_r($retval);
312 
313 //批量操作
314 $replies = $redis->pipeline(function($pipe) {
315 $pipe->ping();
316 $pipe->flushdb();
317 $pipe->incrby(‘counter’, 10); //增量操作
318 $pipe->incrby(‘counter’, 30);
319 $pipe->exists(‘counter’);
320 $pipe->get(‘counter’);
321 $pipe->mget(‘does_not_exist’, ‘counter’);
322 });
323 print_r($replies);
324 
325 //CAS,事务性操作
326 
327 function zpop($client, $zsetKey) {
328 $element = null;
329 $options = array(
330 ‘cas’   => true,     // Initialize with support for CAS operations
331 ‘watch’ => $zsetKey, // Key that needs to be WATCHed to detect changes
332 ‘retry’ => 3,        // Number of retries on aborted transactions, after
333 // which the client bails out with an exception.
334 );
335 
336 $txReply = $client->multiExec($options, function($tx)
337 use ($zsetKey, &$element) {
338 @list($element) = $tx->zrange($zsetKey, 0, 0);
339 if (isset($element)) {
340 $tx->multi();     // With CAS, MULTI *must* be explicitly invoked.
341 $tx->zrem($zsetKey, $element);
342 }
343 });
344 return $element;
345 }
346 $zpopped = zpop($redis, ‘zset’);
347 echo isset($zpopped) ? “ZPOPed $zpopped” : “Nothing to ZPOP!”, “\n”;
348 
349 //对存取的key加前缀,如: ‘nrk:’
350 $redis->getProfile()->setPreprocessor(new KeyPrefixPreprocessor(‘nrk:’));
351 
352 //分布式存储的一些方法
353 $multiple_servers = array(
354 array(
355 ‘host’     => ’127.0.0.1′,
356 ‘port’     => 6379,
357 ‘database’ => 15,
358 ‘alias’    => ‘first’,
359 ),
360 array(
361 ‘host’     => ’127.0.0.1′,
362 ‘port’     => 6380,
363 ‘database’ => 15,
364 ‘alias’    => ‘second’,
365 ),
366 );
367 
368 use Predis\Distribution\IDistributionStrategy;
369 
370 class NaiveDistributionStrategy implements IDistributionStrategy {
371 private $_nodes, $_nodesCount;
372 
373 public function __constructor() {
374 $this->_nodes = array();
375 $this->_nodesCount = 0;
376 }
377 
378 public function add($node, $weight = null) {
379 $this->_nodes[] = $node;
380 $this->_nodesCount++;
381 }
382 
383 public function remove($node) {
384 $this->_nodes = array_filter($this->_nodes, function($n) use($node) {
385 return $n !== $node;
386 });
387 $this->_nodesCount = count($this->_nodes);
388 }
389 
390 public function get($key) {
391 $count = $this->_nodesCount;
392 if ($count === 0) {
393 throw new RuntimeException(‘No connections’);
394 }
395 return $this->_nodes[$count > 1 ? abs(crc32($key) % $count) : 0];
396 }
397 
398 public function generateKey($value) {
399 return crc32($value);
400 }
401 }
402 
403 //配置键分布策略
404 $options = array(
405 ‘key_distribution’ => new NaiveDistributionStrategy(),
406 );
407 
408 $redis = new Predis\Client($multiple_servers, $options);
409 
410 for ($i = 0; $i set(“key:$i”, str_pad($i, 4, ’0′, 0));
411 $redis->get(“key:$i”);
412 }
413 
414 $server1 = $redis->getClientFor(‘first’)->info();
415 $server2 = $redis->getClientFor(‘second’)->info();
416 
417 printf(“Server ‘%s’ has %d keys while server ‘%s’ has %d keys.\n”,
418 ‘first’, $server1['db15']['keys'], ‘second’, $server2['db15']['keys']