Laravel如何监听和处理事件_应用程序事件驱动模型

// app/Events/UserRegistered.php
namespace App\Events;

use App\Models\User; // 假设你的用户模型在 App\Models 命名空间下
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class UserRegistered
{
    use Dispatchable, SerializesModels;

    public User $user; // 公共属性，用于在监听器中访问

    /**
     * 创建一个新的事件实例。
     *
     * @param  \App\Models\User  $user
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }
}

Dispatchable

UserRegistered::dispatch($user)

SerializesModels

php artisan make:listener SendWelcomeEmail --event=UserRegistered

// app/Listeners/SendWelcomeEmail.php
namespace App\Listeners;

use App\Events\UserRegistered;
use Illuminate\Contracts\Queue\ShouldQueue; // 如果需要队列处理
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Mail; // 假设你需要发送邮件

class SendWelcomeEmail implements ShouldQueue // 实现 ShouldQueue 接口表示这是一个队列监听器
{
    use InteractsWithQueue; // 队列监听器需要此 trait

    /**
     * 处理事件。
     *
     * @param  \App\Events\UserRegistered  $event
     * @return void
     */
    public function handle(UserRegistered $event)
    {
        // 访问事件中传递的用户数据
        $user = $event->user;

        // 执行发送欢迎邮件的逻辑
        Mail::to($user->email)->send(new \App\Mail\WelcomeMail($user));

        // 可以在这里添加日志或其他业务逻辑
        \Log::info("Sent welcome email to user: {$user->email}");
    }
}

handle

ShouldQueue

app/Providers/EventServiceProvider.php

$listen

// app/Providers/EventServiceProvider.php
namespace App\Providers;

use Illuminate\Auth\Events\Registered;
use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;

class EventServiceProvider extends ServiceProvider
{
    /**
     * 应用程序的事件监听器映射。
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            SendEmailVerificationNotification::class,
        ],
        // 注册我们自定义的事件和监听器
        \App\Events\UserRegistered::class => [
            \App\Listeners\SendWelcomeEmail::class,
            // 如果有其他监听器，也可以在这里添加
            \App\Listeners\LogUserRegistration::class,
        ],
    ];

    /**
     * 注册应用程序的任何其他事件。
     *
     * @return void
     */
    public function boot()
    {
        //
    }
}

UserRegistered

SendWelcomeEmail

LogUserRegistration

handle

// 例如，在一个控制器或服务类中
use App\Events\UserRegistered;
use App\Models\User;

class AuthController extends Controller
{
    public function register(Request $request)
    {
        // ... 用户注册逻辑 ...
        $user = User::create($request->all());

        // 触发 UserRegistered 事件
        event(new UserRegistered($user)); // 使用全局辅助函数
        // 或者
        // \Illuminate\Support\Facades\Event::dispatch(new UserRegistered($user)); // 使用 Facade
        // 或者
        // UserRegistered::dispatch($user); // 如果事件类使用了 Dispatchable trait

        return redirect('/home');
    }
}

handle

register

UserRegistered

SendWelcomeEmail

EventServiceProvider

UserRegistered

// 事件类：UserRegistered.php
class UserRegistered
{
    // ...
    public User $user;
    public string $registrationIp; // 假设我们还需要注册IP

    public function __construct(User $user, string $registrationIp)
    {
        $this->user = $user;
        $this->registrationIp = $registrationIp;
    }
}

// 触发事件时
event(new UserRegistered($user, $request->ip()));

// 监听器类：LogUserRegistration.php
class LogUserRegistration
{
    public function handle(UserRegistered $event)
    {
        // 访问数据
        \Log::info("User {$event->user->id} registered from IP: {$event->registrationIp}");
    }
}

ShouldQueue

handle

php artisan queue:work

handle