# PHP操作Redis的常用方法
> Redis是一個開源的使用ANSI C語言編寫、支持網絡、可基于內存亦可持久化的日志型、Key-Value數據庫，并提供多種語言的API。 Redis支持的數據類型有 Stirng(字符串), List(列表), Hash(字典), Set(集合), Sorted Set(有序集合);
## 1，connect
描述：實例連接到一個Redis.
參數：host: string，port: int
返回值：BOOL 成功返回：TRUE; 失敗返回：FALSE
示例：
~~~
//實例化redis
$redis = new Redis();
//連接
$redis->connect('127.0.0.1', 6379);
//檢測是否連接成功
echo "Server is running: " . $redis->ping();
// 輸出結果 Server is running: +PONG
~~~
## 2，set
描述：設置key和value的值
參數：Key Value
返回值：BOOL 成功返回：TRUE;失敗返回：FALSE
示例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$result = $redis->set('test',"11111111111"); ?
var_dump($result); ? ?//結果：bool(true)
~~~
## 3，get
描述：獲取有關指定鍵的值
參數：key
返回值：string或BOOL 如果鍵不存在，則返回 FALSE。否則，返回指定鍵對應的value值。
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$result = $redis->get('test'); ?
var_dump($result); ? //結果：string(11) "11111111111"
~~~
## 4，delete
描述：刪除指定的鍵
參數：一個鍵，或不確定數目的參數，每一個關鍵的數組：key1 key2 key3 … keyN
返回值：刪除的項數
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->set('test',"1111111111111"); ?
echo $redis->get('test'); ? //結果：1111111111111 ?
$redis->delete('test'); ?
var_dump($redis->get('test')); ?//結果：bool(false)
~~~
## 5，setnx
描述：如果在數據庫中不存在該鍵，設置關鍵值參數
參數：key value
返回值：BOOL 成功返回：TRUE;失敗返回：FALSE
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->set('test',"1111111111111"); ?
$redis->setnx('test',"22222222"); ?
echo $redis->get('test'); ?//結果：1111111111111 ?
$redis->delete('test'); ?
$redis->setnx('test',"22222222"); ?
echo $redis->get('test'); ?//結果：22222222
~~~
## 6，incr
描述：驗證指定的鍵是否存在
參數key
返回值：Bool 成功返回：TRUE;失敗返回：FALSE
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->set('test',"1111111111111"); ?
var_dump($redis->exists('test')); ?//結果：bool(true)
~~~
## 7，incr
描述：數字遞增存儲鍵值鍵.
參數：key value：將被添加到鍵的值
返回值：INT the new value
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->set('test',"123"); ?
var_dump($redis->incr("test")); ?//結果：int(124) ?
var_dump($redis->incr("test")); ?//結果：int(125)
~~~
## 8，decr
描述：數字遞減存儲鍵值。
參數：key value：將被添加到鍵的值
返回值：INT the new value
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->set('test',"123"); ?
var_dump($redis->decr("test")); ?//結果：int(122) ?
var_dump($redis->decr("test")); ?//結果：int(121)
~~~
## 9，getMultiple
描述：取得所有指定鍵的值。如果一個或多個鍵不存在，該數組中該鍵的值為假
參數：其中包含鍵值的列表數組
返回值：返回包含所有鍵的值的數組
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->set('test1',"1");
$redis->set('test2',"2");
$result = $redis->getMultiple(array('test1','test2'));
print_r($result); //結果：Array ( [0] => 1 [1] => 2 )
~~~
## 10，lpush
描述：由列表頭部添加字符串值。如果不存在該鍵則創建該列表。如果該鍵存在，而且不是一個列表，返回FALSE。
參數：key,value
返回值：成功返回數組長度，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
var_dump($redis->lpush("test","111")); //結果：int(1)
var_dump($redis->lpush("test","222")); //結果：int(2)
~~~
## 11，rpush
描述：由列表尾部添加字符串值。如果不存在該鍵則創建該列表。如果該鍵存在，而且不是一個列表，返回FALSE。
參數：key,value
返回值：成功返回數組長度，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
var_dump($redis->lpush("test","111")); //結果：int(1)
var_dump($redis->lpush("test","222")); //結果：int(2)
var_dump($redis->rpush("test","333")); //結果：int(3)
var_dump($redis->rpush("test","444")); //結果：int(4)
~~~
## 12，lpop
描述：返回和移除列表的第一個元素
參數：key
返回值：成功返回第一個元素的值 ，失敗返回false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush("test","111");
$redis->lpush("test","222");
$redis->rpush("test","333");
$redis->rpush("test","444");
var_dump($redis->lpop("test")); //結果：string(3) "222"
~~~
## 13，lsize,llen
描述：返回的列表的長度。如果列表不存在或為空，該命令返回0。如果該鍵不是列表，該命令返回FALSE。
參數：Key
返回值：成功返回數組長度，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush("test","111");
$redis->lpush("test","222");
$redis->rpush("test","333");
$redis->rpush("test","444");
var_dump($redis->lsize("test")); //結果：int(4)
~~~
## 14，lget
描述：返回指定鍵存儲在列表中指定的元素。0第一個元素，1第二個… -1最后一個元素，-2的倒數第二…錯誤的索引或鍵不指向列表則返回FALSE。
參數：key index
返回值：成功返回指定元素的值，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush("test","111");
$redis->lpush("test","222");
$redis->rpush("test","333");
$redis->rpush("test","444");
var_dump($redis->lget("test",3)); //結果：string(3) "444"
~~~
## 15，lset
描述：為列表指定的索引賦新的值,若不存在該索引返回false.
參數：key index value
返回值：成功返回true,失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush("test","111");
$redis->lpush("test","222");
var_dump($redis->lget("test",1)); //結果：string(3) "111"
var_dump($redis->lset("test",1,"333")); //結果：bool(true)
var_dump($redis->lget("test",1)); //結果：string(3) "333"
~~~
## 16，lgetrange
描述： 返回在該區域中的指定鍵列表中開始到結束存儲的指定元素，lGetRange(key, start, end)。0第一個元素，1第二個元素… -1最后一個元素，-2的倒數第二…
參數：key start end
返回值：成功返回查找的值，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush("test","111");
$redis->lpush("test","222");
print_r($redis->lgetrange("test",0,-1)); //結果：Array ( [0] => 222 [1] => 111 )
~~~
## 17,lremove
描述：從列表中從頭部開始移除count個匹配的值。如果count為零，所有匹配的元素都被刪除。如果count是負數，內容從尾部開始刪除。 參數：key count value 返回值：成功返回刪除的個數，失敗false 范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->lpush('test','a');
$redis->lpush('test','b');
$redis->lpush('test','c');
$redis->rpush('test','a');
print_r($redis->lgetrange('test', 0, -1)); //結果：Array ( [0] => c [1] => b [2] => a [3] => a )
var_dump($redis->lremove('test','a',2)); //結果：int(2)
print_r($redis->lgetrange('test', 0, -1)); //結果：Array ( [0] => c [1] => b )
~~~
## 18，sadd
描述：為一個Key添加一個值。如果這個值已經在這個Key中，則返回FALSE。
參數：key value
返回值：成功返回true,失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
var_dump($redis->sadd('test','111')); //結果：bool(true)
var_dump($redis->sadd('test','333')); //結果：bool(true)
print_r($redis->sort('test')); //結果：Array ( [0] => 111 [1] => 333 )
~~~
## 19，sremove
描述：刪除Key中指定的value值
參數：key member
返回值：true or false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd('test','111');
$redis->sadd('test','333');
$redis->sremove('test','111');
print_r($redis->sort('test')); //結果：Array ( [0] => 333 )
~~~
## 20,smove
描述：將Key1中的value移動到Key2中
參數：srcKey dstKey member
返回值：true or false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->delete('test1');
$redis->sadd('test','111');
$redis->sadd('test','333');
$redis->sadd('test1','222');
$redis->sadd('test1','444');
$redis->smove('test',"test1",'111');
print_r($redis->sort('test1')); //結果：Array ( [0] => 111 [1] => 222 [2] => 444 )
~~~
## 21，scontains
描述：檢查集合中是否存在指定的值。
參數：key value
返回值：true or false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd('test','111');
$redis->sadd('test','112');
$redis->sadd('test','113');
var_dump($redis->scontains('test', '111')); //結果：bool(true)
~~~
## 22,ssize
描述：返回集合中存儲值的數量
參數：key
返回值：成功返回數組個數，失敗0
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd('test','111');
$redis->sadd('test','112');
echo $redis->ssize('test'); //結果：2
~~~
## 23，spop
描述：隨機移除并返回key中的一個值
參數：key
返回值：成功返回刪除的值，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
var_dump($redis->spop("test")); //結果：string(3) "333"
~~~
## 24,sinter
描述：返回一個所有指定鍵的交集。如果只指定一個鍵，那么這個命令生成這個集合的成員。如果不存在某個鍵，則返回FALSE。
參數：key1, key2, keyN
返回值：成功返回數組交集，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
$redis->sadd("test1","111");
$redis->sadd("test1","444");
var_dump($redis->sinter("test","test1")); //結果：array(1) { [0]=> string(3) "111" }
~~~
## 25,sinterstore
描述：執行sInter命令并把結果儲存到新建的變量中。
參數： Key: dstkey, the key to store the diff into. Keys: key1, key2… keyN. key1..keyN are intersected as in sInter.
返回值：成功返回，交集的個數，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
$redis->sadd("test1","111");
$redis->sadd("test1","444");
var_dump($redis->sinterstore('new',"test","test1")); //結果：int(1)
var_dump($redis->smembers('new')); //結果:array(1) { [0]=> string(3) "111" }
~~~
## 26,sunion
描述： 返回一個所有指定鍵的并集
參數： Keys: key1, key2, … , keyN
返回值：成功返回合并后的集，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
$redis->sadd("test1","111");
$redis->sadd("test1","444");
print_r($redis->sunion("test","test1")); //結果：Array ( [0] => 111 [1] => 222 [2] => 333 [3] => 444 )
~~~
## 27,sunionstore
描述：執行sunion命令并把結果儲存到新建的變量中。
參數： Key: dstkey, the key to store the diff into. Keys: key1, key2… keyN. key1..keyN are intersected as in sInter.
返回值：成功返回，交集的個數，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
$redis->sadd("test1","111");
$redis->sadd("test1","444");
var_dump($redis->sinterstore('new',"test","test1")); //結果：int(4)
print_r($redis->smembers('new')); //結果:Array ( [0] => 111 [1] => 222 [2] => 333 [3] => 444 )
~~~
## 28,sdiff
描述：返回第一個集合中存在并在其他所有集合中不存在的結果
參數：Keys: key1, key2, … , keyN: Any number of keys corresponding to sets in redis. 返回值：成功返回數組，失敗false
范例：
~~~
$redis = new redis();
$redis->connect('127.0.0.1', 6379);
$redis->delete('test');
$redis->sadd("test","111");
$redis->sadd("test","222");
$redis->sadd("test","333");
$redis->sadd("test1","111");
$redis->sadd("test1","444");
print_r($redis->sdiff("test","test1")); //結果：Array ( [0] => 222 [1] => 333 )
~~~
## 29,sdiffstore
描述：執行sdiff命令并把結果儲存到新建的變量中。
參數： Key: dstkey, the key to store the diff into. Keys: key1, key2, … , keyN: Any number of keys corresponding to sets in redis
返回值：成功返回數字，失敗false
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->delete('test'); ?
$redis->sadd("test","111"); ?
$redis->sadd("test","222"); ?
$redis->sadd("test","333"); ?
$redis->sadd("test1","111"); ?
$redis->sadd("test1","444"); ?
var_dump($redis->sdiffstore('new',"test","test1")); ?//結果：int(2) ?
print_r($redis->smembers('new')); ?//結果:Array ( [0] => 222 [1] => 333 ) ?
~~~
## 30,smembers, sgetmembers
描述： 返回集合的內容
參數：Key: key
返回值：An array of elements, the contents of the set.
范例：
~~~
$redis = new redis(); ?
$redis->connect('127.0.0.1', 6379); ?
$redis->delete('test'); ?
$redis->sadd("test","111"); ?
$redis->sadd("test","222"); ?
print_r($redis->smembers('test')); ?//結果:Array ( [0] => 111 [1] => 222 )
~~~
