Symfony 如何将任务队列转为数组

toArray()

// src/Message/MyAwesomeMessage.php
namespace App\Message;

class MyAwesomeMessage
{
    private string $dataField;
    private int $id;
    private \DateTimeImmutable $createdAt;

    public function __construct(string $dataField, int $id, \DateTimeImmutable $createdAt)
    {
        $this->dataField = $dataField;
        $this->id = $id;
        $this->createdAt = $createdAt;
    }

    public function getDataField(): string
    {
        return $this->dataField;
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function getCreatedAt(): \DateTimeImmutable
    {
        return $this->createdAt;
    }

    public function toArray(): array
    {
        return [
            'dataField' => $this->dataField,
            'id' => $this->id,
            'createdAt' => $this->createdAt->format(DATE_ATOM), // 格式化日期对象
        ];
    }
}

toArray()

// 假设你已经在服务中注入了 Symfony Serializer
use Symfony\Component\Serializer\SerializerInterface;

class MessageToArrayConverter
{
    private SerializerInterface $serializer;

    public function __construct(SerializerInterface $serializer)
    {
        $this->serializer = $serializer;
    }

    public function convertMessageToArray(object $message): array
    {
        // 默认情况下，会将所有公共属性或通过getter方法访问的属性序列化
        // 你可以通过 context 参数来控制序列化行为，比如使用序列化组
        return $this->serializer->normalize($message, 'json'); // 使用'json'格式进行标准化，结果是数组
    }
}

NormalizerInterface

// src/Serializer/Normalizer/MyAwesomeMessageNormalizer.php
namespace App\Serializer\Normalizer;

use App\Message\MyAwesomeMessage;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

class MyAwesomeMessageNormalizer implements NormalizerInterface
{
    private ObjectNormalizer $normalizer;

    public function __construct(ObjectNormalizer $normalizer)
    {
        $this->normalizer = $normalizer;
    }

    public function normalize($object, string $format = null, array $context = []): array
    {
        // 这里你可以完全控制输出的数组结构
        return [
            'message_type' => 'MyAwesomeMessage',
            'custom_id_display' => 'ID-' . $object->getId(),
            'payload_data' => $object->getDataField(),
            'timestamp' => $object->getCreatedAt()->getTimestamp(),
            // 还可以根据context决定是否包含更多信息
            'full_object_dump' => $this->normalizer->normalize($object, $format, $context), // 也可以包含默认序列化结果
        ];
    }

    public function supportsNormalization($data, string $format = null): bool
    {
        return $data instanceof MyAwesomeMessage;
    }

    public function getSupportedTypes(?string $format): array
    {
        return [MyAwesomeMessage::class => true];
    }
}

toArray()

toArray()

DateTimeImmutable

public function toArray(): array
{
    return [
        'id' => $this->id,
        'eventName' => $this->eventName,
        'payload' => $this->payload, // 如果payload本身是数组或可序列化对象，可以包含
        'timestamp' => $this->createdAt->format('Y-m-d H:i:s'), // 日期格式化
        'source' => 'internal_system', // 甚至可以添加一些不属于消息对象本身的元数据
    ];
}

@Groups

normalize()

// src/Message/UserRegisteredMessage.php
namespace App\Message;

use Symfony\Component\Serializer\Annotation\Groups;

class UserRegisteredMessage
{
    #[Groups(['log_detail', 'api_public'])]
    private int $userId;

    #[Groups(['log_detail', 'api_public'])]
    private string $email;

    #[Groups(['log_detail'])] // 只有在log_detail组中才包含
    private string $ipAddress;

    // ... 构造函数和getter
}

// 在你的服务中
$message = new UserRegisteredMessage(1, 'test@example.com', '192.168.1.1');

// 序列化用于日志，包含所有信息
$logArray = $this->serializer->normalize($message, 'json', ['groups' => 'log_detail']);
// 结果可能包含 userId, email, ipAddress

// 序列化用于API，只包含公开信息
$apiArray = $this->serializer->normalize($message, 'json', ['groups' => 'api_public']);
// 结果可能只包含 userId, email

Envelope

// 假设你在一个中间件或消费者中
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Stamp\MessageBusStamp;
use Symfony\Component\Messenger\Stamp\UniqueIdStamp;

class MyMessageProcessor
{
    private SerializerInterface $serializer;

    public function __construct(SerializerInterface $serializer)
    {
        $this->serializer = $serializer;
    }

    public function process(Envelope $envelope): void
    {
        $message = $envelope->getMessage();
        $messageArray = $this->serializer->normalize($message, 'json');

        // 获取并添加信封中的元数据
        $messageArray['envelope_stamps'] = [];
        foreach ($envelope->all() as $stampClass => $stamps) {
            foreach ($stamps as $stamp) {
                // 仅添加可序列化的或你关心的stamp信息
                if ($stamp instanceof UniqueIdStamp) {
                    $messageArray['envelope_stamps']['unique_id'] = $stamp->getUniqueId();
                }
                // ... 其他你关心的stamp类型
            }
        }

        // 现在 messageArray 包含了消息内容和信封元数据
        // 可以用于日志或存储
        // error_log(json_encode($messageArray));
    }
}

enable_max_depth

circular_reference_handler

enable_max_depth

circular_reference_handler

# config/packages/serializer.yaml
framework:
    serializer:
        enable_max_depth: true # 启用最大深度限制
        circular_reference_handler: 'App\Serializer\CircularReferenceHandler::handle' # 自定义处理

// src/Serializer/CircularReferenceHandler.php
namespace App\Serializer;

class CircularReferenceHandler
{
    public function handle(object $object, string $format, array $context): string
    {
        // 返回一个有意义的字符串，比如对象类名和ID
        return sprintf('Circular reference to object of type %s (ID: %s)', get_class($object), method_exists($object, 'getId') ? $object->getId() : spl_object_hash($object));
    }
}

resource

Closure