Laravel redis使用教程

1、安裝

在 Laravel 中使用 Redis 之前，需要通過 Composer 安裝 predis/predis 包：

composer require predis/predis

2、配置

應用的 Redis 配置位於配置文件 config/database.php。在這個文件中，可以看到包含被應用使用的 Redis 服務器的 redis 數組：

'redis' => [

    'client' => 'predis',

    'default' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => 0,
    ],

],

默認服務器配置可以滿足開發需要，不過，你可以基於自己的環境修改該數組。配置文件中定義的每個 Redis 服務器需要一個名字並指定該 Redis 服務器使用的主機和接口。

配置集群

如果應用使用了 Redis 服務器集群，需要在 Redis 配置中通過 clusters 定義這些集群：

'redis' => [

    'client' => 'predis',

    'clusters' => [
        'default' => [
            [
                'host' => env('REDIS_HOST', 'localhost'),
                'password' => env('REDIS_PASSWORD', null),
                'port' => env('REDIS_PORT', 6379),
                'database' => 0,
            ],
        ],
    ],

],

默認情況下，集群將會在節點之間進行客戶端分區，從而允許你構建節點池並創建大量可用內存。不過，客戶端分片並不處理故障轉移，所以，非常適合從另一個主數據存儲那里獲取有效的緩存數據。如果你想要使用本地 Redis 集群，需要在 Redis 配置的 options 中進行指定：

'redis' => [

    'client' => 'predis',

    'options' => [
        'cluster' => 'redis',
    ],

    'clusters' => [
        // ...
    ],

],

Predis

除了默認的 host、port、database 和 password 服務器配置選項，Predis 還支持額外的用於定義每個 Redis 服務器的連接參數，要使用這些額外的配置項，只需在配置文件 config/database.php 中將它們添加到 Redis 服務器配置中：

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD', null),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_write_timeout' => 60,
],

PhpRedis

注：如果你通過 PECL 安裝了 PHP 擴展 PhpRedis，需要在配置文件 config/app.php 中重命名 Redis 別名。

要使用 PhpRedis 擴展，需要在Redis 配置中將 client 選項修改為 phpredis，該選項位於配置文件 config/database：

'redis' => [

    'client' => 'phpredis',

    // Rest of Redis configuration...
],

除了默認的 host、port、database 和 password 服務器配置選項，PhpRedis 還支持額外的連接參數：persistent、prefix、read_timeout 和 timeout，你可以在配置文件 config/database.php 中將它們添加到 Redis 服務器配置中：

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD', null),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_timeout' => 60,
],

以上是官方文檔給出的示例，下面是總結的用法；

與Redis交互實例

簡介

Redis模塊負責與Redis數據庫交互，並提供Redis的相關API支持；

Redis模塊提供redis與redis.connection這兩個服務；redis.connection服務提供redis連接對象；redis服務提供Illuminate\Redis\RedisManager對象，負責與Redis打交道的這部分管理工作；

下面看下配置自定義連接對象名、redis集群、和默認的示例：

命名：

default是默認的Redis連接對象名，值是連接對象的參數；app('redis.connection')返回的就是該默認連接對象；

mydefine是筆者定義的Redis連接對象名；通過執行app('redis')->connection('mydefine')可以獲取該連接對象；

mycluster1是筆者定義的Redis集群對象名；通過執行app('redis')->connection('mycluster1')可以獲取該集群對象；

配置：

