README

1、前言

基于PhalApi2-Redis 官方做了一些优化和新增，有问题欢迎指正；欢迎pull request，兼容PHP Redis所有方法

官网地址：http://www.phalapi.net/
GitHub HomePage：https://github.com/xuepengdong/phalapiredis
github Issues： https://github.com/xuepengdong/phalapiredis/issues
PHP Redis：https://github.com/ukko/phpredis-phpdoc

2、安装：项目根目录composer.json添加

{
    "require": {
        "xuepengdong/phalapiredis": "dev-master"
    }
}

执行composer update更新

3、惰性加载Redis配置：/config/di.php

// 惰性加载Redis
$di->redis = function () {
    return new \Xuepengdong\Phalapiredis\Lite(\PhalApi\DI()->config->get("app.redis.servers"));
};

4、配置redis账号密码：/config/app.php

    /**
     * 扩展类库 - Redis扩展
     */
    'redis' => array(
        //Redis链接配置项
        'servers'  => array(
            'host'   => '127.0.0.1',        //Redis服务器地址
            'port'   => '6379',             //Redis端口号
            'prefix' => 'PhalApi_',         //Redis-key前缀
            'auth'   => 'phalapi',          //Redis链接密码
        ),
        // Redis分库对应关系操作时直接使用名称无需使用数字来切换Redis库
        'DB'       => array(
            'developers' => 1,
            'user'       => 2,
            'code'       => 3,
        ),
        //使用阻塞式读取队列时的等待时间单位/秒
        'blocking' => 5,
    ),

5、入门使用

备注：以下所有库名都可以使用阿拉伯数字

getRedis 调用PHP 原生redis，获取Redis实例，当封装的方法未能满足时，可调用此接口获取Reids实例进行操作

以下为例子：

$getRedis =  \PhalApi\DI()->redis->getRedis();
$getRedis->select(1);
return $getRedis->set('key20220806', 'value20220806', 20000);

永久键值

set_forever：存入永久的单个键值

\PhalApi\DI()->redis->set_forever(键名, 值, 库名);

get_forever：获取单个永久的键值

\PhalApi\DI()->redis->get_forever(键名, 库名);

get_getSet：返回原来key中的值，并将新的value重新写入key
```
\PhalApi\DI()->redis->get_getSet(键名, 值, 库名);
```

set_append：给key后面加上value

\PhalApi\DI()->redis->set_append(键名 , 值, 库名);

get_strlen：返回key 的长度

\PhalApi\DI()->redis->get_strlen('key1' , 'users');

set_list：存入永久的多个键值

\PhalApi\DI()->redis->set_list(数组, 库名);
例子：\PhalApi\DI()->redis->set_list(array('key0' => 'value0', 'key1' => 'value1'), 'users');

get_list：获取多个键值

\PhalApi\DI()->redis->get_list(数组, 库名);
例子：\PhalApi\DI()->redis->get_list(array('key0' , 'key1'), 'users');

get_exists：判断key是否存在

\PhalApi\DI()->redis->get_exists(键名, 库名);

del：删除一个键值队适用于所有

\PhalApi\DI()->redis->del(键名, 库名);

get_redis：切换DB并且获得操作实例

\PhalApi\DI()->redis->get_redis(键名, 库名);

有时效键值
- set_Time：存入一个有时效性的键值队,默认600秒
```
\PhalApi\DI()->redis->set_Time(键名,值,有效时间,库名);
```
- save_Time：修改值，不改变失效时间
```
\PhalApi\DI()->redis->save_Time(键名,新的值,库名);
```
- get_Time：获取一个有时效性的键值
```
\PhalApi\DI()->redis->get_Time(键名, 库名);
```
- get_time_ttl：获取一个key的失效时间，-1：持久化；-2：不存在；其他：失效时间秒
```
\PhalApi\DI()->redis->get_time_ttl(键名, 库名);
```
列表List
- set_Lpush：插入集合：写入队列左边并根据名称自动切换库
```
\PhalApi\DI()->redis->set_Lpush(队列键名,值, 库名);
```
- set_lPushx：插入集合：写入队列左边如果value已经存在，则不添加并根据名称自动切换库
```
 \PhalApi\DI()->redis->set_lPushx(队列键名, 值, 库名);
```
- get_lpop：读取队列左边
```
\PhalApi\DI()->redis->get_lpop(队列键名, 库名);
```
- get_blPop：读取队列左边如果没有读取到阻塞一定时间并根据名称自动切换库
```
\PhalApi\DI()->redis->get_blPop(队列键名,值, 库名);
```
- set_rPush：插入集合：写入队列右边并根据名称自动切换库
```
\PhalApi\DI()->redis->set_rPush(队列键名, 值, 库名);
```
- set_rPushx：写入队列右边如果value已经存在，则不添加并根据名称自动切换库
```
\PhalApi\DI()->redis->set_rPushx(队列键名, 值, 库名);
```
- get_rPop：读取队列右边
```
\PhalApi\DI()->redis->get_rPop(队列键名, 库名);
```
- get_brPop：读取队列右边如果没有读取到阻塞一定时间并根据名称自动切换库
```
\PhalApi\DI()->redis->get_brPop(队列键名,值, 库名);
```
- get_lSize：读取list有多少个元素
```
\PhalApi\DI()->redis->get_lSize(队列键名, 库名);
```
- get_lSize：从左数设置list中指定位置为新的值
```
\PhalApi\DI()->redis->get_lSize(队列键名, 位置, 值, 库名);
```
- get_lRange：获取指定位置返回名称为key的list中start至end之间的元素（end为 -1 ，返回所有）
```
\PhalApi\DI()->redis->get_lRange(队列键名, $start, $end);
```
- get_lTrim：截取指定位置截取名称为key的list，保留start至end之间的元素,end为 -1 ，返回所有
```
\PhalApi\DI()->redis->get_lTrim(键名,$start, $end, 库名);
```

