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

Question

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

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

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

更新:

在 Controller 中调用的事件:

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 中没有这个排队监听器的标签......(虽然队列名称显示，但我们也需要标签) .

Answer 1

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

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

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

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

• $event->user → App\User:<id>
• $event->post → App\Post:<id>

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

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

请注意，在撰写本文时，如果事件或监听器手动提供标签，则 Horizo​​n 不会自动为模型创建标签。

The issue is $this->queueTags never gets assigned, so there are no tags in Horizon for this queued listener... (queue name show up though, but we need tags as well).

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

---

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