'redis' => [                                                                                    
    'client' => 'predis',                                                                       
    'default' => [                                                                              
         'host' => env('REDIS_HOST', '127.0.0.1'),                                               
         'password' => env('REDIS_PASSWORD', null),                                              
         'port' => env('REDIS_PORT', 6379),                                                      
         'database' => 0,                                                                        
    ], 
    'mydefine' => [                                                                              
         'host' => env('REDIS_HOST', '127.0.0.1'),                                               
         'password' => env('REDIS_PASSWORD', null),                                              
         'port' => env('REDIS_PORT', 6379),                                                      
         'database' => 4,                                                                        
    ],
    'clusters' => [                                                                             
        'mycluster1' => [                                                                       
            [                                                                                   
                'host' => env('REDIS_HOST', '127.0.0.1'),                                       
                'password' => env('REDIS_PASSWORD', null),                                      
                'port' => env('REDIS_PORT', 6379),                                              
                'database' => 1,                                                                
            ],                                                                                  
            [                                                                                   
                'host' => env('REDIS_HOST', '127.0.0.1'),                                       
                'password' => env('REDIS_PASSWORD', null),                                      
                'port' => env('REDIS_PORT', 6379),                                              
                'database' => 2,                                                                
            ],
            [                                                                                   
                'host' => env('REDIS_HOST', '127.0.0.1'),                                       
                'password' => env('REDIS_PASSWORD', null),                                      
                'port' => env('REDIS_PORT', 6379),                                              
                'database' => 3,                                                                
            ], 
       ],                                                                                      
    ],          
],

使用：

普通 set / get 操作；set 操作，如果鍵名存在，則會覆蓋原有的值：

$redis = app('redis.connection');
$redis->set('library', 'predis'); // 存儲 key 為 library， 值為 predis 的記錄；
$redis->get('library'); // 獲取 key 為 library 的記錄值

set 、get 多個key-value：

$mkv = array(
    'usr:0001' => 'First user',
    'usr:0002' => 'Second user',
    'usr:0003' => 'Third user'
);
$redis->mset($mkv);  // 存儲多個 key 對應的 value
$retval = $redis -> mget (array_keys( $mkv));  //獲取多個key對應的value

存放帶存儲時效的記錄：

$redis->setex('library', 10, 'predis'); // 存儲 key 為 library， 值為 predis 的記錄, 有效時長為 10 秒

add操作,不會覆蓋已有值：

$redis->setnx('foo', 12) ;  // 返回 true ， 添加成功
$redis->setnx('foo', 34) ;  // 返回 false， 添加失敗，因為已經存在鍵名為 foo 的記錄

set的變種，結果返回替換前的值：

$redis->getset('foo', 56) ; // 返回 34； 如果之前不存在記錄，則返回 null

incrby/incr/decrby/decr 對值的遞增和遞減：

$redis->incr('foo') ;  // 返回 57，同時 foo 的值為 57
$redis->incrby('foo', 2 ) ;  // 返回 59，同時 foo 的值為 59

檢測某 key 是否存在值：

$redis->exists('foo');

刪除某 key 值：

$redis->del('foo'); // 成功刪除返回 true, 失敗則返回 false

type類型檢測，字符串返回 string，列表返回 list，set 表返回 set/zset，hash 表返回 hash：

$redis->type('foo');

append 連接到已存在字符串：

$redis->get('str'); // 返回 test
$redis->append('str', '_123');  // 返回累加后的字符串長度 8,此時 str 為 'test_123'

setrange 部分替換操作, 並返回字符串長度：

$redis->setrange('str', 0, 'abc');  // 返回 3, 第2個參數為 0 時等同於 set 操作
$redis->setrange('str', 2, 'cd'); // 返回 4, 表示從第2個字符后替換，這時 'str' 為 'abcd'

substr 部分獲取操作：

$redis->substr('str', 0, 2); // 返回'abc'; 表示從第 0 個起，取到第 2 個字符

strlen 獲取字符串長度：

$redis->strlen ('str'); // 返回 4; 此時 'str' 為 'abcd'

setbit位存儲：

$redis->setbit('binary', 31, 1); //表示在第31位存入1,這邊可能會有大小端問題?不過沒關系, getbit 應該不會有問題

getbit位獲取：

$redis->getbit('binary', 31); //返回1

keys 模糊查找功能,支持 * 號以及 ? 號 (匹配一個字符)：

$redis->set('foo1', 123);
$redis->set('foo2', 456);
$redis->keys('foo*');   // 返回 foo1 和 foo2 的 array
$redis->keys('f?o?');   // 同上

randomkey隨機返回一個key：

$redis->randomkey() ; // 可能是返回 'foo1' 或者是 'foo2' 及其它任何已存在的 key

