Laravel 的 Redis 使用

最新推荐文章于 2023-07-28 14:49:55 发布

qq_40414209

最新推荐文章于 2023-07-28 14:49:55 发布

阅读量384

点赞数

分类专栏： laravel readis

原文链接：https://learnku.com/docs/laravel/5.5/redis/1331

版权

laravel 同时被 2 个专栏收录

27 篇文章 0 订阅

订阅专栏

readis

2 篇文章 0 订阅

订阅专栏

laravel文档

##安装

composer require predis/predis

配置

应用程序的 Redis 配置都在配置文件 config/database.php 中。在这个文件里，你可以看到 redis 数组里面包含了应用程序使用的 Redis 服务器：

'redis' => [

    'client' => 'predis',
	'cluster' => false, //聚群配置
    'default' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => 0,
    ],

],

默认的服务器配置应该足以进行开发。当然，你也可以根据使用的环境来随意更改这个数组。只需在配置文件中给每个 Redis 服务器指定名称、host 和 port 即可。

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,
],

与 Redis 交互

你可以调用 Redis facade 上的各种方法来与 Redis 进行交互。Redis facade 支持动态方法，这意味着你可以在 facade 上调用任何 Redis 命令，还能将该命令直接传递给 Redis。在本例中，通过调用 Redis facade 上的 get 方法来调用 Redis 的 GET 命令：

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Redis;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        $user = Redis::get('user:profile:'.$id);

        return view('user.profile', ['user' => $user]);
    }
}

也就是说，你可以在 Redis facade 上调用任何的 Redis 命令。Laravel 使用魔术方法将传递命令给 Redis 服务器，因此只需传递 Redis 命令所需的参数即可：

Redis::set('name', 'Taylor');

$values = Redis::lrange('names', 5, 10);

设置过期时间

Redis::setex( $key , $expired_at , $value );
$expired_at 就是过期时间，单位秒

使用：字符串操作

/set存数据 创建一个 key 并设置value 
Redis::set('key','value'); 
 
//get命令用于获取指定 key 的值,key不存在,返回null,如果key储存的值不是字符串类型，返回一个错误。
var_dump(Redis::get('key'));
 
//del 删除 成功删除返回 true, 失败则返回 false
Redis::del('key');
 
//mset存储多个 key 对应的 value
$array= array(
		'user1'=>'张三',
		'user2'=>'李四',
		'user3'=>'王五'
);
redis::mset($array); // 存储多个 key 对应的 value
 
// Mget返回所有(一个或多个)给定 key 的值,给定的 key 里面,key 不存在,这个 key 返回特殊值 nil
 
var_dump(redis::mget (array_keys( $array))); //获取多个key对应的value
 
//Strlen 命令用于获取指定 key 所储存的字符串值的长度。当 key存储不是字符串，返回错误。
var_dump(redis::strlen('key'));
 
//substr 获取第一到第三位字符
var_dump(Redis::substr('key',0,2));
 
//根据键名模糊搜索
var_dump(Redis::keys('use*'));//模糊搜索
 
//获取缓存时间
Redis::ttl('str2');//获取缓存时间
 
//exists检测是否存在某值
Redis::exists ( 'foo' ) ; //true

队列操作

//rpush/rpushx 有序列表操作,从队列后插入元素；lpush/lpushx 和 rpush/rpushx 的区别是插入到队列的头部,同上,'x'含义是只对已存在的 key 进行操作
 
Redis::rpush('fooList', 'bar1'); // 返回列表长度 1
Redis::lpush('fooList', 'bar2'); // 返回列表长度 2
Redis::rpushx('fooList', 'bar3'); // 返回 3, rpushx只对已存在的队列做添加,否则返回 0
 
 
//llen返回当前列表长度
var_dump(Redis::llen('fooList')); //返回3
 
 
//lrange 返回队列中一个区间的元素
var_dump(Redis::lrange ('fooList', 0, 1)); // 返回数组包含第 0 个至第 1 个, 共2个元素
var_dump(Redis::lrange ('fooList', 0, -1)); //返回第0个至倒数第一个, 相当于返回所有元素
 
//lindex 返回指定顺序位置的 list 元素
var_dump(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 秒后超时

排序操作:


//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_'开头的元素

管理操作：

//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();

set 集合操作 sadd增加set集合元素，返回true，重复返回false

Redis::sadd('set1', 'ab'); //将一个元素加入集合，已经存在集合中的元素则忽略。若集合不存在则先创建，若key不是集合类型则返回false，若元素已存在返回0，插入成功返回1。 
Redis::sadd('set1', 'cd');
Redis::sadd('set1', 'ef');
Redis::srem('set1', 'cd'); //srem 移除指定元素,这里 删除'cd'元素
Redis::spop('set1'); //spop 弹出首元素 返回 'ab'
Redis::sadd('set2', '123'); 
Redis::smove('set1', 'set2', 'ab'); //smove 移动当前set集合的指定元素到另一个set集合,这里是 移动'set1'中的'ab'到'set2', 返回true or false；此时 'set1'集合不存在 'ab' 这个值
Redis::scard('set2'); //scard 返回当前set表元素个数
Redis::sismember('set2', '123'); //sismember 判断元素是否属于当前set集合 返回 true or false
Redis::smembers('set2'); //smembers 返回当前set集合的所有元素
//sinter/sunion/sdiff 返回两个表中元素的交集/并集/补集
Redis::sadd('set1', 'ab') ;// 返回 array('123','ab')
Redis::sinter('set2', 'set1') ; //返回set2和set1的交集
//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') ;

//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)

有序聚合

或者，你也可以使用 command 方法将命令传递给服务器，它接受命令的名称作为其第一个参数，并将值的数组作为其第二个参数：

$values = Redis::command('lrange', ['name', 5, 10]);

管道命令

如果你需要在一个操作中向服务器发送很多命令，推荐你使用管道命令。pipeline 方法接收一个带有 Redis 实例的闭包。你可以将所有的命令发送给这个 Redis 实例，它们都会一次过执行完：

Redis::pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});

发布与订阅

Laravel 为 Redis 的 publish 及 subscribe 提供了方便的接口。这些 Redis 命令让你可以监听指定「频道」上的消息。你可以从另一个应用程序发布消息给另一个应用程序，甚至使用其它编程语言，让应用程序和进程之间能够轻松进行通信。

首先，我们使用 subscribe 方法设置频道监听器。我们将这个方法调用放在 Artisan 命令中，因为调用 subscribe 方法会启动一个长时间运行的进程：

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;

class RedisSubscribe extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'redis:subscribe';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Subscribe to a Redis channel';

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        Redis::subscribe(['test-channel'], function ($message) {
            echo $message;
        });
    }
}

现在，我们可以使用 publish 方法发布消息到频道：

Route::get('publish', function () {
    // Route logic...

    Redis::publish('test-channel', json_encode(['foo' => 'bar']));
});

通配符订阅

使用 psubscribe 方法可以订阅通配符频道，可以用来在所有频道上获取所有消息。$channel 名称将作为第二个参数传递给提供的回调闭包：

Redis::psubscribe(['*'], function ($message, $channel) {
    echo $message;
});

Redis::psubscribe(['users.*'], function ($message, $channel) {
    echo $message;
});

qq_40414209

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Laravel 的 Redis 使用

laravel文档##安装composer require predis/predis配置应用程序的 Redis 配置都在配置文件 config/database.php 中。在这个文件里，你可以看到 redis 数组里面包含了应用程序使用的 Redis 服务器：'redis' => [ 'client' => 'predis', 'cluster' =>...
复制链接

扫一扫