《laravel的事件、laravel事件机制》

在Laravel项目开发中，当需要在多个地方响应同一业务逻辑或操作时，使用事件（Event）和监听器（Listener）是一种优雅且解耦合的解决方案。通过定义事件并触发监听器，可以将业务逻辑分散到各个监听器中，从而提高代码的可维护性和扩展性。

一、事件与监听器的基本概念

事件是应用程序中发生的有意义的事情，例如用户注册成功、订单创建等。而监听器则是对事件作出响应，执行特定的操作，如发送欢迎邮件、更新库存等。

1. 创建事件类

我们可以使用Artisan命令来创建事件：
php php artisan make:event UserRegistered
这将在app/Events目录下生成一个UserRegistered.php文件，默认情况下它会继承自IlluminateFoundationEventsDispatchable，该特性提供了事件分发所需的基本功能。

你可以在这个事件类中定义一些属性，用于传递给监听器的数据。例如对于用户注册事件，可以传递用户的实例：
```php
<?php

namespace AppEvents;

use AppModelsUser;
use IlluminateFoundationEventsDispatchable;
use IlluminateQueueSerializesModels;

class UserRegistered
{
use Dispatchable, SerializesModels;

public $user;

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

}
```

2. 创建监听器类

同样地，使用Artisan命令创建监听器：
php php artisan make:listener SendWelcomeEmail --event=UserRegistered
在生成的监听器类SendWelcomeEmail.php中，我们可以在handle方法中编写处理逻辑：
```php
<?php

namespace AppListeners;

use AppEventsUserRegistered;
use IlluminateContractsQueueShouldQueue;
use IlluminateQueueInteractsWithQueue;

class SendWelcomeEmail
{
/**
* Handle the event.
*
* @param AppEventsUserRegistered $event
* @return void
*/
public function handle(UserRegistered $event)
{
// 这里可以编写发送邮件的逻辑
// 比如使用Laravel内置的邮件功能
Mail::to($event->user->email)->send(new WelcomeMail());
}
}
```

二、事件的触发与监听器的注册

1. 触发事件

在合适的地方触发事件，例如在用户注册的控制器中：
```php
<?php

namespace AppHttpControllers;

use AppHttpControllersController;
use AppModelsUser;
use AppEventsUserRegistered;
use IlluminateHttpRequest;

class RegisterController extends Controller
{
public function register(Request $request)
{
// 注册逻辑...
$user = User::create([
'name' => $request->name,
'email' => $request->email,
'password' => bcrypt($request->password),
]);

    // 触发事件
    event(new UserRegistered($user));

    return response()->json(['message' => '注册成功']);
}

}
```

2. 注册监听器

可以在EventServiceProvider中的listen属性中注册监听器：
```php
<?php

namespace AppProviders;

use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;
use IlluminateSupportFacadesEvent;

class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
UserRegistered::class => [
SendWelcomeEmail::class,
// 可以添加更多的监听器
],
];

/**
 * Register any events for your application.
 *
 * @return void
 */
public function boot()
{
    parent::boot();
}

}
```

三、其他思路

1. 异步处理

如果某些监听器的执行比较耗时，比如发送邮件、更新缓存等，我们可以让监听器实现队列接口ShouldQueue，这样就可以将监听器放到队列中异步执行。只需要在监听器类中引入这个接口即可：
```php
<?php

namespace AppListeners;

use AppEventsUserRegistered;
use IlluminateContractsQueueShouldQueue;
use IlluminateQueueInteractsWithQueue;

class SendWelcomeEmail implements ShouldQueue
{
// ...
}
```
同时要确保已经配置好队列服务，并且启动了队列工作进程。

2. 动态监听器

有时候我们可能需要根据不同的条件动态地选择监听器。可以通过在EventServiceProvider的subscribe方法中订阅事件，然后在订阅者类中根据业务逻辑动态添加监听器：
```php
<?php

namespace AppProviders;

use AppListenersUserActivityLogger;
use AppListenersUserNotificationSender;
use AppEventsUserActivityEvent;
use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;

class EventServiceProvider extends ServiceProvider
{
protected $subscribe = [
UserActivitySubscriber::class,
];
}

// 订阅者类
<?php

namespace AppListeners;

use AppEventsUserActivityEvent;

class UserActivitySubscriber
{
public function subscribe($events)
{
$events->listen(
UserActivityEvent::class,
function (UserActivityEvent $event) {
if ($event->activityType === 'login') {
// 动态添加登录相关的监听器
$events->listen(
UserActivityEvent::class,
UserActivityLogger::class
);
} elseif ($event->activityType === 'order') {
// 动态添加订单相关的监听器
$events->listen(
UserActivityEvent::class,
UserNotificationSender::class
);
}
}
);
}
}
```