refactor: move IdFormat annotation to core module

mariuszs · mariuszs · commit de2898d7250e · 2025-12-21T15:03:00.000+01:00
- Rename FriendlyIdModule to FriendlyIdJackson2Module in jackson2 module
- Move IdFormat and FriendlyIdFormat to friendly-id core module
- Update all imports in Jackson modules and samples
- Fix Lombok configuration in contracts sample
diff --git a/friendly-id-jackson-datatype/src/main/java/com/devskiller/friendly_id/jackson/FriendlyIdDeserializer.java b/friendly-id-jackson-datatype/src/main/java/com/devskiller/friendly_id/jackson/FriendlyIdDeserializer.java
@@ -10,6 +10,8 @@
 import tools.jackson.databind.deser.std.StdDeserializer;
 
 import com.devskiller.friendly_id.FriendlyId;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public class FriendlyIdDeserializer extends StdDeserializer<UUID> {
 
diff --git a/friendly-id-jackson-datatype/src/main/java/com/devskiller/friendly_id/jackson/FriendlyIdSerializer.java b/friendly-id-jackson-datatype/src/main/java/com/devskiller/friendly_id/jackson/FriendlyIdSerializer.java
@@ -9,6 +9,8 @@
 import tools.jackson.databind.ser.std.StdSerializer;
 
 import com.devskiller.friendly_id.FriendlyId;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public class FriendlyIdSerializer extends StdSerializer<UUID> {
 
diff --git a/friendly-id-jackson-datatype/src/test/java/com/devskiller/friendly_id/spring/Bar.java b/friendly-id-jackson-datatype/src/test/java/com/devskiller/friendly_id/spring/Bar.java
@@ -2,8 +2,8 @@
 
 import java.util.UUID;
 
-import com.devskiller.friendly_id.jackson.FriendlyIdFormat;
-import com.devskiller.friendly_id.jackson.IdFormat;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public record Bar(
 		@IdFormat(FriendlyIdFormat.RAW) UUID rawUuid,
diff --git a/friendly-id-jackson-datatype/src/test/java/com/devskiller/friendly_id/spring/Foo.java b/friendly-id-jackson-datatype/src/test/java/com/devskiller/friendly_id/spring/Foo.java
@@ -2,8 +2,8 @@
 
 import java.util.UUID;
 
-import com.devskiller.friendly_id.jackson.FriendlyIdFormat;
-import com.devskiller.friendly_id.jackson.IdFormat;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public record Foo(
 		@IdFormat(FriendlyIdFormat.RAW) UUID rawUuid,
diff --git a/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdAnnotationIntrospector.java b/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdAnnotationIntrospector.java
@@ -2,6 +2,8 @@
 
 import java.util.UUID;
 
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 import com.fasterxml.jackson.databind.deser.std.UUIDDeserializer;
 import com.fasterxml.jackson.databind.introspect.Annotated;
 import com.fasterxml.jackson.databind.introspect.AnnotatedMethod;
diff --git a/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdFormat.java b/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdFormat.java
diff --git a/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdJackson2Module.java b/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/FriendlyIdJackson2Module.java
@@ -2,20 +2,21 @@
 
 import java.util.UUID;
 
+import com.devskiller.friendly_id.type.FriendlyId;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 
-public class FriendlyIdModule extends SimpleModule {
+public class FriendlyIdJackson2Module extends SimpleModule {
 
-	private FriendlyIdAnnotationIntrospector introspector;
+	private final FriendlyIdAnnotationIntrospector introspector;
 
-	public FriendlyIdModule() {
+	public FriendlyIdJackson2Module() {
 		introspector = new FriendlyIdAnnotationIntrospector();
 		addDeserializer(UUID.class, new FriendlyIdDeserializer());
 		addSerializer(UUID.class, new FriendlyIdSerializer());
 
 		// Add serializer/deserializer for FriendlyId value object
-		addDeserializer(com.devskiller.friendly_id.type.FriendlyId.class, new FriendlyIdValueDeserializer());
-		addSerializer(com.devskiller.friendly_id.type.FriendlyId.class, new FriendlyIdValueSerializer());
+		addDeserializer(FriendlyId.class, new FriendlyIdValueDeserializer());
+		addSerializer(FriendlyId.class, new FriendlyIdValueSerializer());
 	}
 
 	@Override
diff --git a/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/IdFormat.java b/friendly-id-jackson2-datatype/src/main/java/com/devskiller/friendly_id/jackson2/IdFormat.java
diff --git a/friendly-id-jackson2-datatype/src/main/resources/META-INF/services/com.fasterxml.jackson.databind.Module b/friendly-id-jackson2-datatype/src/main/resources/META-INF/services/com.fasterxml.jackson.databind.Module
@@ -1 +1 @@
-com.devskiller.friendly_id.jackson2.FriendlyIdModule
+com.devskiller.friendly_id.jackson2.FriendlyIdJackson2Module
diff --git a/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/Bar.java b/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/Bar.java
@@ -2,8 +2,8 @@
 
 import java.util.UUID;
 
-import com.devskiller.friendly_id.jackson2.FriendlyIdFormat;
-import com.devskiller.friendly_id.jackson2.IdFormat;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public class Bar {
 
diff --git a/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/Foo.java b/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/Foo.java
@@ -2,8 +2,8 @@
 
 import java.util.UUID;
 
-import com.devskiller.friendly_id.jackson2.FriendlyIdFormat;
-import com.devskiller.friendly_id.jackson2.IdFormat;
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
 public class Foo {
 
diff --git a/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/ObjectMapperConfiguration.java b/friendly-id-jackson2-datatype/src/test/java/com/devskiller/friendly_id/spring/ObjectMapperConfiguration.java
@@ -3,13 +3,13 @@
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
-import com.devskiller.friendly_id.jackson2.FriendlyIdModule;
+import com.devskiller.friendly_id.jackson2.FriendlyIdJackson2Module;
 
 public class ObjectMapperConfiguration {
 
 	protected static ObjectMapper mapper(Module... modules) {
 		ObjectMapper mapper = new ObjectMapper();
-		mapper.registerModule(new FriendlyIdModule());
+		mapper.registerModule(new FriendlyIdJackson2Module());
 		mapper.registerModules(modules);
 		return mapper;
 	}
diff --git a/friendly-id-samples/friendly-id-contracts/pom.xml b/friendly-id-samples/friendly-id-contracts/pom.xml
@@ -51,7 +51,7 @@
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <scope>provided</scope>
+            <optional>true</optional>
         </dependency>
 
         <dependency>
@@ -83,12 +83,26 @@
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <excludes>
+                        <exclude>
+                            <groupId>org.projectlombok</groupId>
+                            <artifactId>lombok</artifactId>
+                        </exclude>
+                    </excludes>
+                </configuration>
             </plugin>
             <plugin>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.14.0</version>
                 <configuration>
                     <parameters>true</parameters>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.projectlombok</groupId>
+                            <artifactId>lombok</artifactId>
+                        </path>
+                    </annotationProcessorPaths>
                 </configuration>
             </plugin>
             <plugin>
diff --git a/friendly-id-samples/friendly-id-spring-boot-customized/src/main/java/com/devskiller/friendly_id/sample/customized/Bar.java b/friendly-id-samples/friendly-id-spring-boot-customized/src/main/java/com/devskiller/friendly_id/sample/customized/Bar.java
@@ -2,9 +2,9 @@
 
 import java.util.UUID;
 
-import com.devskiller.friendly_id.jackson.IdFormat;
+import com.devskiller.friendly_id.IdFormat;
 
-import static com.devskiller.friendly_id.jackson.FriendlyIdFormat.RAW;
+import static com.devskiller.friendly_id.FriendlyIdFormat.RAW;
 
 record Bar(UUID friendlyId, @IdFormat(RAW) UUID uuid) {
 }
diff --git a/friendly-id-samples/friendly-id-spring-boot3-simple/src/main/java/com/devskiller/friendly_id/sample/spring3/FriendlyIdConfig.java b/friendly-id-samples/friendly-id-spring-boot3-simple/src/main/java/com/devskiller/friendly_id/sample/spring3/FriendlyIdConfig.java
@@ -9,7 +9,7 @@
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 import com.devskiller.friendly_id.FriendlyId;
-import com.devskiller.friendly_id.jackson2.FriendlyIdModule;
+import com.devskiller.friendly_id.jackson2.FriendlyIdJackson2Module;
 
 @Configuration
 public class FriendlyIdConfig implements WebMvcConfigurer {
@@ -21,8 +21,8 @@ public void addFormatters(FormatterRegistry registry) {
 	}
 
 	@Bean
-	FriendlyIdModule friendlyIdModule() {
-		return new FriendlyIdModule();
+	FriendlyIdJackson2Module friendlyIdModule() {
+		return new FriendlyIdJackson2Module();
 	}
 
 	public static class StringToUuidConverter implements Converter<String, UUID> {
diff --git a/friendly-id/src/main/java/com/devskiller/friendly_id/FriendlyIdFormat.java b/friendly-id/src/main/java/com/devskiller/friendly_id/FriendlyIdFormat.java
@@ -1,4 +1,4 @@
-package com.devskiller.friendly_id.jackson;
+package com.devskiller.friendly_id;
 
 /**
  * Friendly ID format
diff --git a/friendly-id/src/main/java/com/devskiller/friendly_id/IdFormat.java b/friendly-id/src/main/java/com/devskiller/friendly_id/IdFormat.java
@@ -1,4 +1,4 @@
-package com.devskiller.friendly_id.jackson;
+package com.devskiller.friendly_id;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-com.devskiller.friendly_id.jackson2.FriendlyIdModule`
	`1`	`+com.devskiller.friendly_id.jackson2.FriendlyIdJackson2Module`