laravel事件系统操作

一、使用目的：简化代码，使需求逻辑异步执行
二、同步事件操作步骤
1、新建事件
php artisan make:event UserLogin

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class UserLogin
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    //定义public listener 会使用到
    public  $data;
    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct($data)
    {
        $this->data = $data;
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return \Illuminate\Broadcasting\Channel|array
     */
    public function broadcastOn()
    {
        return new PrivateChannel('userLogin');
    }
}

2、事件监听
app/Providers/EventServiceProvider.php

namespace App\Providers;

use App\Events\UserLogin;
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
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            SendEmailVerificationNotification::class,
        ],
        //用户登录成功后事件处理
        UserLogin::class => [
            'App\Listeners\UserLogin\WriteLog',//记录日志操作
            'App\Listeners\UserLogin\ActiveOperate',//活跃操作
        ]
    ];

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

        //
    }
}

3、生成监听者
php artisan event:generate

命令执行后会生成配置的两个文件

app/Listeners/UserLogin/ActiveOperate.php
app/Listeners/UserLogin/WriteLog.php

ActiveOperate.php代码展示

namespace App\Listeners\UserLogin;

use App\Events\UserLogin;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;

class ActiveOperate
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  UserLogin  $event
     * @return void
     */
    public function handle(UserLogin $event)
    {
        //$event 接收事件属性方法
        info('ActiveOperate'.json_encode($event->data,JSON_UNESCAPED_UNICODE));
    }
}

4、建立控制器

php artisan make:controller UserloginController

在控制器中调用事件

namespace App\Http\Controllers;

use App\Events\UserLogin;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Event;

class UserController extends Controller
{
    public function login(Request $request){
        var_dump('代码操作逻辑');
        $data = [
            'id' => '1',
            'username' => 'testname'
        ];
        //事件分发
        event(new UserLogin($data));
    }
}

访问控制器方法，会调用注册好的事件

[2021-05-16 06:07:23] local.INFO: ActiveOperate{"id":"1","username":"testname"}
[2021-05-16 06:07:23] local.INFO: ActiveOperate{"id":"1","username":"testname"}

5、需要注意的地方
1）event作用：起到中间桥梁作用，把controller中的数据传递给listener，就是传递命令的人
2）controller作用：使用event注册事件，就是下达命令的人
3）listener作用：处理注册的事件，就是实际打工人
4）执行过程还是同步执行，等到listener全部执行完成，控制器才会返回响应

三、异步执行事件
1、操作：listener 继承 ShouldQueue，添加实现方式和缓存key

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

    /**
     * 任务将被发送到的队列的名称
     *
     * @var string|null
     */
    public $queue = 'UserLogin:WriteLog';

添加异步后，事件不会同步执行，只执行控制器方法，事件等待后台任务处理
2、执行
1）访问控制器方法，可以看到对应日志没有生成新的文件内容，而是存储在了redis中，使用list存储，key中有我们定义的部分key，存储的数据为对象信息

2）调用php artisan 执行队列
php artisan queue:work --queue=UserLogin:ActiveOperate
php artisan queue:work --queue=UserLogin:WriteLog
3）单独执行queue:work 无法执行，必须指定单独的队列名称，原因没有找到