首頁 >後端開發 >php教程 >php中Redis的應用訊息傳遞詳解

php中Redis的應用訊息傳遞詳解

墨辰丷
墨辰丷原創
2018-05-24 15:25:521439瀏覽

訊息傳遞這項應用廣泛存在於各個網站中,這個功能也是一個網站不可或缺的。本文主要介紹了php中Redis的應用--訊息傳遞。

閱讀目錄

1、摘要

2、實現方法

3、一對一訊息傳遞

4、多對多訊息傳遞

1、摘要

訊息傳遞這個應用廣泛存在於各個網站中,這個功能也是一個網站不可或缺的。常見的訊息應用程式有,新浪微博中的@我呀、給你評論然後的提示呀、讚贊贊提示、私信呀、甚至是發微博分享的新鮮事;知乎中的私信呀、live發送過來的訊息、知乎團隊訊息呀等等。

2、實作方法

訊息傳遞即兩個或多個客戶端在相互發送和接收訊息。

通常有兩種方法實作:

#第一種為訊息推送。 Redis內建有這種機制,publish往頻道推播訊息、subscribe訂閱頻道。這種方法有一個缺點就是必須保證接收者隨時在線(即是此時程式不能停下來,一直保持監控狀態,假若斷線後就會出現客戶端丟失信息)

第二種為訊息拉取。 所謂訊息拉取,就是客戶端自主去取得儲存在伺服器中的資料。 Redis內部並沒有實作訊息拉取這種機制。因此我們需要自己手動編寫程式碼去實現這個功能。

在這裡我們,我們進一步將訊息傳遞再細分為一對一的訊息傳遞,多對多的訊息傳遞(群組訊息傳遞)。

【註:兩個類別的程式碼相對較多,因此將其折疊起來了】

#3、一對一訊息傳遞

範例1:一對一訊息發送與取得

模組要求:

1、提示有多少個聯絡人發來新訊息

2、訊息包含傳送人、時間、訊息內容

3、能夠取得先前的舊訊息

4、且訊息能夠維持7天,過期將會被動觸發刪除

Redis實作想法:

#1、新訊息與舊訊息分別採用兩個鍊錶來儲存

2 、原始訊息的結構採用陣列的形式存放,並且含有發送人、時間戳、訊息內容

3、在推入redis的鍊錶前,需要將資料轉換為json類型然後再進行儲存

4、在取出新資訊時應該使用rpoplpush來實現,將已讀的新訊息推入舊訊息鍊錶中

5、取出舊訊息時,應該用舊訊息的時間與現在的時間進行對比,若逾時,則直接刪除後面的全部資料(因為資料是按時間一個一個壓進鍊錶中的,所以對於時間是有序排列的)

資料儲存結構圖:

PHP的實作程式碼:

##SinglePullMessage.class.php

