Refactor models to use UUIDs for identifiers and implement custom UUID generation

Author: TheMeinerLP

build.gradle.kts

@@ -2,11 +2,12 @@ plugins {
     java
     jacoco
     `maven-publish`
+    `java-library`
     id("io.micronaut.library") version "4.5.2"
 }
 
 group = "net.theevilreaper.vulpes.api"
-version = "1.0.1"
+version = "1.1.0"
 
 java {
     toolchain {
@@ -19,19 +20,12 @@ java {
 
 dependencies {
     // Annotation Processors
-    annotationProcessor(mn.micronaut.serde.processor)
-    annotationProcessor(mn.micronaut.mongo.core)
     annotationProcessor(mn.micronaut.data.processor)
 
-    implementation(mn.micronaut.serde.jackson)
-    implementation(mn.micronaut.data.spring.jpa)
+    implementation(mn.micronaut.data.processor)
+    implementation(mn.micronaut.data.jpa)
     implementation(mn.micronaut.hibernate.jpa)
-    implementation(mn.micronaut.hibernate.validator)
-    implementation(mn.micronaut.data.tx.hibernate)
-
-    // Runtime Libraries
-    implementation(mn.jackson.core)
-    implementation(mn.jackson.databind)
+    api(libs.uuid.creator)
 }
 
 tasks {

settings.gradle.kts

@@ -3,3 +3,13 @@ rootProject.name = "vulpes-model"
 plugins {
     id("io.micronaut.platform.catalog") version "4.5.2"
 }
+
+dependencyResolutionManagement {
+    versionCatalogs {
+        create("libs") {
+            version("uuid.creator", "6.1.0")
+
+            library("uuid.creator", "com.github.f4b6a3", "uuid-creator").versionRef("uuid.creator")
+        }
+    }
+}

src/main/java/net/theevilreaper/vulpes/api/generator/UuidV7Generator.java

@@ -0,0 +1,23 @@
+package net.theevilreaper.vulpes.api.generator;
+
+import com.github.f4b6a3.uuid.UuidCreator;
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.BeforeExecutionGenerator;
+import org.hibernate.generator.EventType;
+
+import java.util.EnumSet;
+
+import static org.hibernate.generator.EventTypeSets.INSERT_ONLY;
+
+public final class UuidV7Generator implements BeforeExecutionGenerator {
+
+    @Override
+    public Object generate(SharedSessionContractImplementor session, Object owner, Object currentValue, EventType eventType) {
+        return UuidCreator.getTimeOrderedEpoch();
+    }
+
+    @Override
+    public EnumSet<EventType> getEventTypes() {
+        return INSERT_ONLY;
+    }
+}

src/main/java/net/theevilreaper/vulpes/api/generator/VulpesGenerator.java

@@ -0,0 +1,16 @@
+package net.theevilreaper.vulpes.api.generator;
+
+import org.hibernate.annotations.IdGeneratorType;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@IdGeneratorType(UuidV7Generator.class)
+@Retention(RUNTIME)
+@Target({METHOD,FIELD})
+public @interface VulpesGenerator {
+}

src/main/java/net/theevilreaper/vulpes/api/model/AttributeModel.java

@@ -1,13 +1,13 @@
 package net.theevilreaper.vulpes.api.model;
 
-import io.micronaut.data.annotation.MappedEntity;
-import io.micronaut.serde.annotation.Serdeable;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
-import jakarta.persistence.Index;
-import jakarta.persistence.Table;
+import net.theevilreaper.vulpes.api.generator.VulpesGenerator;
+
+import javax.annotation.processing.Generated;
+import java.util.UUID;
 
 /**
  * Represents an Attribute in the system. This class is used as an entity for persistence
@@ -18,15 +18,13 @@
  * are automatically persisted by the JPA and Micronaut Data layers.
  * </p>
  */
-@Serdeable
 @Entity(name = "attributes")
-@Table(name = "vulpes_attributes", indexes = @Index(columnList = "id"))
-@MappedEntity
 public class AttributeModel implements VulpesModel {
 
     @Id
-    @GeneratedValue(strategy = GenerationType.AUTO)
-    private String id;
+    @GeneratedValue(strategy = GenerationType.UUID)
+    @VulpesGenerator
+    private UUID id;
     private String modelName;
     private String name;
     private double defaultValue;
@@ -51,7 +49,7 @@ public AttributeModel() {
      * @param defaultValue  the default value of the attribute
      * @param maximumValue  the maximum value of the attribute
      */
-    public AttributeModel(String id, String modelName, String name, double defaultValue, double maximumValue) {
+    public AttributeModel(UUID id, String modelName, String name, double defaultValue, double maximumValue) {
         this.id = id;
         this.modelName = modelName;
         this.name = name;
@@ -66,7 +64,7 @@ public AttributeModel(String id, String modelName, String name, double defaultVa
      *
      * @return the unique identifier of the attribute
      */
-    public String getId() {
+    public UUID getId() {
         return id;
     }
 
@@ -75,7 +73,7 @@ public String getId() {
      *
      * @param id the unique identifier to set
      */
-    public void setId(String id) {
+    public void setId(UUID id) {
         this.id = id;
     }
 

src/main/java/net/theevilreaper/vulpes/api/model/FontModel.java

@@ -1,16 +1,14 @@
 package net.theevilreaper.vulpes.api.model;
 
-import io.micronaut.data.annotation.MappedEntity;
-import io.micronaut.serde.annotation.Serdeable;
 import jakarta.persistence.ElementCollection;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
-import jakarta.persistence.Index;
-import jakarta.persistence.Table;
+import net.theevilreaper.vulpes.api.generator.VulpesGenerator;
 
 import java.util.List;
+import java.util.UUID;
 
 /**
  * Represents a Font in the system. This class is used as an entity for persistence
@@ -21,15 +19,13 @@
  * are automatically persisted by the JPA and Micronaut Data layers.
  * </p>
  */
-@Serdeable
 @Entity(name = "fonts")
-@Table(name = "vulpes_fonts", indexes = @Index(columnList = "id"))
-@MappedEntity
 public class FontModel implements VulpesModel {
 
     @Id
-    @GeneratedValue(strategy = GenerationType.AUTO)
-    private String id;
+    @GeneratedValue(strategy = GenerationType.UUID)
+    @VulpesGenerator
+    private UUID id;
     private String modelName;
     private String name;
     private String description;
@@ -64,7 +60,7 @@ public FontModel() {
      * @param chars       the list of characters included in the font
      * @param shift       the list of shift values for the font
      */
-    public FontModel(String id, String modelName, String name, String description, String type, int ascent, int height, List<String> chars, List<Double> shift) {
+    public FontModel(UUID id, String modelName, String name, String description, String type, int ascent, int height, List<String> chars, List<Double> shift) {
         this.id = id;
         this.modelName = modelName;
         this.name = name;
@@ -83,7 +79,7 @@ public FontModel(String id, String modelName, String name, String description, S
      *
      * @return the unique identifier of the font
      */
-    public String getId() {
+    public UUID getId() {
         return id;
     }
 
@@ -92,7 +88,7 @@ public String getId() {
      *
      * @param id the unique identifier to set
      */
-    public void setId(String id) {
+    public void setId(UUID id) {
         this.id = id;
     }
 

src/main/java/net/theevilreaper/vulpes/api/model/ItemModel.java

@@ -1,16 +1,15 @@
 package net.theevilreaper.vulpes.api.model;
 
-import io.micronaut.serde.annotation.Serdeable;
 import jakarta.persistence.ElementCollection;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
-import jakarta.persistence.Index;
-import jakarta.persistence.Table;
+import net.theevilreaper.vulpes.api.generator.VulpesGenerator;
 
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 
 /**
  * Represents an Item in the system. This class is used as an entity for persistence
@@ -21,21 +20,20 @@
  * persisted by the JPA and Micronaut Data layers.
  * </p>
  */
-@Serdeable
 @Entity(name = "items")
-@Table(name = "vulpes_items", indexes = @Index(columnList = "id"))
 public class ItemModel implements VulpesModel {
 
     @Id
-    @GeneratedValue(strategy = GenerationType.AUTO)
-    private String id;
+    @GeneratedValue(strategy = GenerationType.UUID)
+    @VulpesGenerator
+    private UUID id;
 
     private String modelName;
     private String name;
     private String description;
     private String displayName;
     private String material;
-    private String group;
+    private String groupName;
     private int customModelData;
     private int amount;
     @ElementCollection
@@ -64,21 +62,21 @@ public ItemModel() {
      * @param description     a description of the item
      * @param displayName     the display name of the item
      * @param material        the material type associated with the item
-     * @param group           the group to which the item belongs
+     * @param groupName           the group to which the item belongs
      * @param customModelData the custom model data for the item
      * @param amount          the amount of the item
      * @param enchantments    the enchantments applied to the item
      * @param lore            the lore associated with the item
      * @param flags           the flags associated with the item
      */
-    public ItemModel(String id, String modelName, String name, String description, String displayName, String material, String group, int customModelData, int amount, Map<String, Short> enchantments, List<String> lore, List<String> flags) {
+    public ItemModel(UUID id, String modelName, String name, String description, String displayName, String material, String groupName, int customModelData, int amount, Map<String, Short> enchantments, List<String> lore, List<String> flags) {
         this.id = id;
         this.modelName = modelName;
         this.name = name;
         this.description = description;
         this.displayName = displayName;
         this.material = material;
-        this.group = group;
+        this.groupName = groupName;
         this.customModelData = customModelData;
         this.amount = amount;
         this.enchantments = enchantments;
@@ -93,7 +91,7 @@ public ItemModel(String id, String modelName, String name, String description, S
      *
      * @return the unique identifier of the item
      */
-    public String getId() {
+    public UUID getId() {
         return id;
     }
 
@@ -102,7 +100,7 @@ public String getId() {
      *
      * @param id the unique identifier to set
      */
-    public void setId(String id) {
+    public void setId(UUID id) {
         this.id = id;
     }
 
@@ -201,17 +199,17 @@ public void setMaterial(String material) {
      *
      * @return the group of the item
      */
-    public String getGroup() {
-        return group;
+    public String getGroupName() {
+        return groupName;
     }
 
     /**
      * Sets the group to which the item belongs.
      *
      * @param group the group to set
      */
-    public void setGroup(String group) {
-        this.group = group;
+    public void setGroupName(String group) {
+        this.groupName = group;
     }
 
     /**
@@ -318,7 +316,7 @@ public String toString() {
                 ", description='" + description + '\'' +
                 ", displayName='" + displayName + '\'' +
                 ", material='" + material + '\'' +
-                ", group='" + group + '\'' +
+                ", group='" + groupName + '\'' +
                 ", customModelData=" + customModelData +
                 ", amount=" + amount +
                 ", enchantments=" + enchantments +