rename/renamenx方法對key進行改名，所不同的是renamenx不允許改成已存在的key：

$redis->rename('str', 'str2'); // 把原先命名為'str'的 key 改成了 'str2'

expire 設置 key-value 的時效性
ttl 獲取剩余有效期
persist 重新設置為永久存儲

$redis->expire('foo', 10);  // 設置有效期為 10 秒
$redis->ttl('foo');  // 返回剩余有效期值 10 秒
$redis->persist('foo');  // 取消 expire 行為

dbsize 返回redis當前數據庫的記錄總數：

$redis->dbsize() ;

隊列操作

rpush/rpushx 有序列表操作,從隊列后插入元素；lpush/lpushx 和 rpush/rpushx 的區別是插入到隊列的頭部,同上,'x'含義是只對已存在的 key 進行操作：

$redis->rpush('fooList', 'bar1');  // 返回列表長度 1
$redis->lpush('fooList', 'bar0');  // 返回列表長度 2
$redis->rpushx('fooList', 'bar2');  // 返回 3, rpushx只對已存在的隊列做添加,否則返回 0

llen返回當前列表長度：

$redis->llen('fooList'); // 返回 3

lrange 返回隊列中一個區間的元素：

$redis->lrange ('fooList', 0, 1);  // 返回數組包含第 0 個至第 1 個, 共2個元素
$redis->lrange ('fooList', 0, -1); //返回第0個至倒數第一個, 相當於返回所有元素

lindex 返回指定順序位置的 list 元素：

$redis->lindex('fooList', 1) ; // 返回'bar1'

lset 修改隊列中指定位置的value：

$redis->lset('fooList', 1, '123'); // 修改位置 1 的元素, 返回 true

lrem 刪除隊列中左起指定數量的字符：

$redis->lrem('fooList', 1, '_') ; // 刪除隊列中左起(右起使用-1) 1個 字符'_'(若有)

lpop/rpop 類似棧結構地彈出(並刪除)最左或最右的一個元素：

$redis->lpop('fooList') ;  // 返回 'bar0'
$redis->rpop('fooList') ;  // 返回 'bar2'

ltrim隊列修改，保留左邊起若干元素，其余刪除：

$redis->ltrim('fooList', 0, 1) ; // 保留左邊起第 0 個至第 1 個元素

rpoplpush 從一個隊列中 pop 出元素並 push 到另一個隊列：

$redis->rpush('list1', 'ab0');
$redis->rpush('list1', 'ab1');
$redis->rpush('list2', 'ab2');
$redis->rpush('list2', 'ab3');
$redis->rpoplpush('list1', 'list2'); // 結果list1 =>array('ab0'), list2 =>array('ab1','ab2','ab3')
$redis->rpoplpush('list2', 'list2'); // 也適用於同一個隊列, 把最后一個元素移到頭部 list2 =>array('ab3','ab1','ab2')

linsert在隊列的中間指定元素前或后插入元素：

$redis->linsert('list2', 'before', 'ab1', '123');  //表示在元素 'ab1' 之前插入 '123'
$redis->linsert('list2', 'after', 'ab1', '456');   //表示在元素 'ab1' 之后插入 '456'

blpop/brpop 阻塞並等待一個列隊不為空時，再pop出最左或最右的一個元素（這個功能在php以外可以說非常好用）

$redis->blpop('list3', 10) ; // 如果 list3 為空則一直等待,直到不為空時將第一元素彈出, 10 秒后超時

set 集合操作

sadd增加set集合元素， 返回true， 重復返回false：

$redis->sadd('set1', 'ab');
$redis->sadd('set1', 'cd');
$redis->sadd('set1', 'ef');

srem 移除指定元素：

$redis->srem('set1', 'cd'); // 刪除'cd'元素

spop 彈出首元素：

$redis->spop('set1'); // 返回 'ab'

smove 移動當前set集合的指定元素到另一個set集合：

$redis->sadd('set2', '123');
$redis->smove('set1', 'set2', 'ab'); // 移動'set1'中的'ab'到'set2', 返回true or false；此時 'set1'集合不存在 'ab' 這個值

