[IGNITE-14649] Create an annotation processor for generating message serializers and de-serializers

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha2
• Component/s: networking
• Assignee: Aleksandr Polovtsev
• Reporter: Semyon Danilov
• Reviewer: Semyon Danilov
• Created: 24/Apr/21 20:16
• Updated: 25/May/21 15:36
• Resolved: 25/May/21 15:36

Description

NetworkMessage instances can be (de-)serialized using instances of MessageSerializer and MessageDeserializer interfaces. These interfaces have to be implemented for every message type which is very tedious and can be automated. It is proposed to use annotation processing to generate the corresponding implementations for every network message.

Current serialization procedure looks like the following:

1. Message header is written.
2. Message fields are sorted alphanumerically. This is done for historical reasons and not needed at the moment, but it was decided to keep this logic.
3. Message fields are dumped into the provided stateful MessageWriter.

De-serialization procedure performs the same actions in reverse order.

Requirements

1. Create an annotation processor for generating instances of the following interfaces:
   1. MessageDeserializer
   2. MessageSerializer
   3. MessageSerializationFactory
2. Introduce the @AutoSerializable annotation that will be used to mark NetworkMessage implementations which will be considered as candidates for code generation by the annotation processor.
3. It should be possible to implement custom (de-)serializers for some messages. In this case it is proposed to simply omit the @AutoSerializable annotation on such messages.
4. Auto-generated MessageSerializationFactory instances should be automatically registered in a MessageSerializationRegistry. It is proposed to create a helper class that will add the generated factories to the provided registry.

Issue Links

• links to: GitHub Pull Request #130