如何使用Laravel框架中的event事件

這篇文章給大家介紹如何使用Laravel框架中的event事件，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對(duì)大家能有所幫助。

注冊(cè)事件以及監(jiān)聽(tīng)器

首先我們需要在 app/Providers/目錄下的EventServiceProvider.php中注冊(cè)事件監(jiān)聽(tīng)器映射關(guān)系，如下：

protected $listen = [
    'App\Events\BlogView' => [
      'App\Listeners\BlogViewListener',
    ],
  ];

然后項(xiàng)目根目錄下執(zhí)行如下命令

php artisan event:generate

該命令完成后，會(huì)分別自動(dòng)在 app/Events和app/Listensers目錄下生成 BlogView.php和BlogViewListener.php文件。

定義事件

<?php

namespace App\Events;

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

class BlogView extends Event
{
  use SerializesModels;

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

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

其實(shí)看到這些你會(huì)發(fā)現(xiàn)該事件類(lèi)只是注入了一個(gè) Post實(shí)例罷了，并沒(méi)有包含多余的邏輯。

定義監(jiān)聽(tīng)器
事件監(jiān)聽(tīng)器在handle方法中接收事件實(shí)例，event:generate命令將會(huì)自動(dòng)在handle方法中導(dǎo)入合適的事件類(lèi)和類(lèi)型提示事件。在handle方法內(nèi)，你可以執(zhí)行任何需要的邏輯以響應(yīng)事件，我們的代碼實(shí)現(xiàn)如下：

<?php

namespace App\Listeners;

use App\Events\BlogView;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Session\Store;

class BlogViewListener
{
  protected $session;
  /**
   * Create the event listener.
   *
   * @return void
   */
  public function __construct(Store $session)
  {
    $this->session = $session;
  }

  /**
   * Handle the event.
   *
   * @param BlogView $event
   * @return void
   */
  public function handle(BlogView $event)
  {
    $post = $event->post;
     //先進(jìn)行判斷是否已經(jīng)查看過(guò)
    if (!$this->hasViewedBlog($post)) {
       //保存到數(shù)據(jù)庫(kù)
      $post->view_cache = $post->view_cache + 1;
      $post->save();
       //看過(guò)之后將保存到 Session 
      $this->storeViewedBlog($post);
    }
  }

  protected function hasViewedBlog($post)
  {
    return array_key_exists($post->id, $this->getViewedBlogs());
  }

  protected function getViewedBlogs()
  {
    return $this->session->get('viewed_Blogs', []);
  }

  protected function storeViewedBlog($post)
  {
    $key = 'viewed_Blogs.'.$post->id;

    $this->session->put($key, time());
  }

}

注釋中也已經(jīng)說(shuō)明了一些邏輯。

觸發(fā)事件
事件和事件監(jiān)聽(tīng)完成后，我們要做的就是實(shí)現(xiàn)整個(gè)監(jiān)聽(tīng)，即觸發(fā)用戶打開(kāi)文章事件在此我們使用和 Event提供的 fire方法，如下：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Post;
use Illuminate\Support\Facades\Event;
use App\Http\Requests;
use App\Events\BlogView;
use App\Http\Controllers\Controller;

class BlogController extends Controller
{
  
  public function showPost($slug)
  {
    $post = Post::whereSlug($slug)->firstOrFail();
    Event::fire(new BlogView($post));
    return view('home.blog.content')->withPost($post);
  }

}

現(xiàn)在打開(kāi)頁(yè)面發(fā)現(xiàn)數(shù)據(jù)庫(kù)中的`view_cache已經(jīng)正常加1了，這樣整個(gè)就完成了。

事件廣播
簡(jiǎn)介：
Laravel 5.1 之中新加入了事件廣播的功能，作用是把服務(wù)器中觸發(fā)的事件通過(guò)websocket服務(wù)通知客戶端，也就是瀏覽器，客戶端js根據(jù)接受到的事件，做出相應(yīng)動(dòng)作。本文會(huì)用簡(jiǎn)單的代碼展示一個(gè)事件廣播的過(guò)程。

依賴：

• redis

• nodejs, socket.io

• laravel 5.1

配置：

• config/broadcasting.php中，如下配置'default' => env('BROADCAST_DRIVER', 'redis'),，使用redis作為php和js的通信方式。

• config/database.php中配置redis的連接。

定義一個(gè)被廣播的事件：
根據(jù)Laravel文檔的說(shuō)明，想讓事件被廣播，必須讓Event類(lèi)實(shí)現(xiàn)一個(gè)Illuminate\Contracts\Broadcasting\ShouldBroadcast接口，并且實(shí)現(xiàn)一個(gè)方法broadcastOn。broadcastOn返回一個(gè)數(shù)組，包含了事件發(fā)送到的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'];
  }
}

被廣播的數(shù)據(jù)：
默認(rèn)情況下，Event中的所有public屬性都會(huì)被序列化后廣播。上面的例子中就是$user_id這個(gè)屬性。你也可以使用broadcastWith這個(gè)方法，明確的指出要廣播什么數(shù)據(jù)。例如：

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

Redis和Websocket服務(wù)器：
需要啟動(dòng)一個(gè)Redis，事件廣播主要依賴的就是redis的sub/pub功能，具體可以看redis文檔
需要啟動(dòng)一個(gè)websocket服務(wù)器來(lái)和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發(fā)送一個(gè)事件，事件名稱為channel + ':' + message.event。

客戶端代碼：
客戶端我們也使用socket.io，作為測(cè)試，代碼盡量簡(jiǎn)化，僅僅打印一個(gè)接受到的數(shù)據(jù)即可。如下：

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

服務(wù)器觸發(fā)事件：
直接在router中定義個(gè)事件觸發(fā)即可。如下：

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

測(cè)試：

• 啟動(dòng)redis

• 啟動(dòng)websocket

• 打開(kāi)帶有客戶端代碼的頁(yè)面，可以看到websocket已經(jīng)連接成功。

• 觸發(fā)事件,打開(kāi)另一個(gè)頁(yè)面 localhost/event。

這時(shí)就可以發(fā)現(xiàn)，第一個(gè)頁(yè)面的console中打印出了Object{user_id: 3}，說(shuō)明廣播成功。

關(guān)于如何使用Laravel框架中的event事件就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。