scard 返回當前set表元素個數：

$redis->scard('set2'); // 返回 2

sismember 判斷元素是否屬於當前set集合：

$redis->sismember('set2', '123'); // 返回 true or false

smembers 返回當前set集合的所有元素：

$redis->smembers('set2'); // 返回 array('123','ab')

sinter/sunion/sdiff 返回兩個表中元素的交集/並集/補集：

$redis->sadd('set1', 'ab');
$redis->sinter('set2', 'set1');  //返回array('ab')

sinterstore/sunionstore/sdiffstore 將兩個表交集/並集/補集元素 copy 到第三個表中：

$redis->set('foo', 0);
$redis->sinterstore('foo', 'set1');  // 等同於將'set1'的內容copy到'foo'中，並將'foo'轉為set表
$redis->sinterstore('foo', array('set1', 'set2'));  // 將'set1'和'set2'中相同的元素 copy 到'foo'表中, 覆蓋'foo'原有內容

srandmember 返回表中一個隨機元素：

$redis->srandmember('set1');

有序set表操作

sadd 增加元素，並設置序號，成功返回true，重復返回false：

$redis->zadd('zset1', 1, 'ab');
$redis->zadd('zset1', 2, 'cd');
$redis->zadd('zset1', 3, 'ef');

zincrby 對指定元素索引值的增減,改變元素排列次序：

$redis -> zincrby ( 'zset1' , 10 , 'ab' ) ; //返回11

zrem 移除指定元素：

$redis->zrem('zset1', 'ef'); // 返回 true or false

zrange 按位置次序返回表中指定區間的元素：

$redis->zrange('zset1', 0, 1);  // 返回位置 0 和 1 之間(兩個)的元素
$redis->zrange('zset1', 0, -1); // 返回位置 0 和倒數第一個元素之間的元素(相當於所有元素)

zrevrange 同上,返回表中指定區間的元素,按次序倒排：

$redis->zrevrange('zset1', 0, -1); // 元素順序和zrange相反

zrangebyscore/zrevrangebyscore 按順序/降序返回表中指定索引區間的元素：

$redis->zadd('zset1', 3, 'ef');
$redis->zadd('zset1', 5, 'gh');
$redis->zrangebyscore('zset1', 2, 9);  //返回索引值2-9之間的元素 array('ef','gh')
$redis->zrangebyscore('zset1', 2, 9, 'withscores'); // 返回索引值2-9之間的元素並包含索引值 array(array('ef',3),array('gh',5))
$redis->zrangebyscore('zset1', 2, 9, array('withscores'=>true, 'limit'=>array(1, 2)));
//返回索引值2-9之間的元素,'withscores' =>true表示包含索引值; 'limit'=>array(1, 2),表示偏移1條，返回2條,結果為array(array('ef',3),array('gh',5))

zunionstore/zinterstore 將多個表的並集/交集存入另一個表中：

$redis->zunionstore('zset3', array('zset1', 'zset2', 'zset0'));  //將'zset1','zset2','zset0'的並集存入'zset3'
$redis->zunionstore('zset3', array('zset1', 'zset2'), array('weights' => array(2, 1))); //weights參數表示權重，其中表示並集后 zset1集合的分 * 2 后存儲到 zset3 集合， zset2集合的分 * 1 后存儲到 zset3 集合
$redis->zunionstore('zset3', array('zset1', 'zset2'), array('aggregate' => 'max')); //'aggregate' => 'max'或'min'表示並集后相同的元素是取大值或是取小值

zcount 統計一個索引區間的元素個數：

$redis->zcount('zset1', 3, 5); // 返回 2
$redis->zcount('zset1', '(3', 5));  //'(3'表示索引值在3-5之間但不含3,同理也可以使用'(5'表示上限為5但不含5

zcard 統計元素個數：

$redis->zcard('zset1'); // 返回 4

zscore 查詢元素的索引：

$redis->zscore('zset1', 'ef'); // 返回 3

zremrangebyscore 刪除一個索引區間的元素：

