Examples for serializer services in documentation

[akserikawa]

@AymDev @joker806 Could you provide a basic example of a valid serializer service for messages in a queue/topic in the README? It would be helpful for a quick start

[AymDev]

Sorry for the response delay. I don't think that this kind of example would be relevant in the documentation as it is purely related to how Messenger works. Check the documentation which links to the SerializerInterface

But here is a dummy example:

<?php

namespace App\Messenger\MyQueueOrTopic;

use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;

class MyQueueOrTopicSerializer implements SerializerInterface
{
    /**
     * @param mixed[]|array{body: string, headers: array<string, array<int, string>>} $encodedEnvelope
     */
    public function decode(array $encodedEnvelope): Envelope
    {
        $data = json_decode($encodedEnvelope['body']);
        $message = new MyQueueOrTopicMessage($data);
        return new Envelope($message);
    }

    /**
     * @return mixed[]
     */
    public function encode(Envelope $envelope): array
    {
        /** @var MyQueueOrTopicMessage $message */
        $message = $envelope->getMessage();
        $data = $message->getData();
        return [
            'body' => json_encode($data),
        ];
    }
}

I'd also use the Symfony Serializer component instead of the json_* functions, that can help to encode/decode to DTO, etc.

[akserikawa]

Thanks for the example! Managed to get it working a while ago. Indeed, it's just a matter of understanding the serialization/deserialization workflow.