PHP对redis常用的操作

<?php
class RedisModel extends Model
{
//REDIS服务主机IP
private $_HOST = null;

//redis服务端口
private $_PORT = null;

//连接时长 默认为0 不限制时长
private $_TIMEOUT = 0;

//数据库名
private $_DBNAME = null;

//连接类型 1普通连接 2长连接
private $_CTYPE = 1;

//实例名
public $_REDIS = null;

//事物对象
private $_TRANSCATION = null;

//初始化
public function __construct()
{
$this->_HOST = C('REDIS_HOST');
$this->_PORT = C('REDIS_PORT');
$this->_TIMEOUT = C('REDIS_TIMEOUT');
$this->_DBNAME = C('REDIS_DBNAME');
$this->_CTYPE = C('REDIS_CTYPE');

if (!isset($this->_REDIS)) {
$this->_REDIS = new Redis();
$this->connect($this->_HOST, $this->_PORT, $this->_TIMEOUT, $this->_DBNAME, $this->_CTYPE);
}
}

/**
* 连接redis服务器
*/
private function connect($host,$port,$timeout,$dbname,$type)
{
switch ($type) {
case 1:
$this->_REDIS->connect($host, $port, $timeout);
break;
case 2:
$this->_REDIS->pconnect($host, $port, $timeout);
break;
default:
break;
}
}

/**
* 查看redis连接是否断开
* @return $return bool true:连接未断开 false:连接已断开
*/
public function ping()
{
$return = null;

$return = $this->_REDIS->ping();

return 'PONG' ? true : false;
}

/**
* 设置redis模式参数
* @param $option array 参数数组键值对
* @return $return true/false
*/
public function setOption($option=array())
{
return $this->_REDIS->setOption();
}

/**
* 获取redis模式参数
* @param $option array 要获取的参数数组
*/
public function getOption($option=array())
{
return $this->_REDIS->getOption();
}

/**
* 写入key-value
* @param $key string 要存储的key名
* @param $value mixed 要存储的值
* @param $type int 写入方式 0:不添加到现有值后面 1:添加到现有值的后面 默认0
* @param $repeat int 0:不判断重复 1:判断重复
* @param $time float 过期时间(S)
* @param $old int 1:返回旧的value 默认0
* @return $return bool true:成功 flase:失败
*/
public function set($key,$value,$type=0,$repeat=0,$time=0,$old=0)
{
$return = null;

if ($type) {
$return = $this->_REDIS->append($key, $value);
} else {
if ($old) {
$return = $this->_REDIS->getSet($key, $value);
} else {
if ($repeat) {
$return = $this->_REDIS->setnx($key, $value);
} else {
if ($time && is_numeric($time)) $return = $this->_REDIS->setex($key, $time, $value);
else $return = $this->_REDIS->set($key, $value);
}
}
}

return $return;
}

/**
* 获取某个key值 如果指定了start end 则返回key值的start跟end之间的字符
* @param $key string/array 要获取的key或者key数组
* @param $start int 字符串开始index
* @param $end int 字符串结束index
* @return $return mixed 如果key存在则返回key值 如果不存在返回false
*/
public function get($key=null,$start=null,$end=null)
{
$return = null;

if (is_array($key) && !empty($key)) {
$return = $this->_REDIS->getMultiple($key);
} else {
if (isset($start) && isset($end)) $return = $this->_REDIS->getRange($key);
else $return = $this->_REDIS->get($key);
}

return $return;
}

/**
* 删除某个key值
* @param $key array key数组
* @return $return longint 删除成功的key的个数
*/
public function delete($key=array())
{
$return = null;

$return = $this->_REDIS->delete($key);

return $return;
}

/**
* 判断某个key是否存在
* @param $key string 要查询的key名
*/
public function exists($key)
{
$return = null;

$return = $this->_REDIS->exists($key);

return $return;
}

/**
* key值自增或者自减
* @param $key string key名
* @param $type int 0:自减 1:自增 默认为1
* @param $n int 自增步长 默认为1
*/
public function deinc($key,$type=1,$n=1)
{
$return = null;
$n = (int)$n;

switch ($type) {
case 0:
if ($n == 1) $return = $this->_REDIS->decr($key);
else if ($n > 1) $return = $this->_REDIS->decrBy($key, $n);
break;
case 1:
if ($n == 1) $return = $this->_REDIS->incr($key);
else if ($n > 1) $return = $this->_REDIS->incrBy($key, $n);
break;
default:
$return = false;
break;
}

return $return;
}

/**
* 同时给多个key赋值
* @param $data array key值数组 array('key0'=>'value0','key1'=>'value1')
*/
public function mset($data)
{
$return = null;

$return = $this->_REDIS->mset($data);

return $return;
}

/**
* 查询某个key的生存时间
* @param $key string 要查询的key名
*/
public function ttl($key)
{
$return = null;

$return = $this->_REDIS->ttl($key);

return $return;
}

/**
* 删除到期的key
* @param $key string key名
*/
public function persist($key)
{
$return = null;

$return = $this->_REDIS->persist($key);

return $return;
}

/**
* 获取某一key的value
* @param $key string key名
*/
public function strlen($key)
{
$return = null;

$return = $this->_REDIS->strlen($key);

return $return;
}

//+++-------------------------队列操作-------------------------+++//

/**
* 入队列
* @param $list string 队列名
* @param $value mixed 入队元素值
* @param $deriction int 0:数据入队列头(左) 1:数据入队列尾(右) 默认为0
* @param $repeat int 判断value是否存在  0:不判断存在 1:判断存在 如果value存在则不入队列
*/
public function listPush($list,$value,$direction=0,$repeat=0)
{
$return = null;

switch ($direction) {
case 0:
if ($repeat)
$return = $this->_REDIS->lPushx($list,$value);
else
$return = $this->_REDIS->lPush($list,$value);
break;
case 1:
if ($repeat)
$return = $this->_REDIS->rPushx($list,$value);
else
$return = $this->_REDIS->rPush($list,$value);
break;
default:
$return = false;
break;
}

return $return;
}

/**
* 出队列
* @param $list1 string 队列名
* @param $deriction int 0:数据入队列头(左) 1:数据入队列尾(右) 默认为0
* @param $list2 string 第二个队列名 默认null
* @param $timeout int timeout为0:只获取list1队列的数据
*        timeout>0:如果队列list1为空 则等待timeout秒 如果还是未获取到数据 则对list2队列执行pop操作
*/
public function listPop($list1,$deriction=0,$list2=null,$timeout=0)
{
$return = null;

switch ($direction) {
case 0:
if ($timeout && $list2)
$return = $this->_REDIS->blPop($list1,$list2,$timeout);
else
$return = $this->_REDIS->lPop($list1);
break;
case 1:
if ($timeout && $list2)
$return = $this->_REDIS->brPop($list1,$list2,$timeout);
else
$return = $this->_REDIS->rPop($list1);
break;
default:
$return = false;
break;
}

return $return;
}

/**
* 获取队列中元素数
* @param $list string 队列名
*/
public function listSize($list)
{
$return = null;

$return = $this->_REDIS->lSize($list);

return $return;
}

/**
* 为list队列的index位置的元素赋值
* @param $list string 队列名
* @param $index int 队列元素位置
* @param $value mixed 元素值
*/
public function listSet($list,$index=0,$value=null)
{
$return = null;

$return = $this->_REDIS->lSet($list, $index, $value);

return $return;
}

/**
* 获取list队列的index位置的元素值
* @param $list string 队列名
* @param $index int 队列元素开始位置 默认0
* @param $end int 队列元素结束位置 $index=0,$end=-1:返回队列所有元素
*/
public function listGet($list,$index=0,$end=null)
{
$return = null;

if ($end) {
$return = $this->_REDIS->lRange($list, $index, $end);
} else {
$return = $this->_REDIS->lGet($list, $index);
}

return $return;
}

/**
* 截取list队列，保留start至end之间的元素
* @param $list string 队列名
* @param $start int 开始位置
* @param $end int 结束位置
*/
public function listTrim($list,$start=0,$end=-1)
{
$return = null;

$return = $this->_REDIS->lTrim($list, $start, $end);

return $return;
}

/**
* 删除list队列中count个值为value的元素
* @param $list string 队列名
* @param $value int 元素值
* @param $count int 删除个数 0:删除所有 >0:从头部开始删除 <0:从尾部开始删除 默认为0删除所有
*/
public function listRemove($list,$value,$count=0)
{
$return = null;

$return = $this->_REDIS->lRem($list, $value, $count);

return $return;
}

/**
* 在list中值为$value1的元素前Redis::BEFORE或者后Redis::AFTER插入值为$value2的元素
* 如果list不存在，不会插入，如果$value1不存在，return -1
* @param $list string 队列名
* @param $location int 插入位置 0:之前 1:之后
* @param $value1 mixed 要查找的元素值
* @param $value2 mixed 要插入的元素值
*/
public function listInsert($list,$location=0,$value1,$value2)
{
$return = null;

switch ($location) {
case 0:
$return = $this->_REDIS->lInsert($list, Redis::BEFORE, $value1, $value2);
break;
case 1:
$return = $this->_REDIS->lInsert($list, Redis::AFTER, $value1, $value2);
break;
default:
$return = false;
break;
}

return $return;
}

/**
* pop出list1的尾部元素并将该元素push入list2的头部
* @param $list1 string 队列名
* @param $list2 string 队列名
*/
public function rpoplpush($list1, $list2)
{
$return = null;

$return = $this->_REDIS->rpoplpush($list1, $list2);

return $return;
}

//+++-------------------------集合操作-------------------------+++//

/**
* 将value写入set集合 如果value存在 不写入 返回false
* 如果是有序集合则根据score值更新该元素的顺序
* @param $set string 集合名
* @param $value mixed 值
* @param $stype int 集合类型 0:无序集合 1:有序集和 默认0
* @param $score int 元素排序值
*/
public function setAdd($set,$value=null,$stype=0,$score=null)
{
$return = null;

if ($stype && $score !== null) {
$return = $this->_REDIS->zAdd($set, $score, $value);
} else {
$return = $this->_REDIS->sAdd($set, $value);
}

return $return;
}

/**
* 移除set1中的value元素 如果指定了set2 则将该元素写入set2
* @param $set1 string 集合名
* @param $value mixed 值
* @param $stype int 集合类型 0:无序集合 1:有序集和 默认0
* @param $set2 string 集合名
*/
public function setMove($set1, $value=null, $stype=0, $set2=null)
{
$return = null;

if ($set2) {
$return = $this->_REDIS->sMove($set1, $set2, $value);
} else {
if ($stype) $return = $this->_REDIS->zRem($set1, $value);
else $return = $this->_REDIS->sRem($set1, $value);
}

return $return;
}

/**
* 查询set中是否有value元素
* @param $set string 集合名
* @param $value mixed 值
*/
public function setSearch($set, $value=null)
{
$return = null;

$return = $this->_REDIS->sIsMember($set, $value);

return $return;
}

/**
* 返回set中所有元素个数 有序集合要指定$stype=1
* 如果是有序集合并指定了$start和$end 则返回score在start跟end之间的元素个数
* @param $set string 集合名
* @param $stype int 集合类型 0:无序集合 1:有序集和 默认0
* @param $start int 开始index
* @param $end int 结束index
*/
public function setSize($set,$stype=0,$start=0,$end=0)
{
$return = null;

if ($stype) {
if ($start && $end) $return = $this->_REDIS->zCount($set, $start, $end);
else $return = $this->_REDIS->zSize($set);
} else {
$return = $this->_REDIS->sSize($set);
}

return $return;
}

/**
* 随机返回set中一个元素并可选是否删除该元素
* @param $set string 集合名
* @param $isdel int 是否删除该元素 0:不删除 1:删除 默认为0
*/
public function setPop($set,$isdel=0)
{
$return = null;

if ($isdel) {
$return = $this->_REDIS->sPop($set);
} else {
$return = $this->_REDIS->sRandMember($set);
}

return $return;
}

/**
* 求交集 并可选是否将交集保存到新集合
* @param $set array 集合名数组
* @param $newset string 要保存到的集合名 默认为null 即不保存交集到新集合
* @param $stype int 集合类型 0:无序集合 1:有序集和 默认0
* @param $weight array 权重 执行function操作时要指定的每个集合的相同元素所占的权重 默认1
* @param $function string 不同集合的相同元素的取值规则函数 SUM:取元素值的和 MAX:取最大值元素 MIN:取最小值元素
*/
public function setInter($set,$newset=null,$stype=0,$weight=array(1),$function='SUM')
{
$return = array();

if (is_array($set) && !empty($set)) {
if ($newset) {
if ($stype) $return = $this->_REDIS->zInter($newset, $set, $weight, $function);
else $return = $this->_REDIS->sInterStore($newset, $set);
} else {
$return = $this->_REDIS->sInter($set);
}
}

return $return;
}

/**
* 求并集 并可选是否将交集保存到新集合
* @param $set array 集合名数组
* @param $newset string 要保存到的集合名 默认为null 即不保存交集到新集合
* @param $stype int 集合类型 0:无序集合 1:有序集和 默认0
* @param $weight array 权重 执行function操作时要指定的每个集合的相同元素所占的权重 默认1
* @param $function string 不同集合的相同元素的取值规则函数 SUM:取元素值的和 MAX:取最大值元素 MIN:取最小值元素
*/
public function setUnion($set,$newset=null,$stype=0,$weight=array(1),$function='SUM')
{
$return = array();

if (is_array($set) && !empty($set)) {
if ($newset) {
if ($stype) $return = $this->_REDIS->zUnion($newset, $set, $weight, $function);
else $return = $this->_REDIS->sUnionStore($newset, $set);
} else {
$return = $this->_REDIS->sUnion($set);
}
}

return $return;
}

/**
* 求差集 并可选是否将交集保存到新集合
* @param $set array 集合名数组
* @param $newset string 要保存到的集合名 默认为null 即不保存交集到新集合
*/
public function setDiff($set,$newset=null)
{
$return = array();

if (is_array($set) && !empty($set)) {
if ($newset) {
$return = $this->_REDIS->sDiffStore($newset, $set);
} else {
$return = $this->_REDIS->sDiff($set);
}
}

return $return;
}

/**
* 返回set中所有元素
* @param $set string 集合名
*/
public function setMembers($set)
{
$return = null;

$return = $this->_REDIS->sMembers($set);

return $return;
}

/**
* 排序 分页等
* @param $set string 集合名
* @param $option array 选项
*/
public function setSort($set,$option)
{
$return = null;
$default_option = array(
'by'    => 'some_pattern_*', //要匹配的排序value值
'limit' => array(0, 1), //array(start,length)
'get'   => 'some_other_pattern_*', //多个匹配格式:array('some_other_pattern1_*','some_other_pattern2_*')
'sort'  => 'asc', // asc|desc 默认asc
'alpha' => TRUE, //
'store' => 'some_need_pattern_*' //永久性排序值
);

$option = array_merge($default_option, $option);

$return = $this->_REDIS->sort($set, $option);

return $return;
}

//+++-------------------------有序集合操作-------------------------+++//

/**
* ***只针对有序集合操作
* 返回set中index从start到end的所有元素
* @param $set string 集合名
* @param $start int 开始Index
* @param $end int 结束Index
* @param $order int 排序方式 0:从小到大排序 1:从大到小排序 默认0
* @param $score bool 元素排序值 false:返回数据不带score true:返回数据带score 默认false
*/
public function setRange($set,$start,$end,$order=0,$score=false)
{
$return = null;

if ($order) {
$return = $this->_REDIS->zRevRange($set, $start, $end, $score);
} else {
$return = $this->_REDIS->zRange($set, $start, $end, $score);
}

return $return;
}

/**
* ***只针对有序集合操作
* 删除set中score从start到end的所有元素
* @param $set string 集合名
* @param $start int 开始score
* @param $end int 结束score
*/
public function setDeleteRange($set,$start,$end)
{
$return = null;

$return = $this->_REDIS->zRemRangeByScore($set, $start, $end);

return $return;
}

/**
* ***只针对有序集合操作
* 获取set中某个元素的score
* 如果指定了inc参数 则给该元素的score增加inc值
* 如果没有该元素 则将该元素写入集合
* @param $set string 集合名
* @param $value mixed 元素值
* @param $inc int 要给score增加的数值 默认是null 不执行score增加操作
*/
public function setScore($set,$value,$inc=null)
{
$return = null;

if ($inc) {
$return = $this->_REDIS->zIncrBy($set, $inc, $value);
} else {
$return = $this->_REDIS->zScore($set, $value);
}

return $return;
}

//+++-------------------------哈希操作-------------------------+++//

/**
* 将key->value写入hash表中
* @param $hash string 哈希表名
* @param $data array 要写入的数据 array('key'=>'value')
*/
public function hashSet($hash,$data)
{
$return = null;

if (is_array($data) && !empty($data)) {
$return = $this->_REDIS->hMset($hash, $data);
}

return $return;
}

/**
* 获取hash表的数据
* @param $hash string 哈希表名
* @param $key mixed 表中要存储的key名 默认为null 返回所有key>value
* @param $type int 要获取的数据类型 0:返回所有key 1:返回所有value 2:返回所有key->value
*/
public function hashGet($hash,$key=array(),$type=0)
{
$return = null;

if ($key) {
if (is_array($key) && !empty($key))
$return = $this->_REDIS->hMGet($hash,$key);
else
$return = $this->_REDIS->hGet($hash,$key);
} else {
switch ($type) {
case 0:
$return = $this->_REDIS->hKeys($hash);
break;
case 1:
$return = $this->_REDIS->hVals($hash);
break;
case 2:
$return = $this->_REDIS->hGetAll($hash);
break;
default:
$return = false;
break;
}
}

return $return;
}

/**
* 获取hash表中元素个数
* @param $hash string 哈希表名
*/
public function hashLen($hash)
{
$return = null;

$return = $this->_REDIS->hLen($hash);

return $return;
}

/**
* 删除hash表中的key
* @param $hash string 哈希表名
* @param $key mixed 表中存储的key名
*/
public function hashDel($hash,$key)
{
$return = null;

$return = $this->_REDIS->hDel($hash,$key);

return $return;
}

/**
* 查询hash表中某个key是否存在
* @param $hash string 哈希表名
* @param $key mixed 表中存储的key名
*/
public function hashExists($hash,$key)
{
$return = null;

$return = $this->_REDIS->hExists($hash,$key);

return $return;
}

/**
* 自增hash表中某个key的值
* @param $hash string 哈希表名
* @param $key mixed 表中存储的key名
* @param $inc int 要增加的值
*/
public function hashInc($hash,$key,$inc)
{
$return = null;

$return = $this->_REDIS->hIncrBy($hash, $key, $inc);

return $return;
}

//+++-------------------------其他操作-------------------------+++//

/**
* 自增hash表中某个key的值
* @param $key string 哈希表名
* @param $time mixed 表中存储的key名
*/
public function setKeyExpire($key, $time)
{
$return = null;

$return = $this->_REDIS->setTimeout($key, $time);

return $return;
}

/**
* 获取满足给定pattern的所有key
* @param $key regexp key匹配表达式 模式:user* 匹配以user开始的key
*/
public function getKeys($key=null)
{
$return = null;

$return = $this->_REDIS->keys($key);

return $return;
}

/**
* 将数据保存到硬盘 同步/异步
* @param $type int 保存方式 0:同步 1:异步 默认0
* @param $time int 是否要获取上次成功将数据保存到磁盘的Unix时戳 0:不返回时间 1:返回时间
*/
public function hwSave($type=0,$time=0)
{
$return = null;

if ($type) {
$return = $this->_REDIS->bgsave();
} else {
$return = $this->_REDIS->save();
}
if ($time) {
$return = $this->_REDIS->lastSave();
}

return $return;
}

/**
* 获取上次成功将数据保存到磁盘的Unix时戳
*/
public function lastSave()
{
$return = null;

$return = $this->_REDIS->lastSave();

return $return;
}

/**
* 获取redis版本信息等详情
*/
public function info()
{
$return = null;

$return = $this->_REDIS->info();

return $return;
}

/**
* 获取数据库中key的数目
*/
public function dbSize()
{
$return = null;

$return = $this->_REDIS->dbSize();

return $return;
}

//+++-------------------------事务操作-------------------------+++//

/**
* 开始进入事务操作
* @param $return object 事务对象
*/
public function tranStart()
{
$this->_TRANSCATION = $this->_REDIS->multi();
}

/**
* 提交完成事务
* @param $return bool 事务执行成功 提交操作
*/
public function tranCommit()
{
return $this->_TRANSCATION->exec();
}

/**
* 回滚事务
* @param $return bool 事务执行失败 回滚操作
*/
public function tranRollback()
{
return $this->_TRANSCATION->discard();
}
}