$redis->zremrangebyscore('zset1', 0, 2); // 刪除索引在0-2之間的元素('ab','cd'), 返回刪除元素個數2

zrank/zrevrank 返回元素所在表順序/降序的位置(不是索引)：

$redis->zrank('zset1', 'ef'); // 返回0,因為它是第一個元素；zrevrank則返回1(最后一個)

zremrangebyrank 刪除表中指定位置區間的元素：

$redis->zremrangebyrank('zset1', 0, 10); //刪除位置為0-10的元素,返回刪除的元素個數2

Hash表操作

hset/hget 存取hash表的數據：

$redis->hset('hash1', 'key1', 'v1');  //將key為'key1' value為'v1'的元素存入hash1表
$redis->hset('hash1', 'key2', 'v2');
$redis->hget('hash1', 'key1');   //取出表'hash1'中的key 'key1'的值,返回'v1'

hexists 返回hash表中的指定key是否存在：

$redis->hexists('hash1', 'key1') ; //true or false

hdel 刪除hash表中指定key的元素：

$redis->hdel('hash1', 'key2') ; //true or false

hlen 返回hash表元素個數：

$redis->hlen('hash1'); // 返回 1

hsetnx 增加一個元素,但不能重復：

$redis->hsetnx('hash1', 'key1', 'v2') ;  // false
$redis->hsetnx('hash1', 'key2', 'v2') ;  // true

hmset/hmget 存取多個元素到hash表：

$redis->hmset('hash1', array('key3' => 'v3', 'key4' => 'v4')); 
$redis->hmget('hash1', array('key3', 'key4'));  // 返回相應的值 array('v3','v4')

hincrby 對指定key進行累加：

$redis->hincrby('hash1', 'key5', 3);  // 不存在，則存儲並返回 3；存在，即返回 原有值 + 3；
$redis->hincrby('hash1', 'key5', 10);  // 返回13

hkeys 返回hash表中的所有key：

$redis->hkeys('hash1'); // 返回array('key1', 'key2', 'key3', 'key4', 'key5')

hvals 返回hash表中的所有value：

$redis->hvals('hash1'); // 返回 array('v1','v2','v3','v4',13)

hgetall 返回整個hash表元素：

$redis->hgetall('hash1'); // 返回 array('key1'=>'v1','key2'=>'v2','key3'=>'v3','key4'=>'v4','key5'=>13)

排序操作

sort 排序：

$redis->rpush('tab', 3);
$redis->rpush('tab', 2);
$redis->rpush('tab', 17);
$redis->sort('tab');   // 返回 array(2,3,17)

// 使用參數,可組合使用 array('sort' => 'desc','limit' => array(1, 2))
$redis->sort('tab', array('sort' => 'desc'));   // 降序排列，返回 array(17,3,2)
$redis->sort('tab', array('limit' => array(1, 2)));   //返回順序位置中1的元素2個(這里的2是指個數,而不是位置)，返回array(3,17)

$redis->sort('tab', array('limit' => array('alpha' => true)));  //按首字符排序返回array(17,2,3)，因為17的首字符是'1'所以排首位置
$redis->sort('tab', array('limit' => array('store' => 'ordered')));  //表示永久性排序，返回元素個數
$redis->sort('tab', array('limit' => array('get' => 'pre_*')));  //使用了通配符'*'過濾元素，表示只返回以'pre_'開頭的元素

Redis管理操作

info 顯示服務當狀態信息：

$redis->info();

select 指定要操作的數據庫：

$redis->select(4); // 指定數據庫的下標

flushdb 清空當前庫：

$redis->flushdb();

move 移動當庫的元素到其它數據庫：

$redis->set('tomove', 'bar');
$redis->move('tomove', 4);

slaveof 配置從服務器：

$redis->slaveof('127.0.0.1', 80);  // 配置 127.0.0.1 端口 80 的服務器為從服務器
$redis->slaveof();  // 清除從服務器

同步保存服務器數據到磁盤：

$redis->save();

異步保存服務器數據到磁盤：

$redis->bgsave ();

返回最后更新磁盤的時間：

$redis->lastsave();