Laravel5.1 事件廣播(Event Broadcasting)

事件廣播

簡介

Laravel 5.1 之中新加入了事件廣播的功能，做用是把服務器中觸發的事件經過websocket服務通知客戶端，也就是瀏覽器，客戶端js根據接受到的事件，作出相應動做。本文會用簡單的代碼展現一個事件廣播的過程。

依賴

• redis
• nodejs, socket.io
• laravel 5.1

配置

config/broadcasting.php中，以下配置'default' => env('BROADCAST_DRIVER', 'redis'),，使用redis做爲php和js的通訊方式。
config/database.php中配置redis的鏈接。

定義一個被廣播的事件

根據Laravel文檔的說明，想讓事件被廣播，必須讓Event類實現一個Illuminate\Contracts\Broadcasting\ShouldBroadcast接口，而且實現一個方法broadcastOn。broadcastOn返回一個數組，包含了事件發送到的channel(頻道)。以下：

namespace App\Events;

use App\Events\Event;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;

class SomeEvent extends Event implements ShouldBroadcast
{
    use SerializesModels;

    public $user_id;

    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct($user_id)
    {
        $this->user_id = $user_id;
    }

    /**
     * Get the channels the event should be broadcast on.
     *
     * @return array
     */
    public function broadcastOn()
    {
        return ['test-channel'];
    }
}

被廣播的數據

默認狀況下，Event中的全部public屬性都會被序列化後廣播。上面的例子中就是$user_id這個屬性。你也可使用broadcastWith這個方法，明確的指出要廣播什麼數據。例如：

public function broadcastWith()
{
    return ['user_id' => $this->user_id];
}

Redis和Websocket服務器

• 須要啓動一個Redis，事件廣播主要依賴的就是redis的sub/pub功能，具體能夠看redis文檔

• 須要啓動一個websocket服務器來和client通訊，建議使用socket.io，代碼以下:

  var app = require('http').createServer(handler);
  var io = require('socket.io')(app);
  
  var Redis = require('ioredis');
  var redis = new Redis('6379', '192.168.1.106');
  
  app.listen(6001, function() {
      console.log('Server is running!');
  });
  
  function handler(req, res) {
      res.writeHead(200);
      res.end('');
  }
  
  io.on('connection', function(socket) {
      console.log('connected');
  });
  
  redis.psubscribe('*', function(err, count) {
      console.log(count);
  });
  
  redis.on('pmessage', function(subscribed, channel, message) {
      console.log(subscribed);
      console.log(channel);
      console.log(message);
  
      message = JSON.parse(message);
      io.emit(channel + ':' + message.event, message.data);
  });

這裏須要注意的是redis.on方法的定義,接收到消息後，給client發送一個事件，事件名稱爲channel + ':' + message.event。

客戶端代碼

客戶端咱們也使用socket.io，做爲測試，代碼儘可能簡化，僅僅打印一個接受到的數據便可。以下：

var socket = io('http://localhost:6001');
socket.on('connection', function (data) {
    console.log(data);
});
socket.on('test-channel:App\\Events\\SomeEvent', function(message){
    console.log(message);
});
console.log(socket);

服務器觸發事件

直接在router中定義個事件觸發便可。以下：

Route::get('/event', function(){
    Event::fire(new \App\Events\SomeEvent(3));
    return "hello world";
});

測試

• 啓動redis
• 啓動websocket
• 打開帶有客戶端代碼的頁面，能夠看到websocket已經鏈接成功。
• 觸發事件,打開另外一個頁面 localhost/event。

這時就能夠發現，第一個頁面的console中打印出了Object{user_id: 3}，說明廣播成功。

我錄了一個教學視頻，你們若有不明白能夠參考這個視頻。