php连接redis的操作库predis操作大全

predis是php连接redis的操作库，由于它完全使用php编写，大量使用命名空间以及闭包等功能，只支持php5.3以上版本，故实测性能一般，每秒25000次读写，相信改换c语言编写的php扩展后性能会大幅提升(比如使用C扩展phpredis https://github.com/owlient/phpredis)。

将session数据存放到redis也很简单:
session.save_handler = redis
session.save_path = “tcp://127.0.0.1:6379″

以下是汇总一些操作，并不断更新。

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