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

你可能感兴趣的:(php连接redis的操作库predis操作大全)