深入解析PHP的Laravel框架中的event事件操作
有時(shí)候當(dāng)我們單純的看 Laravel 手冊(cè)的時(shí)候會(huì)有一些疑惑,比如說系統(tǒng)服務(wù)下的授權(quán)和事件,這些功能服務(wù)的應(yīng)用場(chǎng)景是什么,其實(shí)如果沒有經(jīng)歷過一定的開發(fā)經(jīng)驗(yàn)有這些疑惑是很正常的事情,但是當(dāng)我們?cè)诠ぷ髦卸嗉铀伎紩?huì)發(fā)現(xiàn)有時(shí)候這些服務(wù)其實(shí)我們一直都見過。下面就事件、事件監(jiān)聽舉一個(gè)很簡(jiǎn)單的例子你就會(huì)發(fā)現(xiàn)。
這個(gè)例子是關(guān)于文章的瀏覽數(shù)的實(shí)現(xiàn),當(dāng)用戶查看文章的時(shí)候文章的瀏覽數(shù)會(huì)增加1,用戶查看文章就是一個(gè)事件,有了事件,就需要一個(gè)事件監(jiān)聽器,對(duì)監(jiān)聽的事件發(fā)生后執(zhí)行相應(yīng)的操作(文章瀏覽數(shù)加1),其實(shí)這種監(jiān)聽機(jī)制在 Laravel 中是通過觀察者模式實(shí)現(xiàn)的.
注冊(cè)事件以及監(jiān)聽器
首先我們需要在 app/Providers/目錄下的EventServiceProvider.php中注冊(cè)事件監(jiān)聽器映射關(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)該事件類只是注入了一個(gè) Post實(shí)例罷了,并沒有包含多余的邏輯。
定義監(jiān)聽器
事件監(jiān)聽器在handle方法中接收事件實(shí)例,event:generate命令將會(huì)自動(dòng)在handle方法中導(dǎo)入合適的事件類和類型提示事件。在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)查看過 if (!$this->hasViewedBlog($post)) { //保存到數(shù)據(jù)庫(kù) $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()); } }
注釋中也已經(jīng)說明了一些邏輯。
觸發(fā)事件
事件和事件監(jiān)聽完成后,我們要做的就是實(shí)現(xiàn)整個(gè)監(jiān)聽,即觸發(fā)用戶打開文章事件在此我們使用和 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)在打開頁(yè)面發(fā)現(xiàn)數(shù)據(jù)庫(kù)中的`view_cache已經(jīng)正常加1了,這樣整個(gè)就完成了。
事件廣播
簡(jiǎn)介:
Laravel 5.1 之中新加入了事件廣播的功能,作用是把服務(wù)器中觸發(fā)的事件通過websocket服務(wù)通知客戶端,也就是瀏覽器,客戶端js根據(jù)接受到的事件,做出相應(yīng)動(dòng)作。本文會(huì)用簡(jiǎn)單的代碼展示一個(gè)事件廣播的過程。
依賴:
- 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文檔的說明,想讓事件被廣播,必須讓Event類實(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ù)器來和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
- 打開帶有客戶端代碼的頁(yè)面,可以看到websocket已經(jīng)連接成功。
- 觸發(fā)事件,打開另一個(gè)頁(yè)面 localhost/event。
這時(shí)就可以發(fā)現(xiàn),第一個(gè)頁(yè)面的console中打印出了Object{user_id: 3},說明廣播成功。
相關(guān)文章
解決PHP4.0 和 PHP5.0類構(gòu)造函數(shù)的兼容問題
以下是對(duì)解決PHP4.0和PHP5.0類構(gòu)造函數(shù)兼容問題的方法進(jìn)行了詳細(xì)的分析介紹,需要的朋友可以過來參考一下2013-08-08PHP 實(shí)現(xiàn)base64編碼文件上傳出現(xiàn)問題詳解
這篇文章主要介紹了PHP 實(shí)現(xiàn)base64編碼文件上傳出現(xiàn)問題詳解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09PHP基于雙向鏈表與排序操作實(shí)現(xiàn)的會(huì)員排名功能示例
這篇文章主要介紹了PHP基于雙向鏈表與排序操作實(shí)現(xiàn)的會(huì)員排名功能,結(jié)合實(shí)例形式分析了php雙向鏈表的功能、定義及基于雙向鏈表的排序操作相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2017-12-12php導(dǎo)入大量數(shù)據(jù)到mysql性能優(yōu)化技巧
這篇文章主要介紹了php導(dǎo)入大量數(shù)據(jù)到mysql性能優(yōu)化技巧,通過針對(duì)SQL語(yǔ)句的優(yōu)化實(shí)現(xiàn)了mysql性能的提高,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2014-12-12PHP實(shí)現(xiàn)動(dòng)態(tài)柱狀圖改進(jìn)版
這篇文章主要介紹了PHP實(shí)現(xiàn)動(dòng)態(tài)柱狀圖改進(jìn)版,是在前面所述實(shí)現(xiàn)柱狀圖的基礎(chǔ)上進(jìn)行的改進(jìn),具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-03-03php中sprintf與printf函數(shù)用法區(qū)別解析
這篇文章主要介紹了php中sprintf與printf函數(shù)用法區(qū)別解析,需要的朋友可以參考下2014-02-02php實(shí)現(xiàn)文件與16進(jìn)制相互轉(zhuǎn)換的方法示例
這篇文章主要介紹了php實(shí)現(xiàn)文件與16進(jìn)制相互轉(zhuǎn)換的方法,文中給出了詳細(xì)的示例代碼,需要的朋友可以參考借鑒,下面來一起看看吧。2017-02-02