Laravel 5.5 - 排队事件监听器的Horizo​​n自定义作业标签

时间:2018-03-30 13:04:12

标签: php laravel laravel-5 laravel-5.5 laravel-horizon

documentation for Horizon中,它提到可以将自定义标记添加到排队的事件侦听器中。但是,我找不到任何方法来拉入包含我需要的数据的事件实例。给出的示例使用类型提示将相关模型从服务容器中拉出并将其分配给构造函数中的实例变量,然后在tags()方法中使用该实例变量来获取有关特定模型实例的数据经营。

在排队的事件监听器中执行此操作时,它不起作用。实际上,构造函数似乎根本就没有被调用,因为模型被序列化并且在执行时被“重新补充”。所以构造函数中的类型提示什么也不做,tags()似乎在handle()之前被调用,所以我无法访问我正在听的事件对象。

在这种情况下,有谁知道如何在标签中获取事件信息?

更新

在控制器中调用的事件:

event(new PostWasCreated($user, $post));

事件 PostWasCreated

<?php
namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use App\User;
use App\Post;

class PostWasCreated
{
    use InteractsWithSockets, SerializesModels;

    public $user;
    public $post;

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

    public function broadcastOn()
    {
        return new PrivateChannel('channel-name');
    }
}

监听器 PostWasCreatedNotificationSend

<?php
namespace App\Listeners;

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

class PostWasCreatedNotificationSend implements ShouldQueue
{
    protected $event;
    public $queue = 'notifications'; // Adds queue name

    public function __construct(PostWasCreated $event)
    {
      $this->event = $event;
      // Does NOT add queue tag
      $this->queueTags = ['post: ' . $this->event->post->id];
    }

    public function tags()
    {
      return $this->queueTags;
    }

    public function handle(PostWasCreated $event)
    {
      // handle event here...
    }
}

问题是$this->queueTags永远不会被分配,因此Horizo​​n中没有这个排队侦听器的标签......(队列名称虽然显示,但我们也需要标签)。

1 个答案:

答案 0 :(得分:2)

Horizo​​n会在之前收集任何标记,甚至将作业推送到队列中,因此我们不能依赖作业在执行之前不知道的任何值。在这种情况下,作业知道UserPost,因为我们传递它们来初始化事件。

对于排队的侦听器,标记系统会检查事件对象和侦听器类上的标记。如问题中所述,无法在侦听器上设置带有动态数据的标记,因为处理程序在 Horizo​​n将队列弹出作业后执行。我们只能在Horizo​​n将与事件上的标记合并*的侦听器上声明静态标记:

class PostWasCreatedNotificationSend implements ShouldQueue 
{
    ...
    public function tags() 
    {
        return [ 'listener:' . static::class, 'category:posts' ];
    }
}

使用事件对象,Horizo​​n会尝试为任何Eloquent模型成员自动生成标记。例如,Horizo​​n将为PostWasCreated事件创建以下标记:

  • $event->userApp\User:<id>
  • $event->postApp\Post:<id>

我们可以覆盖此行为,并通过定义上述tags()方法告诉Horizo​​n为事件设置哪些标记:

class PostWasCreated 
{
    ...
    public function tags() 
    {
        return [ 'post:' . $this->post->id ];
    }
}

请注意,在撰写本文时,如果侦听器事件 手动提供标记,Horizo​​n将不会自动为模型创建标记。

  

问题是$this->queueTags永远不会被分配,因此Horizo​​n中没有这个排队侦听器的标签......(队列名称虽然显示,但我们也需要标签)。

Horizo​​n不会为每个属性创建标记;自动标记仅适用于包含Eloquent模型的那些(通常不适用于监听器)。

*如果事件也用于广播(它实现ShouldBroadcast),则为发布消息而创建的附加作业不会继承侦听器提供的任何标记。