One of my favorite projects in the laravel ecosystem is Echo. Echo enables real-time web applications through the use of websockets and hooks directly into Laravel’s Event broadcasting features. this means developers can use a familiar php API to send real-time data. A very common use-case for this type of functionality would be a notification or chat system.翻譯「略」摘自:https://www.imarc.com/blog/realtime-notifications-with-laravel-echo-server-docker-and-traefik
官方文檔推薦使用 Pusher 或者 laravel-echo-server (是一個使用 NodeJS + Socket.IO 實現的 WebSocket 服務端)。
推薦:laravel教程
在國內,個人還是不推薦使用 Pusher,訪問速度有所影響,而且其還是一個商業產品。
今天利用最簡便的「16」步,走一遍代碼集成 laradock 和 laravel-echo-server 來使用 Laravel Echo。
搭建基礎環境
//?1.?new?project laravel?new?echolearning //?2.?使用?laradock git?clone?https://github.com/Laradock/laradock.git //?3.?創建?.env cp?env-example?.env //?4.?創建?container docker-compose?up?-d?php-worker?laravel-echo-server?nginx?redis
//?5.?進入?workspace?容器 docker-compose?exec?--user=laradock?workspace?bash //?6.?安裝插件 //?6.1?推薦使用?laravel-china?維護的?composer?國內鏡像 composer?config?-g?repo.packagist?composer?https://packagist.laravel-china.org //?6.2?并行下載插件 composer?global?require?"hirak/prestissimo" //?6.3?配置?yarn?國內鏡像 yarn?config?set?registry?'https://registry.npm.taobao.org' //?注:以上可以在?laradock?中配置 //?6.4?執行安裝 composer?install yarn?install //?7.?創建?.env?和?key cp?.env.example?.env php?artisan?key:generate
好了,我們開始在瀏覽器輸入:http://localhost,網站跑起來了
使用 Laravel Echo Server
因為 laradock 集成了「Laravel Echo Server」,所以我們很方便的使用到 Laravel Echo。
//?8.?配置廣播驅動和?redis?服務器 BROADCAST_DRIVER=redis REDIS_HOST=redis //?9.?安裝?predis composer?require?predis/predis
準備好后端配置后,我們開始安裝前端插件,畢竟 Laravel Echo 是前端工具。
//?10.?安裝?socket.io-client?laravel-echo yarn?add?socket.io-client?laravel-echo
在 resources/assets/js/bootstrap.js 實例化 Echo:
//?11.?實例化?Echo import?Echo?from?'laravel-echo' window.io?=?require('socket.io-client') window.Echo?=?new?Echo({ ????broadcaster:?'socket.io', ????host:?window.location.hostname?+?':6001' }); //?Laravel?官方推薦使用?pusher //?window.Pusher?=?require('pusher-js'); //?window.Echo?=?new?Echo({ //?????broadcaster:?'pusher', //?????key:?process.env.MIX_PUSHER_APP_KEY, //?????cluster:?process.env.MIX_PUSHER_APP_CLUSTER, //?????encrypted:?true //?});
接下來我們就可以使用 Echo 實例,監聽后端發過來的廣播或者通知了。
首先我們利用已經給的 ExampleComponent 改造下,創建 Echo 監聽,等待數據的到來,然后再顯示在頁面上。代碼簡單:
<template> ????<div> ????????<div> ????????????<div> ????????????????<div> ????????????????????<div>Example?Component</div> ????????????????????<div> ????????????????????????<ul> ????????????????????????????<li>{{?name?}}</li> ????????????????????????</ul> ????????????????????</div> ????????????????</div> ????????????</div> ????????</div> ????</div> </template><script> export default { data () { return { names: [] } }, mounted() { let that = this // 12. 創建 Echo 監聽 Echo.channel('rss') .listen('RssCreatedEvent', (e) => { that.names.push(e.name) }); } } </script>
我們在后端添加一個 rss 被創建的事件 RssCreatedEvent,并繼承 ShouldBroadcast。
//?13.?創建?RssCreatedEvent?事件 php?artisan?make:event?RssCreatedEvent
我們使用假數據,讓它返回當前的時間,方便查看效果:
<?php namespace AppEvents; use CarbonCarbon; use IlluminateBroadcastingChannel; use IlluminateQueueSerializesModels; use IlluminateBroadcastingPrivateChannel; use IlluminateBroadcastingPresenceChannel; use IlluminateFoundationEventsDispatchable; use IlluminateBroadcastingInteractsWithSockets; use IlluminateContractsBroadcastingShouldBroadcast; class RssCreatedEvent implements ShouldBroadcast { use Dispatchable, InteractsWithSockets, SerializesModels; /** * Create a new event instance. * * @return void */ public function __construct() { // } /** * Get the channels the event should broadcast on. * * @return IlluminateBroadcastingChannel|array */ public function broadcastOn() { // 14. 創建頻道 return new Channel('rss'); } /** * 指定廣播數據。 * * @return array */ public function broadcastWith() { // 返回當前時間 return ['name' =>?Carbon::now()->toDateTimeString()]; ????} }
然后我們就可以做一個定時任務了,讓它每隔一分鐘,廣播一次:
protected?function?schedule(Schedule?$schedule) { ????//?15.?每隔一分鐘執行一次 ????$schedule->call(function?()?{ ????????event(new?RssCreatedEvent()); ????})->everyMinute(); }
最后讓首頁加載 vue 組件,刷新測試:
nbsp;html> getLocale()?}}"> ???? ????????<meta> ????????<meta> ????????<meta> ????????<meta> ????????<title>Laravel</title> ???? ???? ????<div> ????????<example-component></example-component> ????</div> ????<script></script> ????
注:需要在 header 引入
<meta>
編譯前端:
//?16.?運行?watch yarn?run?watch-poll
刷新網頁,查看運行效果:
如我們所愿,每隔一分鐘,廣播一次,前端 laravel-echo 監聽并捕獲該廣播,然后讀取數據,展示出來。
總結
到目前為止,我們用到的技術都有:
1.laradock 的使用
2.laravel echo server 的使用
3.廣播事件
4.event() 輔助函數
5.$schedule 定時任務
6.Laravel Echo 的使用
我們基本可以使用 Laravel Echo 了,至于更深入的使用,推薦查看官網文檔。
最后再一次強烈推薦大家用 laradock 來部署 Docker 開發環境,因為你想要用到的工具和環境,相信 laradock 都為你準備好了。