<?php
#单接接收者接收消息
class SinglePullMessage
{
 private $redis=&#39;&#39;; #存储redis对象
 /**
 * @desc 构造函数
 * 
 * @param $host string | redis主机
 * @param $port int | 端口
 */
 public function __construct($host,$port=6379)
 {
 $this->redis=new Redis();
 $this->redis->connect($host,$port);
 } 
 /**
 * @desc 发送消息(一个人)
 * 
 * @param $toUser string | 接收人
 * @param $messageArr array | 发送的消息数组,包含sender、message、time 
 *
 * @return bool
 */
 public function sendSingle($toUser,$messageArr)
 {
 $json_message=json_encode($messageArr); #编码成json数据
 return $this->redis->lpush($toUser,$json_message); #将数据推入链表 
 }
 /**
 * @desc 用户获取新消息
 *
 * @param $user string | 用户名
 *
 * @return array 返回数组,包含多少个用户发来新消息,以及具体消息
 */
 public function getNewMessage($user)
 {
 #接收新信息数据,并且将数据推入旧信息数据链表中,并且在原链表中删除
 $messageArr=array();
 while($json_message=$this->redis->rpoplpush($user, &#39;preMessage_&#39;.$user))
 {
  $temp=json_decode($json_message); #将json数据变成对象
  $messageArr[$temp->sender][]=$temp; #转换成数组信息
 }
 if($messageArr)
 {
  $arr[&#39;count&#39;]=count($messageArr); #统计有多少个用户发来信息
  $arr[&#39;messageArr&#39;]=$messageArr;
  return $arr;
 }
 return false;
 }
 public function getPreMessage($user)
 {
 ##取出旧消息
 $messageArr=array();
 $json_pre=$this->redis->lrange(&#39;preMessage_&#39;.$user, 0, -1); #一次性将全部旧消息取出来
 foreach ($json_pre as $k => $v) 
 {
  $temp=json_decode($v);  #json反编码
  $timeout=$temp->time+60*60*24*7; #数据过期时间 七天过期
  if($timeout<time())  #判断数据是否过期
  {
  if($k==0)   #若是最迟插入的数据都过期了,则将所有数据删除
  {
   $this->redis->del(&#39;preMessage_&#39;.$user);
   break;
  }
  $this->redis->ltrim(&#39;preMessage_&#39;.$user, 0, $k); #若检测出有过期的,则将比它之前插入的所有数据删除
  break;
  }
  $messageArr[$temp->sender][]=$temp;
 }
 return $messageArr;
 }
 /**
 * @desc 消息处理,没什么特别的作用。在这里这是用来处理数组信息,然后将其输出。 
 *
 * @param $arr array | 需要处理的信息数组
 *
 * @return 返回打印输出
 */
 public function dealArr($arr)
 {
 foreach ($arr as $k => $v) 
 {
  foreach ($v as $k1 => $v2) 
  {
  echo &#39;发送人:&#39;.$v2->sender.&#39; 发送时间:&#39;.date(&#39;Y-m-d h:i:s&#39;,$v2->time).&#39;<br/>&#39;;
  echo &#39;消息内容:&#39;.$v2->message.&#39;<br/>&#39;;
  }
  echo "<hr/>";
 }
 }
}

測試:

1、發送訊息

建立test1.php

include &#39;./SinglePullMessage.class.php&#39;;
$object=new SinglePullMessage(&#39;192.168.95.11&#39;);
#发送消息
$sender=&#39;boss&#39;; #发送者
$to=&#39;jane&#39;;  #接收者
$message=&#39;How are you&#39;; #信息
$time=time();
$arr=array(&#39;sender&#39;=>$sender,&#39;message&#39;=>$message,&#39;time&#39;=>$time);
echo $object->sendSingle($to,$arr);

2、取得新訊息

#建立test2.php

include &#39;./SinglePullMessage.class.php&#39;;
$object=new SinglePullMessage(&#39;192.168.95.11&#39;);
#获取新消息
$arr=$object->getNewMessage(&#39;jane&#39;);
if($arr)
{
 echo $arr[&#39;count&#39;]."个联系人发来新消息<br/><hr/>";
 $object->dealArr($arr[&#39;messageArr&#39;]); 
}
else
 echo "无新消息";

存取結果:

#3、取得舊訊息

#建立test3.php

include &#39;./SinglePullMessage.class.php&#39;;
$object=new SinglePullMessage(&#39;192.168.95.11&#39;);
#获取旧消息
$arr=$object->getPreMessage(&#39;jane&#39;);
if($arr)
{
 $object->dealArr($arr);
}
else
 echo "无旧数据";

#4、多對多訊息傳遞

範例2:多對多訊息發送與取得(即是群組)

#模組需求:

1、使用者能夠自行建立群組,並成為群組主

2、群組可以拉人進來當群組成員、並且可以踢人

3、使用者可以直接退出群組

4、可以傳送訊息,每位成員都可以拉取訊息

5、群組的訊息最大容納量為5000條

6、成員可以拉取新訊息,並提示有多少新訊息

7、成員可以分頁取得先前已讀的舊訊息

。 。 。 。 。功能就寫這幾個吧,有需要或想練習的同學可以增加其他功能,例如禁言、匿名訊息發送、文件發送等等。

Redis實作想法:

1、群组的消息以及群组的成员组成采用有序集合进行存储。群组消息有序集合的member存储用户发送的json数据消息,score存储唯一值,将采用原子操作incr获取string中的自增长值进行存储;群组成员有序集合的member存储user,score存储非零数字(在这里这个score意义不大,我的例子代码中使用数字1为群主的score,其他的存储为2。当然这使用这个数据还可以扩展别的功能,例如群组中成员等级)可参考下面数据存储结构简图。

2、用户所加入的群组也是采用有序集合进行存储。其中,member存储群组ID,score存储用户已经获取该群组的最大消息分值(对应群组消息的score值)

3、用户创建群组的时候,通过原子操作incr从而获取一个唯一ID

4、用户在群中发送消息时,也是通过原子操作incr获取一个唯一自增长有序ID

5、在执行incr时,为防止并发导致竞争关系,因此需要进行加锁操作【redis详细锁的讲解可以参考:Redis构建分布式锁http://www.jb51.net/article/109704.htm】

6、创建群组方法简要思路,任何一个用户都可以创建群组聊天,在创建的同时,可以选择时是否添加群组成员(参数通过数组的形式)。创建过程将会为这个群组建立一个群组成员有序集合(群组信息有序集合暂时不创建),接着将群主添加进去,再将群ID添加用户所参加的群组有序集合中。

数据存储结构图:

PHP的代码实现:

#ManyPullMessage.class.php

<?php
class ManyPullMessage
{
 private $redis=&#39;&#39;; #存储redis对象
 /**
 * @desc 构造函数
 * 
 * @param $host string | redis主机
 * @param $port int | 端口
 */
 public function __construct($host,$port=6379)
 {
 $this->redis=new Redis();
 $this->redis->connect($host,$port);
 } 
 /**
 * @desc 用于创建群组的方法,在创建的同时还可以拉人进群组
 * 
 * @param $user string | 用户名,创建群组的主人
 * @param $addUser array | 其他用户构成的数组
 *
 * @param $lockName string | 锁的名字,用于获取群组ID的时候用
 * @return int 返回群组ID
 */
 public function createGroupChat($user, $addUser=array(), $lockName=&#39;chatIdLock&#39;)
 {
 $identifier=$this->getLock($lockName); #获取锁
 if($identifier)
 {
  $id=$this->redis->incr(&#39;groupChatID&#39;); #获取群组ID
  $this->releaseLock($lockName,$identifier); #释放锁
 }
 else
  return false;
 $messageCount=$this->redis->set(&#39;countMessage_&#39;.$id, 0); #初始化这个群组消息计数器
 #开启非事务型流水线,一次性将所有redis命令传给redis,减少与redis的连接
 $pipe=$this->redis->pipeline(); 
 $this->redis->zadd(&#39;groupChat_&#39;.$id, 1, $user); #创建群组成员有序集合,并添加群主
 #将这个群组添加到user所参加的群组有序集合中
 $this->redis->zadd(&#39;hasGroupChat_&#39;.$user, 0, $id); 
 foreach ($addUser as $v) #创建群组的同时需要添加的用户成员
 {
  $this->redis->zadd(&#39;groupChat_&#39;.$id, 2, $v);
  $this->redis->zadd(&#39;hasGroupChat_&#39;.$v, 0, $id);
 }
 $pipe->exec();
 return $id; #返回群组ID
 }
 /**
 * @desc 群主主动拉人进群
 *
 * @param $user string | 群主名
 * @param $groupChatID int | 群组ID
 * @param $addMembers array | 需要拉进群的用户
 *
 * @return bool
 */
 public function addMembers($user, $groupChatID, $addMembers=array())
 {
 $groupMasterScore=$this->redis->zscore(&#39;groupChat_&#39;.$groupChatID, $user); #将groupChatName的群主取出来
 if($groupMasterScore==1) #判断user是否是群主
 {
  $pipe=$this->redis->pipeline(); #开启非事务流水线
  foreach ($addMembers as $v) 
  {
  $this->redis->zadd(&#39;groupChat_&#39;.$groupChatID, 2, $v);   #添加进群
  $this->redis->zadd(&#39;hasGroupChat_&#39;.$v, 0, $groupChatID); #添加群名到用户的有序集合中
  }
  $pipe->exec();
  return true;
 }
 return false;
 }
 /**
 * @desc 群主删除成员
 *
 * @param $user string | 群主名
 * @param $groupChatID int | 群组ID
 * @param $delMembers array | 需要删除的成员名字
 *
 * @return bool
 */
 public function delMembers($user, $groupChatID, $delMembers=array())
 {
 $groupMasterScore=$this->redis->zscore(&#39;groupChat_&#39;.$groupChatID, $user); 
 if($groupMasterScore==1) #判断user是否是群主
 {
  $pipe=$this->redis->pipeline(); #开启非事务流水线
  foreach ($delMembers as $v) 
  {
  $this->redis->zrem(&#39;groupChat_&#39;.$groupChatID, $v);   
  $this->redis->zrem(&#39;hasGroupChat_&#39;.$v, $groupChatID); 
  }
  $pipe->exec();
  return true;
 }
 return false;
 }
 /**
 * @desc 退出群组
 *
 * @param $user string | 用户名
 * @param $groupChatID int | 群组名
 */
 public function quitGroupChat($user, $groupChatID)
 {
 $this->redis->zrem(&#39;groupChat_&#39;.$groupChatID, $user);
 $this->redis->zrem(&#39;hasGroupChat_&#39;.$user, $groupChatID);
 return true;
 }
 /**
 * @desc 发送消息
 *
 * @param $user string | 用户名
 * @param $groupChatID int | 群组ID
 * @param $messageArr array | 包含发送消息的数组
 * @param $preLockName string | 群消息锁前缀,群消息锁全名为countLock_群ID
 *
 * @return bool
 */
 public function sendMessage($user, $groupChatID, $messageArr, $preLockName=&#39;countLock_&#39;)
 {
 $memberScore=$this->redis->zscore(&#39;groupChat_&#39;.$groupChatID, $user); #成员score
 if($memberScore)
 {
  $identifier=$this->getLock($preLockName.$groupChatID); #获取锁
  if($identifier) #判断获取锁是否成功
  {
  $messageCount=$this->redis->incr(&#39;countMessage_&#39;.$groupChatID);
  $this->releaseLock($preLockName.$groupChatID,$identifier); #释放锁
  }
  else
  return false;
  $json_message=json_encode($messageArr);
  $this->redis->zadd(&#39;groupChatMessage_&#39;.$groupChatID, $messageCount, $json_message);
  $count=$this->redis->zcard(&#39;groupChatMessage_&#39;.$groupChatID); #查看信息量大小
  if($count>5000) #判断数据量有没有达到5000条
  { #数据量超5000,则需要清除旧数据
  $start=5000-$count;
  $this->redis->zremrangebyrank(&#39;groupChatMessage_&#39;.$groupChatID, $start, $count);
  }
  return true;
 }
 return false;
 }
 /**
 * @desc 获取新信息
 *
 * @param $user string | 用户名
 *
 * @return 成功则放回json数据数组,无新信息返回false
 */
 public function getNewMessage($user)
 {
 $arrID=$this->redis->zrange(&#39;hasGroupChat_&#39;.$user, 0, -1, &#39;withscores&#39;); #获取用户拥有的群组ID
 $json_message=array(); #初始化
 foreach ($arrID as $k => $v) #遍历循环所有群组,查看是否有新消息
 {
  $messageCount=$this->redis->get(&#39;countMessage_&#39;.$k); #群组最大信息分值数
  if($messageCount>$v) #判断用户是否存在未读新消息
  {
  $json_message[$k][&#39;message&#39;]=$this->redis->zrangebyscore(&#39;groupChatMessage_&#39;.$k, $v+1, $messageCount);
  $json_message[$k][&#39;count&#39;]=count($json_message[$k][&#39;message&#39;]); #统计新消息数量
  $this->redis->zadd(&#39;hasGroupChat_&#39;.$user, $messageCount, $k); #更新已获取消息
  } 
 }
 if($json_message)
  return $json_message;
 return false;
 }
 /**
 * @desc 分页获取群组信息
 *
 * @param $user string | 用户名 
 * @param $groupChatID int | 群组ID
 * @param $page int | 第几页
 * @param $size int | 每页多少条数据
 *
 * @return 成功返回json数据,失败返回false
 */
 public function getPartMessage($user, $groupChatID, $page=1, $size=10)
 {
 $start=$page*$size-$size; #开始截取数据位置
 $stop=$page*$size-1; #结束截取数据位置
 $json_message=$this->redis->zrevrange(&#39;groupChatMessage_&#39;.$groupChatID, $start, $stop);
 if($json_message)
  return $json_message;
 return false;
 }
 /**
 * @desc 加锁方法
 *
 * @param $lockName string | 锁的名字
 * @param $timeout int | 锁的过期时间
 *
 * @return 成功返回identifier/失败返回false
 */
 public function getLock($lockName, $timeout=2)
 {
 $identifier=uniqid(); #获取唯一标识符
 $timeout=ceil($timeout); #确保是整数
 $end=time()+$timeout;
 while(time()<$end)  #循环获取锁
 {
  /*
  #这里的set操作可以等同于下面那个if操作,并且可以减少一次与redis通讯
  if($this->redis->set($lockName, $identifier array(&#39;nx&#39;, &#39;ex&#39;=>$timeout)))
  return $identifier;
  */
  if($this->redis->setnx($lockName, $identifier)) #查看$lockName是否被上锁
  {
  $this->redis->expire($lockName, $timeout); #为$lockName设置过期时间
  return $identifier;    #返回一维标识符
  }
  elseif ($this->redis->ttl($lockName)===-1) 
  {
  $this->redis->expire($lockName, $timeout); #检测是否有设置过期时间,没有则加上
  }
  usleep(0.001);  #停止0.001ms
 }
 return false;
 }
 /**
 * @desc 释放锁
 *
 * @param $lockName string | 锁名
 * @param $identifier string | 锁的唯一值
 *
 * @param bool
 */
 public function releaseLock($lockName,$identifier)
 {
 if($this->redis->get($lockName)==$identifier) #判断是锁有没有被其他客户端修改
 { 
  $this->redis->multi();
  $this->redis->del($lockName); #释放锁
  $this->redis->exec();
  return true;
 }
 else
 {
  return false; #其他客户端修改了锁,不能删除别人的锁
 }
 }

}
?>

测试:

1、建立createGroupChat.php(测试创建群组功能)

执行代码并创建568、569群组(群主为jack)

include &#39;./ManyPullMessage.class.php&#39;;
$object=new ManyPullMessage(&#39;192.168.95.11&#39;);
#创建群组
$user=&#39;jack&#39;;
$arr=array(&#39;jane1&#39;,&#39;jane2&#39;);
$a=$object->createGroupChat($user,$arr);
echo "<pre class="brush:php;toolbar:false">";
print_r($a);
echo "
";die;

2、建立addMembers.php(测试添加成员功能)

执行代码并添加新成员

 include &#39;./ManyPullMessage.class.php&#39;;
 $object=new ManyPullMessage(&#39;192.168.95.11&#39;);
 $b=$object->addMembers(&#39;jack&#39;,&#39;568&#39;,array(&#39;jane1&#39;,&#39;jane2&#39;,&#39;jane3&#39;,&#39;jane4&#39;));
 echo "<pre class="brush:php;toolbar:false">";
 print_r($b);
 echo "
";die;

3、建立delete.php(测试群主删除成员功能)

include &#39;./ManyPullMessage.class.php&#39;;
$object=new ManyPullMessage(&#39;192.168.95.11&#39;);
#群主删除成员
$c=$object->delMembers(&#39;jack&#39;, &#39;568&#39;, array(&#39;jane1&#39;,&#39;jane4&#39;));
echo "<pre class="brush:php;toolbar:false">";
print_r($c);
echo "
";die;

4、建立sendMessage.php(测试发送消息功能)

多执行几遍,568、569都发几条

include &#39;./ManyPullMessage.class.php&#39;;
$object=new ManyPullMessage(&#39;192.168.95.11&#39;);
#发送消息
$user=&#39;jane2&#39;;
$message=&#39;go go go&#39;;
$groupChatID=568;
$arr=array(&#39;sender&#39;=>$user, &#39;message&#39;=>$message, &#39;time&#39;=>time());
$d=$object->sendMessage($user,$groupChatID,$arr);
echo "<pre class="brush:php;toolbar:false">";
print_r($d);
echo "
";die;

5、建立getNewMessage.php(测试用户获取新消息功能)

include &#39;./ManyPullMessage.class.php&#39;;
$object=new ManyPullMessage(&#39;192.168.95.11&#39;);
#用户获取新消息
$e=$object->getNewMessage(&#39;jane2&#39;);
echo "<pre class="brush:php;toolbar:false">";
print_r($e);
echo "
";die;

6、建立getPartMessage.php(测试用户获取某个群组部分消息)

(多发送几条消息,用于测试。568中共18条数据)

include &#39;./ManyPullMessage.class.php&#39;;
$object=new ManyPullMessage(&#39;192.168.95.11&#39;);
#用户获取某个群组部分消息
$f=$object->getPartMessage(&#39;jane2&#39;, 568, 1, 10); 
echo "<pre class="brush:php;toolbar:false">";
print_r($f);
echo "
";die;

page=1,size=10

page=2,size=10

测试完毕,还需要别的功能可以自己进行修改添加测试。

以上就是本文的全部内容,希望对大家的学习有所帮助。


相关推荐:

PHP基于Redis消息队列发布微博的方法详解

PHPSession入库/存入redis的方法详解

PHP實作電商訂單自動確認收貨redis佇列的方法

以上是php中Redis的應用訊息傳遞詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn