PHP的Laravel架構中的event事件操作的解析

這篇文章主要介紹了PHP的Laravel架構中的event事件操作,其中重點講解了Laravel 5.1之中新加入了事件廣播的功能,需要的朋友可以參考下

有時候當我們單純的看 Laravel 手冊的時候會有一些疑惑，比如說系統服務下的授權和事件，這些功能服務的應用情境是什麼，其實如果沒有經曆過一定的開發經驗有這些疑惑是很正常的事情，但是當我們在工作中多加思考會發現有時候這些服務其實我們一直都見過。下面就事件、事件監聽舉一個很簡單的例子你就會發現。

這個例子是關於文章的瀏覽數的實現，當使用者查看文章的時候文章的瀏覽數會增加1，使用者查看文章就是一個事件，有了事件，就需要一個事件監聽器，對監聽的事件發生後執行相應的操作（文章瀏覽數加1），其實這種監聽機制在 Laravel 中是通過觀察者模式實現的.

註冊事件以及監聽器
首先我們需要在 app/Providers/目錄下的EventServiceProvider.php中註冊事件監聽器映射關係，如下：

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

然後項目根目錄下執行如下命令

php artisan event:generate

該命令完成後，會分別自動在 app/Events和app/Listensers目錄下產生 BlogView.php和BlogViewListener.php檔案。

定義事件

<?phpnamespace 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 [];  }}

其實看到這些你會發現該事件類別只是注入了一個 Post執行個體罷了，並沒有包含多餘的邏輯。

定義監聽器
事件監聽器在handle方法中接收事件執行個體，event:generate命令將會自動在handle方法中匯入合適的事件類別和類型提示事件。在handle方法內，你可以執行任何需要的邏輯以響應事件，我們的代碼實現如下：

<?phpnamespace 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;     //先進行判斷是否已經查看過    if (!$this->hasViewedBlog($post)) {       //儲存到資料庫      $post->view_cache = $post->view_cache + 1;      $post->save();       //看過之後將儲存到 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());  }}

注釋中也已經說明了一些邏輯。

觸發事件
事件和事件監聽完成後，我們要做的就是實現整個監聽，即觸發使用者開啟文章事件在此我們使用和 Event提供的 fire方法，如下：

<?phpnamespace 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);  }}

現在開啟頁面探索資料庫中的`view_cache已經正常加1了，這樣整個就完成了。

事件廣播
簡介：
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}，說明廣播成功。

以上就是本文的全部內容，希望對大家的學習有所協助，更多相關內容請關注topic.alibabacloud.com！