**哈希 Hash **

HSET： 将哈希表 key 中的字段 field 的值设为 value 。

\PhalApi\DI()->redis->HSET($key, $field, $value, $tablename);
例子：\PhalApi\DI()->redis->HSET('hash1', 'field2', 'value2', 1);

Hdel： 命令用于删除哈希表 key 中的一个或多个指定字段，不存在的字段将被忽略。
```
\PhalApi\DI()->redis->HDEL($key, $field, $tablename);
```

HGETALL： 获取在哈希表中指定 key 的所有字段和值

\PhalApi\DI()->redis->HGETALL($key, $tablename);
备注：Redis Hset 命令用于为哈希表中的字段赋值 。如果哈希表不存在，一个新的哈希表被创建并进行 HSET 操作。 如果字段已经存在于哈希表中，旧值将被覆盖。

HEXISTS 查看哈希表 key 中，指定的字段是否存在。
```
\PhalApi\DI()->redis->HEXISTS($key, $field, $tablename);
```

HMGET获取所有给定字段的值

\PhalApi\DI()->redis->HMGET($key, $field, $tablename);
备注：Redis Hmget 命令用于返回哈希表中，一个或多个给定字段的值。如果指定的字段不存在于哈希表，那么返回一个 nil 值。可以传数组

HGET 获取指定字段值

\PhalApi\DI()->redis->HGET($key, $field, $tablename);
备注：只传一个字段

有序集合（sorted set）
- ZADD 向有序集合添加一个或多个成员，或者更新已存在成员的分数
```
\PhalApi\DI()->redis->ZADD('runoobkey', 3,'mysql',  0);
```
- ZCARD Redis Zcard 命令用于计算集合中元素的数量。
```
\PhalApi\DI()->redis->ZCARD('runoobkey', 0);
```
- ZCOUNT Redis Zcount 命令用于计算有序集合中指定分数区间的成员数量。
```
\PhalApi\DI()->redis->ZCARD('runoobkey', 5, 10, 0);
```
- **ZINCRBY **命令对有序集合中指定成员的分数加上增量
```
 \PhalApi\DI()->redis->ZINCRBY('myzset', 2, "one", 0);
```
- ZREM Redis Zrem 命令用于移除有序集中的一个或多个成员，不存在的成员将被忽略。当 key 存在但不是有序集类型时，返回一个错误。
```
\PhalApi\DI()->redis->ZREM(0, 'myzset', 'one', 'two', 'five');
```
计数器：
- counter_forever永久计数器，回调当前计数：
```
\PhalApi\DI()->redis->counter_forever($key, $tablename);
```
公用：
- type：返回key的类型值：
```
\PhalApi\DI()->redis->type($key, $tablename);
```
- dbSize查看现在数据库有多少key
```
\PhalApi\DI()->redis->dbSize($tablename);
```
- move：转移一个key到另外一个数据库
```
\PhalApi\DI()->redis->move($key, $tablename);
```
- rename：给key重命名
```
\PhalApi\DI()->redis->rename($OLD_KEY_NAME, $NEW_KEY_NAME);
```
- renameNx：给key重命名如果重新命名的名字已经存在，不会替换成功
```
\PhalApi\DI()->redis->renameNx($OLD_KEY_NAME, $NEW_KEY_NAME);
```
- del：删除键值并根据名称自动切换库(对所有通用)
```
\PhalApi\DI()->redis->del($key);
```
- info：返回redis的版本信息等详情
```
\PhalApi\DI()->redis->info();
```
- ping：查看redis链接状态
```
\PhalApi\DI()->redis->ping();
```
- switchDB：切换DB
```
\PhalApi\DI()->redis->switchDB();
```
- flushDB：清空当前数据库
```
\PhalApi\DI()->redis->flushDB();
```
- flushAll：清空所有数据库
```
\PhalApi\DI()->redis->flushAll();
```
- slaveof：选择从服务器
```
\PhalApi\DI()->redis->slaveof ($host, $port);
```
- save：将数据同步保存到磁盘
```
\PhalApi\DI()->redis->save();
```
- bgsave：将数据异步保存到磁盘
```
\PhalApi\DI()->redis->bgsave();
```
- lastSave：返回上次成功将数据保存到磁盘的Unix时戳
```
\PhalApi\DI()->redis->lastSave();
```
- bgrewriteaof：使用aof来进行数据库持久化
```
\PhalApi\DI()->redis->bgrewriteaof();
```

xuepengdong / phalapiredis

Maintainers

Details