fr.ght1pc9kc.entity.jackson.EntityModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entity-jackson Show documentation
There is a newer version: 1.3.1
package fr.ght1pc9kc.entity.jackson;

import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.core.util.VersionUtil;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.module.SimpleDeserializers;
import com.fasterxml.jackson.databind.module.SimpleSerializers;
import fr.ght1pc9kc.entity.api.Entity;
import fr.ght1pc9kc.entity.api.impl.BasicEntity;
import fr.ght1pc9kc.entity.api.impl.ExtendedEntity;
import fr.ght1pc9kc.entity.jackson.serializer.EntityContextualDeserializer;
import fr.ght1pc9kc.entity.jackson.serializer.EntitySerializer;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

import java.util.List;
import java.util.Map;

/**
 * The Jackson module managing {@link Entity} type object
 *
 * Deserialization
 * Manage the {@link Entity} deserialization.
 * All field starting with "{@code _}" are considered as meta data and will be used for Entity,
 * all other fields are considered to belong to the self object
 *
 * Serialization
 * {@link Entity#self()} was serialized as unwrapped object. All properties from Entity was considered
 * as meta data and was prefixed with {@code _}, properties from self object was serialized at the same leve "as is".
 * All Jackson annotations on the {@code self} object was read and used.
 * This serializer avoid Jackson problem of using {@link com.fasterxml.jackson.annotation.JsonTypeInfo} inside an
 * object annotated with {@link com.fasterxml.jackson.annotation.JsonUnwrapped}
 * {@see FasterXML/jackson-databind#81}
 *
 * The entity :
 * {@code
 *    Entity.identify(new LightSaber(Color.GREEN, 1))
 *          .meta(createdAt, Instant.parse("2024-01-20T15:06:42.546Z"))
 *          .meta(createdBy, "okenobi")
 *          .withId("LIGHTSABER");
 * }
 * become
 *  *     {
 *          "_id": "LIGHTSABER",
 *          "_createdAt": "2024-01-20T15:06:42.546Z",
 *          "_createdBy": "okenobi",
 *          "@type": "LIGHT",
 *          "blade": 1,
 *          "color": "GREEN"
 *     }
 * 
 * if Saber interface declared as 
 * {@code
 * @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "@type")
 * @JsonSubTypes({
 *      @JsonSubTypes.Type(value = LightSaber.class, name = "LIGHT"),
 *      @JsonSubTypes.Type(value = DarkSaber.class, name = "DARK")
 * })
 * public sealed interface Saber permits DarkSaber, LightSaber {
 *      Color color();
 * }
 * }
 */
@Slf4j
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
public class EntityModule extends Module {
    @Override
    public String getModuleName() {
        return EntityModule.class.getSimpleName();
    }

    @Override
    public Version version() {
        return VersionUtil.parseVersion("1.0.0", EntityModule.class.getPackageName(), "jackson-entity-module");
    }

    @Override
    public void setupModule(SetupContext context) {
        log.info("Configure Jackson Entity module ...");
        EntityContextualDeserializer deserializer = new EntityContextualDeserializer();
        context.addDeserializers(new SimpleDeserializers(Map.of(
                Entity.class, deserializer,
                BasicEntity.class, deserializer,
                ExtendedEntity.class, deserializer
        )));
        context.addSerializers(new SimpleSerializers(List.of(
                new EntitySerializer<>(context.getTypeFactory().constructType(new TypeReference>() {
                })),
                new EntitySerializer<>(context.getTypeFactory().constructType(new TypeReference>() {
                })),
                new EntitySerializer<>(context.getTypeFactory().constructType(new TypeReference>>() {
                }))
        )));
    }
}