最新消息: 关于Git&GitHub 版本控制你了解多少?
您现在的位置是:群英 > 开发技术 > PHP语言 >
关于Laravel事件系统用法总结
PHP中文网发表于 2021-06-09 16:57 次浏览
下面由群英网络给大家总结Laravel事件系统用法(监听事件,观察者模式) ,希望对需要的朋友有所帮助!

在理解了观察者模式后,我们开始正文

Laravel 的事件提供了一个简单的观察者实现,能够订阅和监听应用中发生的各种事件。事件类保存在 app/Events 目录中,而这些事件的的监听器则被保存在 app/Listeners 目录下。这些目录只有当你使用 Artisan 命令来生成事件和监听器时才会被自动创建。

事件机制是一种很好的应用解耦方式,因为一个事件可以拥有多个互不依赖的监听器。例如,如果你希望每次订单发货时向用户发送一个 Slack 通知。你可以简单地发起一个 OrderShipped 事件,让监听器接收之后转化成一个 Slack 通知,这样你就可以不用把订单的业务代码跟 Slack 通知的代码耦合在一起了。

手动生成一个事件

比如通过 artisan 命令手动生成一个 UserLogin 事件:

php artisan make:event UserLogin

在 app/Events 中就会自动生成一个 UserLogin.php 文件,内容不多,如下:

<?php
 
namespace AppEvents; 
use IlluminateBroadcastingChannel;use IlluminateQueueSerializesModels;use IlluminateBroadcastingPrivateChannel;use IlluminateBroadcastingPresenceChannel;use IlluminateBroadcastingInteractsWithSockets;use IlluminateContractsBroadcastingShouldBroadcast; 
class UserLogin
{    use InteractsWithSockets, SerializesModels; 
    /**
     * Create a new event instance.
     *
     * @return void     */
    public function __construct()
    {        //    } 
    /**
     * Get the channels the event should broadcast on.
     *
     * @return Channel|array     */
    public function broadcastOn()
    {        return new PrivateChannel('channel-name');
    }
}

定义监听器

一个事件可以被一个或多个监听器监听,也就是观察者模式,我们可以定义多个监听器,当这个事件发生,执行一系列逻辑。

在 EventServiceProvider 的 $listen 中可以定义事件和监听器,如下:

protected $listen = [    'AppEventsUserLogin' => [        'AppListenersDoSomething1',
        'AppListenersDosomething2',
    ],];

执行 artisan 命令,就可以自动在 app/Lisenter 目录生成监听器。

php artisan event:generate

这个命令也可以自动生成事件,如果没有 UserLogin 这个事件会自动生成,而不需要手动生成。

可以看到 app/Listeners 目录多了 DoSomething1.php 和 DoSomething2.php 两个文件,我们看看其中一个内容:

<?php
 
namespace AppListeners;
 
use AppEventsUserLogin;
use IlluminateQueueInteractsWithQueue;
use IlluminateContractsQueueShouldQueue;
 
class DoSomething1
{    /**
     * Create the event listener.
     *
     * @return void     */
    public function __construct()
    {        //    } 
    /**
     * Handle the event.
     *
     * @param  UserLogin  $event
     * @return void     */
    public function handle(UserLogin $event)
    {        info('do something1');
    }
}

在两个监听器的 handle 方法中我们打印一个日志来测试一下,如代码 handle 方法所示。

分发和触发事件

我们在某个控制器的方法中来分发事件,也就是触发事件,看监听器是否正常工作。

就是一句话:

event(new UserLogin());

然后我们请求这个控制器,观察日志,发现打印了日志:

[2018-06-17 10:04:29] local.INFO: do something1
[2018-06-17 10:04:29] local.INFO: do something2

那么这个事件-监听机制就正常工作了。

队列异步处理

如果某个监听器需要执行的操作比较慢,可以放到消息队列进行异步处理。

比如把上面的 DoSomething1 改成需要放入队列的,只需要 implements ShoulQueue 接口。

class DoSomething1 implements ShouldQueue

也可以指定队列驱动,如下代码。

    /**
     * 任务应该发送到的队列的连接的名称
     *
     * @var string|null     */
    public $connection = 'redis'; 
    /**
     * 任务应该发送到的队列的名称
     *
     * @var string|null     */
    public $queue = 'listeners';

我们再次执行控制器方法。

日志里没有打印 do something1,只有 do something2,但是在 redis 队列里发现了一个名为 queues:default 的列表。

{"job":"Illuminate\Events\CallQueuedHandler@call","data":{"class":"App\Listeners\DoSomething1","method":"handle","data":"a:1:{i:0;O:20:"App\Events\UserLogin":1:{s:6:"socket";N;}}"},"id":"3D7VDUwueYGtUvsazicWsifwWQxnnLID","attempts":1}

这个时候需要使用 php artisan queue:work 执行队列任务,才是真正执行 DoSomething1 这个监听器的 handle 方法。

以上就是总结Laravel事件系统用法(监听事件,观察者模式)的详细内容,更多请关注群英网络其它相关文章!

标签:laravel教程
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:mmqy2019@163.com进行举报,并提供相关证据,查实之后,将立刻删除涉嫌侵权内容。
相关信息推荐
2021-09-15 18:27:44 关键词:laravel写法
摘要:今天给大家分享laravel优雅框架写法,新手在刚接触laravel框架就要注意写法的问题,对于laravel的一些写法要注意,养成好的习惯。对此,小编给大家整理了一些Laravel 不太建议的写法,大..
2021-09-15 18:27:29 关键词:laravel框架路由
摘要:laravel框架路由有多少种?在laravel框架中,常见的路由有post,get,put,patch,delete,options。接下来我们就来了解一下它们的写法以及要注意的问题。..
2021-09-15 18:27:20 关键词:laravel框架的优点
摘要:laravel框架的优点和主要功能是什么?对于laravel框架的优点有很多,例如功能多、开源项目多、测试方便和有强大的表单验证功能等等。这篇文章小编就给大家来详细的介绍一下laravel框架..
2021-09-15 18:27:04 关键词:laravel 辅助函数
摘要:今天给大家分享laravel中辅助函数optional()的内容,小编觉得optional()非常实用,因此分享给大家做个参考,下文有对optional()的应用场景及使用有详细介绍,感兴趣的朋友可以参考。..
2021-09-07 18:12:27 关键词:Laravel子查询
摘要:Laravel子查询语句怎么样使用?今天小编就给大家分享一篇Laravel子查询语句使用的实例,对大家学习Laravel子查询有一定的帮助,有需要的朋友可以参考,接下来跟随小编来看看吧。..