add full support for custom types

Author: SirCotare

pom.xml

@@ -25,32 +25,44 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
         </dependency>
-        
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-json</artifactId>
+        </dependency>
+
         <!-- Utilities -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
             <optional>true</optional>
         </dependency>
 
+        <!-- https://mvnrepository.com/artifact/org.reflections/reflections -->
+        <!-- used to scan the classpath -->
+        <dependency>
+            <groupId>org.reflections</groupId>
+            <artifactId>reflections</artifactId>
+            <version>0.10.2</version>
+        </dependency>
+
         <!-- Validation -->
         <!-- https://mvnrepository.com/artifact/commons-validator/commons-validator -->
         <dependency>
             <groupId>commons-validator</groupId>
             <artifactId>commons-validator</artifactId>
             <version>1.9.0</version>
-        </dependency>
-
-        <!-- Utilities -->
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <!-- Testing -->

src/main/java/it/aboutbits/springboot/toolbox/boot/persistence/AbstractCustomTypeContributor.java

@@ -0,0 +1,38 @@
+package it.aboutbits.springboot.toolbox.boot.persistence;
+
+import lombok.SneakyThrows;
+import org.hibernate.boot.model.TypeContributions;
+import org.hibernate.boot.model.TypeContributor;
+import org.hibernate.service.ServiceRegistry;
+import org.hibernate.type.descriptor.java.JavaType;
+import org.reflections.Reflections;
+import org.reflections.util.ConfigurationBuilder;
+
+import java.lang.reflect.InvocationTargetException;
+import java.util.Set;
+
+public abstract class AbstractCustomTypeContributor implements TypeContributor {
+    private final Reflections reflections;
+
+    protected AbstractCustomTypeContributor(String... packageNames) {
+        var packageToScan = new ConfigurationBuilder().forPackages(packageNames);
+        reflections = new Reflections(packageToScan);
+    }
+
+    @SneakyThrows({InstantiationException.class, IllegalAccessException.class, InvocationTargetException.class})
+    @Override
+    public void contribute(TypeContributions typeContributions, ServiceRegistry serviceRegistry) {
+        var types = findAllTypes();
+
+        for (var type : types) {
+            typeContributions.contributeJavaType(
+                    (JavaType<?>) type.getConstructors()[0].newInstance()
+            );
+        }
+    }
+
+    @SuppressWarnings("rawtypes")
+    private Set<Class<? extends AutoRegisteredJavaType>> findAllTypes() {
+        return reflections.getSubTypesOf(AutoRegisteredJavaType.class);
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/boot/persistence/AutoRegisteredJavaType.java

@@ -0,0 +1,6 @@
+package it.aboutbits.springboot.toolbox.boot.persistence;
+
+import org.hibernate.type.descriptor.java.JavaType;
+
+public interface AutoRegisteredJavaType<T> extends JavaType<T> {
+}

src/main/java/it/aboutbits/springboot/toolbox/boot/persistence/CustomTypeContributor.java

@@ -0,0 +1,7 @@
+package it.aboutbits.springboot.toolbox.boot.persistence;
+
+public final class CustomTypeContributor extends AbstractCustomTypeContributor {
+    public CustomTypeContributor() {
+        super("it.aboutbits.springboot.toolbox");
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/boot/type/CustomTypeConfiguration.java

@@ -0,0 +1,79 @@
+package it.aboutbits.springboot.toolbox.boot.type;
+
+import it.aboutbits.springboot.toolbox.type.CustomType;
+import it.aboutbits.springboot.toolbox.type.jackson.CustomTypeDeserializer;
+import it.aboutbits.springboot.toolbox.type.jackson.CustomTypeSerializer;
+import it.aboutbits.springboot.toolbox.type.mvc.CustomTypePropertyEditor;
+import jakarta.annotation.PostConstruct;
+import lombok.extern.slf4j.Slf4j;
+import org.reflections.Reflections;
+import org.reflections.util.ConfigurationBuilder;
+import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.bind.WebDataBinder;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.InitBinder;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+@Slf4j
+@Configuration
+public class CustomTypeConfiguration {
+    public static final String LIBRARY_BASE_PACKAGE_NAME = "it.aboutbits.springboot.toolbox";
+
+    private String[] packageNamesToScan;
+    private Reflections reflections;
+
+    public void setAdditionalTypePackages(String[] additionalTypePackages) {
+        var tmp = new ArrayList<String>();
+        tmp.add(LIBRARY_BASE_PACKAGE_NAME);
+        tmp.addAll(Arrays.asList(additionalTypePackages));
+
+        this.packageNamesToScan = tmp.toArray(new String[0]);
+
+        var packageToScan = new ConfigurationBuilder().forPackages(packageNamesToScan);
+        reflections = new Reflections(packageToScan);
+    }
+
+    @PostConstruct
+    public void init() {
+        log.info("CustomTypeConfiguration enabled. Scanning: {}", Arrays.toString(packageNamesToScan));
+    }
+
+    @ControllerAdvice
+    public class CustomTypePropertyBinder {
+        @InitBinder
+        public void initBinder(WebDataBinder binder) {
+            var types = findAllCustomTypeRecords();
+            for (var clazz : types) {
+                binder.registerCustomEditor(clazz, new CustomTypePropertyEditor<>(clazz));
+            }
+        }
+    }
+
+    @Bean
+    public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
+        var types = findAllCustomTypeRecords();
+
+        var deserializers = types.stream()
+                .map(CustomTypeDeserializer::new)
+                .toList()
+                .toArray(new CustomTypeDeserializer[types.size()]);
+
+
+        return builder -> builder
+                .serializers(new CustomTypeSerializer())
+                .deserializers(deserializers);
+    }
+
+    @SuppressWarnings("rawtypes")
+    private Set<Class<? extends CustomType>> findAllCustomTypeRecords() {
+        return reflections.getSubTypesOf(CustomType.class).stream()
+                .filter(Record.class::isAssignableFrom)
+                .collect(Collectors.toSet());
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/boot/type/CustomTypeConfigurationRegistrar.java

@@ -0,0 +1,28 @@
+package it.aboutbits.springboot.toolbox.boot.type;
+
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.core.annotation.AnnotationAttributes;
+import org.springframework.core.type.AnnotationMetadata;
+
+import java.util.Objects;
+
+public class CustomTypeConfigurationRegistrar implements ImportBeanDefinitionRegistrar {
+
+    @Override
+    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
+        var attributes = new AnnotationAttributes(
+                Objects.requireNonNull(
+                        metadata.getAnnotationAttributes(
+                                RegisterCustomTypes.class.getName()
+                        )
+                )
+        );
+        var value = attributes.getStringArray("additionalTypePackages");
+
+        var builder = BeanDefinitionBuilder.genericBeanDefinition(CustomTypeConfiguration.class);
+        builder.addPropertyValue("additionalTypePackages", value);
+        registry.registerBeanDefinition("CustomTypeConfiguration", builder.getBeanDefinition());
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/boot/type/RegisterCustomTypes.java

@@ -0,0 +1,15 @@
+package it.aboutbits.springboot.toolbox.boot.type;
+
+import org.springframework.context.annotation.Import;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Import({CustomTypeConfigurationRegistrar.class})
+public @interface RegisterCustomTypes {
+    String[] additionalTypePackages() default "";
+}

src/main/java/it/aboutbits/springboot/toolbox/persistence/WrappedValue.java

@@ -0,0 +1,5 @@
+package it.aboutbits.springboot.toolbox.persistence.identity;
+
+public interface Identified<ID extends Identity<?>> {
+    ID getId();
+}

src/main/java/it/aboutbits/springboot/toolbox/persistence/identity/Identified.java

@@ -1,6 +1,6 @@
 package it.aboutbits.springboot.toolbox.persistence.identity;
 
-import it.aboutbits.springboot.toolbox.persistence.WrappedValue;
+import it.aboutbits.springboot.toolbox.type.CustomType;
 
 import java.io.Serializable;
 
@@ -10,5 +10,5 @@
  *
  * @param <T> the type of the value being wrapped
  */
-public interface Identity<T> extends WrappedValue<T>, Serializable {
+public interface Identity<T> extends CustomType<T>, Serializable {
 }